EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Effects

set_light

Switch the light of the actor's equipped item explicitly on or off.

Feature
actors
Rights
actor_target
Debits
none
Conflict
replacing
Errors
invalid_type faultmissing_reference faultprecondition_failed rejectionscope_denied faultstale_reference rejectionunknown_field fault

Signature

{ enabled: boolean, kind: "set_light", light: LightId, target: ActorRef }

Fields

NameTypeMeaning
enabledbooleanWhether the light is on after the commit.
kind"set_light"Discriminant
lightLightIdLight of the currently equipped item.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: light
targetActorRefActor instance selected by the item-use target contract.
Length: 1…256; Pattern: ^[\s\S]+$

Validated example

{
  "enabled": true,
  "kind": "set_light",
  "light": "core:torch_light",
  "target": "a1"
}