Struct yharnam::Line

pub struct Line {
    pub id: String,
    pub substitutions: Vec<String>,
}

A line of dialogue, sent from the VirtualMachine to the game.

When the game receives a Line, it should do the following things to prepare the line for presentation to the user.

1. Use the value in the id field to look up the appropriate user-facing text in the string table.

2. For each of the entries in the substitutions field, replace the corresponding placeholder with the entry. That is, the text “{0}” should be replaced with the value of substitutions[0], “{1}” with substitutions[1], and so on.

3. Use expand_format_functions to expand all format functions in the line.

You do not create instances of this struct yourself. They are created by the VirtualMachine during program execution.

Fields

id: String

substitutions: Vec<String>

Trait Implementations

impl Clone for Line

fn clone(&self) -> Line

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Line

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

Formats the value using the given formatter.