Struct OwnedGameEvent 

pub struct OwnedGameEvent<'s> { /* private fields */ }

A game event this plugin created, which is freed when dropped unless fired.

Implementations

impl<'s> OwnedGameEvent<'s>

pub fn as_event(&self) -> GameEvent<'_>

Reads the event. The handle cannot outlive this owner.

pub fn as_event_mut(&mut self) -> GameEventMut<'_>

Edits the event through a handle, which cannot outlive this owner.

pub fn fire(self, broadcast: bool) -> Result<(), FireEventError>

Delivers the event to every listener, and to clients if broadcast is set.

Listeners run synchronously, so this may run arbitrary game and plugin code, including this plugin’s own listeners. Fails if the manager reports that it did not fire the event, which the engine frees either way.

pub fn set_bool(&mut self, key: &CStr, value: bool)

Sets a boolean value for key.

pub fn set_float(&mut self, key: &CStr, value: f32)

Sets a float value for key.

pub fn set_int(&mut self, key: &CStr, value: c_int)

Sets an integer value for key.

pub fn set_string(&mut self, key: &CStr, value: &CStr)

Sets a string value for key. The event stores a copy of value.

pub fn set_uint64(&mut self, key: &CStr, value: u64)

Sets a 64-bit value for key.

Trait Implementations

impl<'s> Debug for OwnedGameEvent<'s>

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

Formats the value using the given formatter.

impl Drop for OwnedGameEvent<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.