Struct CommandQueue 

pub struct CommandQueue {
    pub commands: Mutex<Vec<ScriptCommand>>,
    /* private fields */
}

Thread-safe queue of pending ScriptCommands, accessible from Lua callbacks.

Lua callbacks cannot mutate the World directly, so they push commands here; the engine later drains and applies them at a controlled point in the frame.

Fields

commands: Mutex<Vec<ScriptCommand>>

Pending commands, guarded by a mutex so Lua callbacks can push concurrently.

Implementations

impl CommandQueue

pub fn new() -> Self

Creates an empty command queue.

pub fn push(&self, cmd: ScriptCommand)

Appends a command to the queue, unless it carries a non-finite number.

Dropped rather than clamped: a clamped force is a wrong answer the frame accepts silently, while a dropped one is a no-op with a log line and a counter behind it. A script that produced NaN has a bug, and the useful thing to do is say so, not to guess what it meant.

pub fn rejected_count(&self) -> u64

How many commands have been refused for carrying NaN or infinity, since this queue was created.

pub fn drain(&self) -> Vec<ScriptCommand>

Removes and returns all currently queued commands, leaving the queue empty.

pub fn is_empty(&self) -> bool

Returns true if no commands are currently queued.

pub fn len(&self) -> usize

Returns the number of currently queued commands.

Trait Implementations

impl Debug for CommandQueue

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

Formats the value using the given formatter.

impl Default for CommandQueue

fn default() -> CommandQueue

Returns the “default value” for a type.