Enum LuaEnvironment 

pub enum LuaEnvironment {
    Campaign,
    Battle,
    Frontend,
}

Game environment in which a script runs.

Variants

Campaign

Battle

Frontend

Implementations

impl LuaEnvironment

pub fn docs_folder(&self) -> &'static str

Folder of the scripting docs holding the pages of this environment.

Trait Implementations

impl Clone for LuaEnvironment

fn clone(&self) -> LuaEnvironment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaEnvironment

impl Debug for LuaEnvironment

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

Formats the value using the given formatter.

impl Eq for LuaEnvironment

impl Hash for LuaEnvironment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LuaEnvironment

fn cmp(&self, other: &LuaEnvironment) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LuaEnvironment

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LuaEnvironment

fn partial_cmp(&self, other: &LuaEnvironment) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for LuaEnvironment