Struct CourierQuestInstance 

pub struct CourierQuestInstance {
    pub kind: CourierQuest,
    pub spot: Option<Vec2<i32>>,
    pub source_site: Option<SiteId>,
    pub source_actor: Actor,
    pub target_actor: Actor,
    pub target_site: Option<SiteId>,
    pub messenger: Actor,
    pub distance: NonZeroU32,
}

Contains a completable courier quest.

Fields

kind: CourierQuest

spot: Option<Vec2<i32>>

source_site: Option<SiteId>

The source site may or may not be useful in all situations, but we do want to keep it available in case we need to have dialogue that says something like “Wow, you came all the way from to send me this?”

source_actor: Actor

target_actor: Actor

This is source_actor for fetch quests.

target_site: Option<SiteId>

Target actor’s site, if available.

messenger: Actor

Usually this is the player.

distance: NonZeroU32

The distance to be traversed, calculated once at quest start.

Implementations

impl CourierQuestInstance

This file only contains an implementation for quest interactions. Make sure to look for other implementations.

pub fn get_required_items(self) -> Result<Vec<(Arc<ItemDef>, f32)>, Error>

Returns a list of all items that are required for completing this courier quest.

pub fn get_reward(self) -> f32

Returns the number of coins that the quest arbiter must pay upon courier quest completion. Note that in some cases the arbiter is not the person that paid the quest deposit.

pub fn get_spot_map_label(self, npc_name: &str) -> Content

Retrieves the i18n content that will be shown on the map when hovering over the courier quest’s map marker.

pub fn lacks_items(self) -> Content

“You don’t have enough items on you to complete this quest.”

pub fn what_items_needed( self, is_target_npc: bool, npc_name: &str, ) -> (Content, Content)

Assembles the dialogue question and response when asking what items are needed in order to complete an active courier quest.

“What am I supposed to be getting for you/target again?” “You need X, Y, and Z to complete this courier quest.”

pub fn get_spot_name(self) -> Content

Retrieves the i18n content for the name of the spot, or a generic response if the courier quest variant does not need a spot.

pub fn get_start_dialogue( self, tgt_npc_name_str: &str, tgt_site_name: &str, ) -> (Content, Content)

Returns the i18n content for the initial courier quest statement/preamble that an NPC will say, as well as the subsequent yes/no question that they ask that allows starting the quest.

Note that not every quest uses the target npc name or the target site name.

pub fn get_dialogue_where_target( self, npc_name: &str, at: Vec2<f32>, target: Actor, ) -> (Content, Marker, Content)

“Where is my target again?” Map gets marked with a marker, and the NPC responds with their location.

pub fn get_courier_claim_dialogue(self) -> (Content, Content)

Returns the dialogue question and response that an entity will use when the courier quest’s messenger is speaking to the quest target and is attempting to finish the quest (claim the reward).

pub fn get_quest_spot_start_marker( self, at: Vec2<f32>, tgt_npc_name: &str, quest_id: QuestId, ) -> Marker

Generates a map marker that represents the position of the courier quest’s targeted spot’s position.

pub fn get_quest_npc_target_marker( self, at: Vec2<f32>, tgt_npc_name: &str, target_npc_id: NpcId, ) -> Marker

Generates a map marker that represents the position of the courier quest’s target entity.

Trait Implementations

impl Clone for CourierQuestInstance

fn clone(&self) -> CourierQuestInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CourierQuestInstance

impl Debug for CourierQuestInstance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CourierQuestInstance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CourierQuestInstance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.