EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Types

Read

Snapshot reads never access live simulation state.

Feature
authority
Rights
snapshot
Errors
missing_reference faultscope_denied fault

Signature

{ actor: (ActorRef) -> ActorView?, clock: () -> ClockView, count_item: (ActorRef, ItemId) -> Count, nearby: (SnapshotRadius) -> NearbyPage, quest: (PlayerRef, QuestId) -> QuestView?, variable: (VariableId, VariableOwner) -> StateValue }

Fields

NameTypeMeaning
actor(ActorRef) -> ActorView?Read a visible actor.
clock() -> ClockViewRead the simulation clock.
count_item(ActorRef, ItemId) -> CountCount an item in the inventory of the event actor or the invocation owner.
nearby(SnapshotRadius) -> NearbyPageVisible actors within this distance of the snapshot centre, at most the declared snapshot radius.
quest(PlayerRef, QuestId) -> QuestView?Read a quest stage and revision for the permitted player.
variable(VariableId, VariableOwner) -> StateValueRead a declared variable, using its virtual initial value when absent.