Struct CommonEvent 

pub struct CommonEvent { /* private fields */ }

A common event, representing a common series of command that can be invoked from any event

Implementations

impl CommonEvent

pub fn id(&self) -> u32

The ID of this common event in the database

pub fn run_condition(&self) -> &RunCondition

The condition under which this event will run

pub fn event_name(&self) -> &str

The name of this event, which can be used for invoking it

pub fn commands(&self) -> &Vec<Command>

The event script, in the form of a Command collection.

pub fn note(&self) -> &str

A developer note for this event

pub fn arguments(&self) -> &Vec<Argument>

A list of arguments that can be passed when invoking this event

pub fn color(&self) -> u32

The color of this event, for display purposes

pub fn var_names(&self) -> &Vec<String>

A list of names for each of the 100 local variables available in this event.

pub fn return_name(&self) -> &str

The name of the variable in which the return value will be put

pub fn return_variable(&self) -> u32

The address of the variable in which the return value will be put

Trait Implementations

impl Clone for CommonEvent

fn clone(&self) -> CommonEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for CommonEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CommonEvent