Struct ModuleAssist

pub struct ModuleAssist {
    pub text: Option<String>,
    pub audio: Option<Audio>,
    pub always_show: bool,
}

Module-specific assistance during play.

Fields

text: Option<String>

Text displayed in banner

audio: Option<Audio>

Audio played on module start

always_show: bool

Whether to always show module assistance

This will override the default module assist behavior.

Note: This value will never be persisted in the backend.

Implementations

impl ModuleAssist

pub fn new(text: Option<String>, audio: Option<Audio>) -> Self

Create a new ModuleAssist instance which doesn’t override module assist behavior

pub fn always_show(self) -> Self

Override default module assist behavior

pub fn has_content(&self) -> bool

Whether the instructions actually have either text or audio content set

Trait Implementations

impl Clone for ModuleAssist

fn clone(&self) -> ModuleAssist

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleAssist

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

Formats the value using the given formatter.

impl Default for ModuleAssist

fn default() -> ModuleAssist

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleAssist

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ModuleAssist

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.