Enum TextKind 

pub enum TextKind {
    Name,
    Title,
    Description,
    Objective,
    Refusal,
    Dialogue,
    Bark,
    OptionLabel,
    ButtonTooltip,
    ItemName,
    ItemTooltip,
    Prompt,
    Narration,
}

What kind of player-facing text an inventory key holds — the class a writer (or a transcreating model) needs before the English, because each class has its own job (docs/reference/game-writing.md §1–§2).

Derived from the key alone, beside key_speaker and the traversal that defines the key scheme (each_string); a CLI test asserts every key of a real campaign’s inventory resolves to a kind, so a key the scheme grows that this function does not know is a red test rather than an unlabelled row.

Variants

Name

A proper name on a body, place, class, counter or the world itself.

Title

A heading: a health bar’s or shop dialog’s title, the world title.

Description

A class blurb: what the role is.

Objective

An objective title or hint, or a quest goal: tells the player what to do.

Refusal

A message shown when an action fails: says what is wrong and what fixes it.

Dialogue

An NPC’s line in a dialogue tree.

Bark

An NPC’s murmured line in passing (a cast bark).

OptionLabel

The caption on a fixed-width button: the player’s own words.

ButtonTooltip

The hover text of a dialog button (a dialogue option, or a bonfire’s rest or save): the consequence of choosing it.

ItemName

An item’s display name.

ItemTooltip

The hover text of a shop offer: what the item does.

Prompt

A dialog’s prompt (a bonfire’s rest question).

Narration

Narration in chat, on screen or on the action bar.

Trait Implementations

impl Clone for TextKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TextKind

impl Debug for TextKind

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

Formats the value using the given formatter.

impl Eq for TextKind

impl Ord for TextKind

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for TextKind

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for TextKind

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TextKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextKind