Struct GameEvent 

pub struct GameEvent<'a> { /* private fields */ }

Represents a game event with its name and values.

Game events are structured in-game occurrences. Each event has a name and a set of named values.

Examples

Accessing event data

use source2_demo::prelude::*;

// Get the event name
println!("Event: {}", ge.name());

// Iterate all key-value pairs
for (key, value) in ge.iter() {
    println!("{}: {:?}", key, value);
}

// Get a specific value
let player_id: i32 = ge.get_value("player_id")?.try_into()?;

Implementations

impl<'a> GameEvent<'a>

pub fn id(&self) -> i32

Returns the event’s numeric ID.

pub fn name(&self) -> &str

Returns the event’s name.

Event names are strings

pub fn iter(&self) -> impl Iterator<Item = (&str, &EventValue)>

Returns an iterator over all key-value pairs in the event.

Examples

use source2_demo::prelude::*;

for (key, value) in ge.iter() {
    println!("{}: {:?}", key, value);
}

pub fn get_value(&self, key: &str) -> Result<&EventValue, GameEventError>

Gets the value for a specific key.

Arguments

• key - The name of the key to look up

Errors

Returns GameEventError::UnknownKey if the key doesn’t exist for this event.

Examples

use source2_demo::prelude::*;

// Get a value and convert it
let player_id: i32 = ge.get_value("player_id")?.try_into()?;
let hero_name: String = ge.get_value("hero_name")?.try_into()?;

Trait Implementations

impl Display for GameEvent<'_>

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

Formats the value using the given formatter.