Struct Guidance 

pub struct Guidance {
    pub markers: Visibility,
    pub announcements: Visibility,
}

The campaign’s guidance defaults (spec-0093): what an objective gets when it states no marker or announcement of its own.

Two values, both defaulting to shown, so a document that omits the block is the document every campaign already was. The objective’s own field wins over the campaign’s; there is no third level, because a quest is where a beat is booked and not the object a lantern hangs over.

Fields

markers: Visibility

The default for every interact (without a prop) and reach-anchor objective’s glowing marker.

announcements: Visibility

The default for every objective’s announcement — the New objective line, the hint’s line, the cue sound and the Objective complete line.

Implementations

impl Guidance

pub fn is_default(&self) -> bool

Serde skip predicate: both shown needs no block on the wire.

Trait Implementations

impl Clone for Guidance

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 Guidance

impl Debug for Guidance

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

Formats the value using the given formatter.

impl Default for Guidance

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Guidance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Guidance

impl JsonSchema for Guidance

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 Guidance

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Guidance

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 Guidance