Enum GateConsumer 

pub enum GateConsumer {
    Objective,
    Effect,
    Trigger,
    Trap,
    DialogueOption,
    CastPlacement,
    ShopOffer,
}

The object classes that carry a gate. A closed set.

ALL is the enumeration; GateConsumer::label and every consumer that matches on one is exhaustive, so an eighth class is a compile error at every site where the answer would have to change.

Variants

Objective

A stage-5 quests[].objectives[] — the gate decides whether the objective activates.

Effect

Any QuestEffect, at any of the five effect roots, top-level or nested — the gate decides whether the effect’s commands run.

Trigger

A stage-5 triggers[] — the gate decides whether the trigger can fire.

Trap

A stage-5 traps[] — the gate decides whether the trap is armed.

DialogueOption

A stage-6 dialogues[].nodes[].options[] — the gate decides whether the option is shown, and whether a direct /trigger on it does anything.

CastPlacement

A stage-5 quests[].cast[] placement — the gate decides which branch’s scene describes the world.

ShopOffer

A stage-5 shops[].offers[] (DSL v0.10, spec-0032) — the gate decides whether the button is shown, and whether a direct /trigger on it does anything. This is where a price lives: a shop declares no comparison surface of its own, because “may this happen yet?” already has an owner.

Implementations

impl GateConsumer

pub const ALL: [GateConsumer; 7]

Every consumer class, in enumeration order (= visit order in for_each_gate).

pub const COUNT: usize

How many consumer classes there are.

pub fn label(self) -> &'static str

A short, stable label for a binding ledger or a diagnostic.

pub fn evaluates_per_player(self) -> Option<bool>

Whether emission evaluates this consumer’s gate against an acting player (@s) rather than against the party holder (#party) — or None when the class alone cannot say.

This is a statement about the emitter, not a preference: a dialogue option’s availability is computed per player into dw.dmask and its /trigger handler runs as @s; a cast placement selects a scene into a per-player dw.cast. Three of the others are party predicates by construction — an objective’s activation guard is read on the tick (“whoever finishes the last objective completes the quest for everyone”), and a trigger’s and a trap’s arming gates flip one global sentinel.

Effect answers None, and that is the whole point of the return type. An effect’s gate is evaluated wherever its bundle is run, and which that is belongs to the root, not to the effect: four roots have an acting player and three do not (EffectRootKind::runs_with_acting_player), and on top of that the sequence / on_arrive seams inside a bundle drop the actor mid-walk. An earlier version of this method answered true for Effect, which is right for on_objective_complete and wrong for a trigger’s effects, a trap’s payload and a shortcut’s on_unlock — three of the seven roots, silently. Option makes that wrong answer unrepresentable: a caller must handle the deferral.

It is what makes a player-scoped datum’s readability decidable (DW0503) from the closed consumer set rather than from a list somebody maintains — an eighth consumer class must answer this to compile.

pub fn stage(self) -> &'static str

The stage document this consumer lives in.

Trait Implementations

impl Clone for GateConsumer

fn clone(&self) -> GateConsumer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GateConsumer

impl Debug for GateConsumer

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

Formats the value using the given formatter.

impl Eq for GateConsumer

impl Hash for GateConsumer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GateConsumer

fn cmp(&self, other: &GateConsumer) -> 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 GateConsumer

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GateConsumer

fn partial_cmp(&self, other: &GateConsumer) -> 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 StructuralPartialEq for GateConsumer