Trait streamduck_core::modules::SDModule

pub trait SDModule: Send + Sync {
    fn name(&self) -> String;
    fn components(&self) -> HashMap<String, ComponentDefinition>;
    fn add_component(&self, core: CoreHandle, button: &mut Button, name: &str);
    fn remove_component(
        &self, 
        core: CoreHandle, 
        button: &mut Button, 
        name: &str
    );
    fn component_values(
        &self, 
        core: CoreHandle, 
        button: &Button, 
        name: &str
    ) -> Vec<UIValue>;
    fn set_component_value(
        &self, 
        core: CoreHandle, 
        button: &mut Button, 
        name: &str, 
        value: Vec<UIValue>
    );
    fn listening_for(&self) -> Vec<String>;
    fn event(&self, core: CoreHandle, event: SDEvent);

    fn settings(&self) -> Vec<UIValue> { ... }
    fn set_setting(&self, value: Vec<UIValue>) { ... }
    fn metadata(&self) -> PluginMetadata { ... }
}

Module trait

Required methods

fn name(&self) -> String

Module name

fn components(&self) -> HashMap<String, ComponentDefinition>

Definition for components that module will be providing

fn add_component(&self, core: CoreHandle, button: &mut Button, name: &str)

Method for adding components onto buttons

fn remove_component(&self, core: CoreHandle, button: &mut Button, name: &str)

Method for removing components from buttons

fn component_values(
    &self,
    core: CoreHandle,
    button: &Button,
    name: &str
) -> Vec<UIValue>

Method for letting core know what values component currently has

fn set_component_value(
    &self,
    core: CoreHandle,
    button: &mut Button,
    name: &str,
    value: Vec<UIValue>
)

Method for setting values on components

fn listening_for(&self) -> Vec<String>

Specifies which components the module will be receiving events for

fn event(&self, core: CoreHandle, event: SDEvent)

Method for handling core events, add EVENTS feature to the plugin metadata to receive events

Provided methods

fn settings(&self) -> Vec<UIValue>

Current settings state of the plugin

fn set_setting(&self, value: Vec<UIValue>)

Method for updating plugin settings from UI

fn metadata(&self) -> PluginMetadata

Metadata of the module, auto-implemented for plugins from plugin metadata

Implementors