Struct Loop 

pub struct Loop {
    pub id: LoopId,
    pub region: StealthZone,
    pub to: Mark,
    pub requires_flags: Vec<FlagId>,
    pub forbids_flags: Vec<FlagId>,
    pub requires_state: Vec<StateCompare>,
    pub counts: Option<StateId>,
    pub on_cross: Vec<QuestEffect>,
}

A stage-5 loop (spec-0086): a slab a body crosses and is returned from, by a whole-block offset, to an earlier section that looks exactly the same — its position inside the cell, its facing and its velocity all kept.

It is a region with a standing property

A loop acts on whatever body enters a volume, every tick, the way a LethalVolume does; nothing completes and nobody is addressed. So it is declared beside the lethal volume, with the same region type (StealthZone, resolved through the one Plan::zone_box), and not as a trigger with a relative teleport in it: the seamlessness proof is a property of the region-plus-offset pair, which a compiler would otherwise have to recognise by pattern-matching a trigger’s effect list.

The offset is derived, never typed

to is a Mark naming where the slab’s own anchor cell lands, so the offset is cell(to) − cell(region.anchor) — a whole-block vector by construction, and a judgement about the world (the fourth bay’s anchor lands on the second’s) rather than a vector the compiler could compute.

The gate is the release

The loop holds while its gate is open and stands down while it is shut, read against the party: flags are campaign state, and a requires_state term must name a party datum (DW0949). A loop with no gate term holds forever and is refused at the document (DW0949).

Fields

id: LoopId

Unique loop id (loop/<kebab>).

region: StealthZone

The slab a body crosses: an anchor-centred box (anchor ± extent), one axis of which is the crossing axis. The existing zone type, for the reason LethalVolume::region gives.

to: Mark

Where the slab’s own anchor cell lands: the loop’s offset is cell(to) − cell(region.anchor). Lies inside its anchor’s piece (DW0897).

requires_flags: Vec<FlagId>

Flags that must all be set for the loop to hold.

forbids_flags: Vec<FlagId>

Flags any one of which stands the loop down — forbids_flags: [flag/the-bell-found] is a loop that ends the moment the bell is found.

requires_state: Vec<StateCompare>

Numeric gate terms: every comparison must hold for the loop to hold. Each names a party-scoped datum (DW0949). The third field of the one gate, carried by every gate consumer.

counts: Option<StateId>

A party-scoped datum the loop raises by one on every move, before on_cross runs — the counter a crossing-counted release reads.

on_cross: Vec<QuestEffect>

The dungeon’s answer to a move: effects run on every move, after the body is moved and the count raised, from the server command source (no acting player). Each effect’s own when keys a write to a count. A teleport here is refused (DW0949).

Implementations

impl Loop

pub fn gate(&self) -> Gate<'_>

This loop’s whole gate, as one value (spec-0086): the loop holds while it is open and stands down while it is shut.

Trait Implementations

impl Clone for Loop

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Loop

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Loop

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Loop

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Loop

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Loop

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 Loop