Runtime classServer APIGenerated

Quest

Defined in: server/api.d.ts:4989

Replicated journal quest handle.

Extends

Entity

Constructors

Constructor

new Quest(id): Quest

Defined in: server/api.d.ts:4994

Creates a script wrapper for an existing quest with this ID; use Quest.give() to write one.

Parameters

id

number

Network entity identifier.

Returns

Quest

Inherited from

Entity.constructor

Methods

objectives()

objectives(): object[]

Defined in: server/api.d.ts:5068

Reads the quest’s objectives back.

Returns

object[]

One entry per objective, in journal order. position is present only on an objective that has one.

remove()

remove(): void

Defined in: server/api.d.ts:5040

Takes this quest out of every journal it was written into.

Returns

void

setObjective()

setObjective(index, objective, announce?): void

Defined in: server/api.d.ts:5055

Rewrites one line of the quest in place.

Parameters

index

number

Which objective to rewrite, counting from zero. An index past the end is ignored.

objective

string | { optional?: boolean; position?: Vector3; progress?: "done" | "failed" | "active"; text: string; }

The line, as text or as an object carrying its state.

announce?

boolean

Whether to raise the quest-updated toast; defaults to true.

Returns

void

setObjectives()

setObjectives(objectives, announce?): void

Defined in: server/api.d.ts:5062

Replaces the quest’s objective list.

Parameters

objectives

(string | { optional?: boolean; position?: Vector3; progress?: "done" | "failed" | "active"; text: string; })[]

The whole list, at most eight entries; anything past that is dropped.

announce?

boolean

Whether to raise the quest-updated toast; defaults to true.

Returns

void

setProgress()

setProgress(progress, announce?): void

Defined in: server/api.d.ts:5047

Moves the quest on. There is no way back to unstarted: a quest nobody should see any more is removed.

Parameters

progress

"done" | "failed" | "active"

Where the quest now stands.

announce?

boolean

Whether to raise the game’s quest-updated toast; defaults to true. Pass false for a correction the player should not be told about.

Returns

void

setVirtualWorld()

setVirtualWorld(world): void

Defined in: server/api.d.ts:8797

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

Entity.setVirtualWorld

setVisibleTo()

setVisibleTo(player): void

Defined in: server/api.d.ts:8803

Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.

Parameters

player

Entity | null

Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.

Returns

void

Inherited from

Entity.setVisibleTo

toString()

toString(): string

Defined in: server/api.d.ts:5035

Formats this quest handle for logging and debugging.

Returns

string

The quest ID, its key, its state and how many objectives it carries.

Inherited from

Entity.toString

track()

track(player?): number

Defined in: server/api.d.ts:5075

Makes the game follow this quest, exactly as the journal’s track button does: it is listed in the HUD tracker, and every active objective that has a position is drawn as the game’s own quest marker on the map and the compass. It is an instruction, not a lock – the player can untrack it from the journal – and the outcome arrives as questTrackingChanged like any other change. A quest given a moment ago can be tracked at once; the client waits for it to arrive.

Parameters

player?

number

Network id of the player who should follow the quest. Omitted, everyone who has the quest follows it: its one owner, or every player in its world.

Returns

number

How many clients were told. Zero when the player does not have this quest.

untrack()

untrack(player?): number

Defined in: server/api.d.ts:5082

Makes the game stop following this quest, which takes its markers off the map and the compass. The outcome arrives as questTrackingChanged.

Parameters

player?

number

Network id of the player who should stop following the quest. Omitted, everyone who has the quest stops.

Returns

number

How many clients were told.

all()

static all(virtualWorld?): Quest[]

Defined in: server/api.d.ts:5099

Lists every replicated quest the server currently has.

Parameters

virtualWorld?

number

Optional virtual world to list; omitted lists every one of them.

Returns

Quest[]

One handle per live quest, in no particular order.

find()

static find(key, virtualWorld?, player?): Quest | null

Defined in: server/api.d.ts:5108

Looks a quest up by its key.

Parameters

key

string

The key the quest was given under.

virtualWorld?

number

Optional virtual world to search; omitted searches every one of them.

player?

number

Network id of the player whose copy to find. Keys are unique per recipient, so this is how one player’s errand is told from another’s.

Returns

Quest | null

The quest’s handle, or null when no live quest has that key.

getById()

static getById(id): Quest | null

Defined in: server/api.d.ts:5115

Looks a replicated quest up by its network entity ID.

Parameters

id

number

Network entity identifier.

Returns

Quest | null

The quest’s handle, or null when no live quest has that ID.

give()

static give(key, title, options?, virtualWorld?): Quest

Defined in: server/api.d.ts:5092

Writes a quest into the game’s own journal. It is a replicated entity, so a player who joins late, reloads or walks away still finds it in their log – which is what a quest needs and what a one-shot notification cannot do. What the player sees is the game’s quest UI: its journal row, its diary page, its objective tracker and its quest-updated toast, all reading a quest node the client builds with the game’s own constructor.

Parameters

key

string

What the quest is filed under: up to 64 letters, digits, underscores or dashes, unique within its virtual world.

title

string

The line the journal row shows.

options?

description is the diary page, type the journal section, objectives the lines under it – each with an optional world position the game marks on the map and compass while the quest is followed – player the network id of the one player it belongs to, announce whether to raise the toast, and track whether its recipients start following it.

announce?

boolean

description?

string

objectives?

(string | { optional?: boolean; position?: Vector3; progress?: "done" | "failed" | "active"; text: string; })[]

player?

number

track?

boolean

type?

virtualWorld?

number

Optional virtual world the quest belongs to; omitted puts it in the global one.

Returns

Quest

The newly written quest handle.

removeAll()

static removeAll(virtualWorld?): number

Defined in: server/api.d.ts:5122

Takes quests out of every journal they were written into.

Parameters

virtualWorld?

number

Optional virtual world to clear; omitted clears every one of them.

Returns

number

How many quests were removed.

Properties

description

description: string

Defined in: server/api.d.ts:5009

The body of the journal’s diary page for this quest. Assignment is silent.

id

readonly id: number

Defined in: server/api.d.ts:8765

Immutable network entity identifier.

Inherited from

Entity.id

key

readonly key: string

Defined in: server/api.d.ts:4999

The key the quest is filed under, and the name the game knows the quest node by. Read-only: it is the quest’s identity.

objectiveCount

readonly objectiveCount: number

Defined in: server/api.d.ts:5029

How many objectives the quest carries, up to eight.

player

readonly player: number

Defined in: server/api.d.ts:5024

Network id of the one player this quest was written for, or 0 when it went to everyone in the world. Read-only: who a quest belongs to is decided when it is given.

position

position: Vector3

Defined in: server/api.d.ts:8775

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

progress

progress: string

Defined in: server/api.d.ts:5019

active, done or failed. Assignment announces the change; setProgress can do it quietly.

rotation

rotation: Vector3 | Quaternion

Defined in: server/api.d.ts:8780

Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.

Inherited from

Entity.rotation

state

readonly state: StateBag

Defined in: server/api.d.ts:8785

Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.

Inherited from

Entity.state

title

title: string

Defined in: server/api.d.ts:5004

The line the journal row and the quest toast show. Assignment is silent; it does not raise a toast.

type

readonly type: string

Defined in: server/api.d.ts:5014

Which section of the journal the quest files under. Read-only: it is decided when the quest is given.

virtualWorld

readonly virtualWorld: number

Defined in: server/api.d.ts:8770

Current virtual-world identifier.

Inherited from

Entity.virtualWorld