Struct LuaNotificationQueue 

pub struct LuaNotificationQueue;

Object that keeps track of objects invalidation and queues notifications for when object becomes invalid.

This object is an alternative mechanism to LuaBootstrap::register_on_object_destroyed where instead of raising lua events, this object only queues notifications and makes them available to use later by calls to LuaNotificationQueue::poll or LuaNotificationQueue::poll_all.

New instances of this object can be obtained from LuaBootstrap::new_notification_queue.

Each instance of this object is unique, always valid and cannot be copied. This object lives entirely in script state and if its no longer referenced by script, it will be destroyed by garbage collector.

Implementations

impl LuaNotificationQueue

pub fn object_name(&self) -> &str

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

pub fn valid(&self) -> bool

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

pub fn add(&self, object: LuaAny) -> u64

Registers an object so that after it’s destroyed, a notification is queued.

If this object is already registered within this notification queue, an existing registration number will be provided without creating new registration.

pub fn clear(&self)

Removes all registrations.

pub fn find(&self, object: LuaAny) -> Option<u64>

Checks if provided object is already registered and returns existing registration number for it. If object is not registered, it is not registered and nil is returned instead.

pub fn poll(&self) -> Option<u64>

Gets at most 1 registration id for which an object was destroyed.

pub fn poll_all(&self) -> Vec<u64>

Gets all registration ids for which object were destroyed.

pub fn remove(&self, registration_id: u64)

Removes a registration based on registration number.

Trait Implementations

impl Clone for LuaNotificationQueue

fn clone(&self) -> LuaNotificationQueue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaNotificationQueue

impl Debug for LuaNotificationQueue

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

Formats the value using the given formatter.

impl Default for LuaNotificationQueue

fn default() -> LuaNotificationQueue

Returns the “default value” for a type.

impl Eq for LuaNotificationQueue

impl From<LuaNotificationQueue> for LuaAny

fn from(_: LuaNotificationQueue) -> Self

Converts to this type from the input type.

impl LuaObject for LuaNotificationQueue

impl PartialEq for LuaNotificationQueue

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaNotificationQueue