maverick.events.GameEvent

class maverick.events.GameEvent(*, id: str = <factory>, ts: float = <factory>, type: GameEventType, hand_number: int, street: Street | None = None, stage: GameStage | None = None, player_id: str | None = None, action: PlayerAction | None = None, payload: dict[str, ~typing.Any]=<factory>)

Immutable game event payload.

Represents a snapshot of a game event that occurred, including the type of event, current game state, and relevant action details.

Payload by event type: - PLAYER_CARDS_REVEALED:

• holding: list[str] - The player’s hole cards as a list of card codes.

• best_hand: list[str] - The best hand the player can make as a list of card codes.

• best_hand_type: str - The type of the best hand (e.g., “FLUSH”) according to HandType.

• best_score: float - The score of the best hand the player can make.

Added in version 0.2.0.

Fields

typeGameEventType

The type of event that occurred.

hand_numberint

The current hand number.

streetOptional[Street]

The current betting street.

stageOptional[GameStage]

The current game stage.

Added in version 0.2.0.

uidstr

Unique identifier for the event. Replaces deprecated id.

player_uidOptional[str]

UID of the player involved in the event, if applicable. Replaces deprecated player_id.

actionOptional[PlayerAction]

The action taken by the player, if applicable.

payloaddict[str, Any]

Additional event-specific data.

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	!!! abstract "Usage Documentation"
model_dump(*[, mode, include, exclude, ...])	!!! abstract "Usage Documentation"
model_dump_json(*[, indent, ensure_ascii, ...])	!!! abstract "Usage Documentation"
model_json_schema(by_alias, ref_template, ...)	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(context, /)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, extra, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	!!! abstract "Usage Documentation"
model_validate_strings(obj, *[, strict, ...])	Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
update_forward_refs(**localns)
validate(value)

Attributes

id	use uid instead.
model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
player_id	use player_uid instead.
uid
ts
type
hand_number
street
stage
player_uid
action
payload

model_config = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'frozen': True, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property id: str

use uid instead.

Type:

Deprecated

property player_id: str | None

use player_uid instead.

Type:

Deprecated