Struct LuaRemote 

pub struct LuaRemote;

Registry of interfaces between scripts. An interface is simply a dictionary mapping names to functions. A script or mod can then register an interface with LuaRemote, after that any script can call the registered functions, provided it knows the interface name and the desired function name. An instance of LuaRemote is available through the global object named remote.

Implementations

impl LuaRemote

pub fn interfaces(&self) -> HashMap<String, HashMap<String, bool>>

List of all registered interfaces. For each interface name, remote.interfaces[name] is a dictionary mapping the interface’s registered functions to true.

pub fn object_name(&self) -> &str

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

pub fn add_interface(&self, functions: HashMap<String, LuaAny>, name: &str)

Add a remote interface.

pub fn call(&self, function: &str, interface: &str) -> Option<LuaAny>

Call a function of an interface.

Providing an unknown interface or function name will result in a script error.

pub fn remove_interface(&self, name: &str) -> bool

Removes an interface with the given name.

Trait Implementations

impl Clone for LuaRemote

fn clone(&self) -> LuaRemote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaRemote

impl Debug for LuaRemote

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

Formats the value using the given formatter.

impl Default for LuaRemote

fn default() -> LuaRemote

Returns the “default value” for a type.

impl Eq for LuaRemote

impl From<LuaRemote> for LuaAny

fn from(_: LuaRemote) -> Self

Converts to this type from the input type.

impl LuaObject for LuaRemote

impl PartialEq for LuaRemote

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaRemote