Enum GameEvent 

pub enum GameEvent {
    Asked {
        asker: usize,
        target: usize,
        rank: String,
    },
    Gave {
        from: usize,
        to: usize,
        rank: String,
        count: usize,
    },
    GoFish {
        player: usize,
    },
    Drew {
        player: usize,
        matched: bool,
    },
    Book {
        player: usize,
        rank: String,
    },
    GameOver {
        winner: Option<usize>,
    },
}

An event emitted by the game engine as a result of a player action.

Game::act returns the most recently emitted event for that action. Observers can use a sequence of events to reconstruct the full game history; the history feature enables structured turn-by-turn recording.

Examples

use gfcore::prelude::{Game, GameEvent, GameVariant, Player, PlayerAction};
use cardpack::prelude::{DeckedBase, Standard52};

// Build a minimal game; the exact events depend on the shuffled deck.
let players = vec![Player::new("Alice"), Player::new("Bob")];
let mut game = Game::new(GameVariant::Standard, players).unwrap();
// The game starts in WaitingForAsk — we can inspect state safely.
let state = game.state().unwrap();
assert!(state.last_event.is_none());

Variants

Asked

The current player asked another player for cards of a rank.

Note: Game::act returns the final event for each action (either GameEvent::GoFish or GameEvent::Gave), so this variant does not appear in the return value of act(). It is present for constructing crate::history::TurnRecords manually or via future event-log APIs.

Fields

asker: usize

Index of the asking player.

target: usize

Index of the player being asked.

rank: String

String representation of the rank’s index character.

Gave

The target player gave cards to the asker.

Fields

from: usize

Index of the player giving the cards.

to: usize

Index of the player receiving the cards.

rank: String

String representation of the rank’s index character.

count: usize

Number of cards transferred.

GoFish

The current player was told to “Go Fish” (target had no matching cards).

Fields

player: usize

Index of the player who must draw.

Drew

The current player drew a card from the draw pile.

Fields

player: usize

Index of the player who drew.

matched: bool

true if the drawn card matches the rank the player asked for.

Book

A player completed a book.

Fields

player: usize

Index of the player who completed the book.

rank: String

String representation of the rank’s index character.

GameOver

The game has ended.

Fields

winner: Option<usize>

Index of the winning player, or None if tied.

Trait Implementations

impl Clone for GameEvent

fn clone(&self) -> GameEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GameEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GameEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GameEvent

fn eq(&self, other: &GameEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GameEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GameEvent