Struct Script

pub struct Script { /* private fields */ }

A script abstraction

Implementations

impl Script

pub fn metadata(&self) -> &ScriptInfo

Returns the script metadata

pub fn activate(&mut self)

Activate a script, inactive scripts will not react to hooks

pub fn deactivate(&mut self)

Deactivate a script, inactive scripts will not react to hooks

pub fn is_active(&self) -> bool

Query the script state

pub fn is_listening_for<H: Hook>(&self) -> bool

Check if a script is listening for a hook

pub fn trigger<H: Hook>( &mut self, hook: &H, ) -> Result<<H as Hook>::Output, Error>

Trigger a hook on the script, this disregards the script state as in the hook will be triggered even if the script is inactive
If the script is not listening for the specified hook, an error will be returned

Trait Implementations

impl Debug for Script

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

Formats the value using the given formatter.