Enum rat_in_a_tube::ScriptType

#[repr(C)]
pub enum ScriptType {
    Startup = 0,
    Dormant = 1,
    Continuous = 2,
    Static = 3,
    Stub = 4,
}

Script type which determines how a script is run and parsed.

Variants

Startup = 0

Script called on startup.

This script always returns void.

Dormant = 1

Continuous script that can be awoken later.

This script always returns void.

Continuous = 2

Script called every tick.

This script always returns void.

Static = 3

Script which can be called manually.

Stub = 4

Static script that can be replaced by a non-stub script later.

Implementations

impl ScriptType

pub fn always_returns_void(&self) -> bool

Get whether or not the script type always returns void and does not have a type

pub fn expression_offset(&self) -> usize

Get the offset to the expression tokens

pub fn from_str(input: &str) -> Option<ScriptType>

Get the script type from a string (as used in HSC)

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

Convert the script type to string (as used in HSC)

Trait Implementations

impl Clone for ScriptType

fn clone(&self) -> ScriptType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for ScriptType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ScriptType

impl StructuralPartialEq for ScriptType