[−][src]Struct sulis_state::script::ModuleExport
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]
fn clone(&self) -> ModuleExport
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl UserData for ModuleExport
[src]
fn add_methods<'lua, M: UserDataMethods<'lua, Self>>(methods: &mut M)
[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]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<'lua, T> FromLua<'lua> for T where
T: 'static + UserData + Clone,
[src]
T: 'static + UserData + Clone,
impl<'lua, T> FromLuaMulti<'lua> for T where
T: FromLua<'lua>,
[src]
T: FromLua<'lua>,
pub fn from_lua_multi(
values: MultiValue<'lua>,
lua: Context<'lua>
) -> Result<T, Error>
[src]
values: MultiValue<'lua>,
lua: Context<'lua>
) -> Result<T, Error>
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<'lua, T> ToLua<'lua> for T where
T: 'static + UserData + Send,
[src]
T: 'static + UserData + Send,
impl<'lua, T> ToLuaMulti<'lua> for T where
T: ToLua<'lua>,
[src]
T: ToLua<'lua>,
pub fn to_lua_multi(self, lua: Context<'lua>) -> Result<MultiValue<'lua>, Error>
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
[src]
V: MultiLane<T>,