Skip to main content

register_scripting_enum

Macro register_scripting_enum 

Source
macro_rules! register_scripting_enum {
    ($registry:ident, $tp:ty) => { ... };
    ($registry:ident, $($key:literal, $value:literal),+ $(,)?) => { ... };
}
Expand description

Macro to register enums for scripting. Enum must derive ScriptEnum. It is also possible to register discrete value(s).

§Usage:

With an enum type:

register_scripting_enum!(<mutable reference to behavior registry>, <enum to register>)

With discrete value(s)

register_scripting_enum!(<mutable reference to behavior registry>, <Identifier as str>, <Value as int>)

§Examples:

#[derive(ScriptEnum)]
enum Color {
    RED,
    BLUE,
    GREEN,
}

register_scripting_enum!(registry, Color);
register_scripting_enum!(registry "THE_ANSWER", 42, "OTHER_ANSWER", 44);