Struct rscript::ScriptManager

pub struct ScriptManager { /* fields omitted */ }

ScriptManager holds all the scripts found, it can be constructed with ScriptManager::default
Initially its empty, to populate it, we can use one of the methods to add scripts, currently only ScriptManager::add_scripts_by_path is provided

Implementations

impl ScriptManager

pub fn add_scripts_by_path<P: AsRef<Path>>(
    &mut self,
    path: P
) -> Result<(), Error>

Look for scripts in the specified folder The script manager will send a Message::Greeting for every script found and the scripts must respond with ScriptInfo

pub fn trigger<'a, H: 'static + Hook>(
    &'a mut self,
    hook: H
) -> impl Iterator<Item = Result<<H as Hook>::Output, Error>> + 'a

Trigger a hook All scripts that are active and that are listening for this particular hook will receive it

pub fn scripts(&self) -> &[Script]

List of current scripts

pub fn scripts_mut(&mut self) -> &mut [Script]

Mutable list of current scripts, useful for activating/deactivating a script

Trait Implementations

impl Default for ScriptManager

fn default() -> ScriptManager

Returns the “default value” for a type.

impl Drop for ScriptManager

fn drop(&mut self)

Executes the destructor for this type.