[][src]Struct sulis_state::script::ModuleExport

pub struct ModuleExport { /* fields omitted */ }

A data structure representing all data that will be transfered from this module to the specified subsequent module. This is created with game:create_module_export(module_id). It is assumed the player character will always be exported.

activate()

Actives this export function, triggering the loading of the new campaign.

set_include_stash(bool)

Sets whether the party stash will be exported along with the player. Defaults to true.

set_flag(flag: String, value: String (Optional))

Sets a flag which will be stored on the player entity in the newly loaded campaign. If the value is not specified, sets that the flag exists but does not neccesarily set a specific value. This allows arbitrary data to be passed between campaigns.

add_to_party(entity: ScriptEntity)

Adds the specified ScriptEntity to the player's party in the next campaign.

Implementations

impl ModuleExport[src]

pub fn new(module: String) -> ModuleExport[src]

Trait Implementations

impl Clone for ModuleExport[src]

impl UserData for ModuleExport[src]

Auto Trait Implementations

impl RefUnwindSafe for ModuleExport

impl Send for ModuleExport

impl Sync for ModuleExport

impl Unpin for ModuleExport

impl UnwindSafe for ModuleExport

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<'lua, T> FromLua<'lua> for T where
    T: 'static + UserData + Clone
[src]

impl<'lua, T> FromLuaMulti<'lua> for T where
    T: FromLua<'lua>, 
[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<'lua, T> ToLua<'lua> for T where
    T: 'static + UserData + Send
[src]

impl<'lua, T> ToLuaMulti<'lua> for T where
    T: ToLua<'lua>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]