Store Origin (Entity Action Type)

Remembers the entity’s own origin under a named key, so origins:apply_stored_origin can put it back later.

Type ID: origins:store_origin — an entity action.

Needs the Origins mod. Registered by Origins, not core Apoli. It only works on players, and only on the server. See Origin storage for the system as a whole.

Fields#

Field	Type	Default	Purpose
key	String	required	The name to store the entry under. Storing under an existing key overwrites it.
layer	Identifier	origins:origin	Which layer’s origin to read, and the layer recorded with the entry.
origin	Identifier	optional	Store this origin id literally instead of reading the entity’s current one.
clear	Boolean	false	Remove the entry at key instead of writing one.

Nothing is stored if the entity has no origin on layer (or the origin resolves to empty). The entry survives death, respawn and relog.

Examples#

Remember what you are before something takes it away:

{
  "type": "origins:store_origin",
  "key": "before_curse"
}

Pre-load a key with a fixed origin, so a later apply_stored_origin has something to fall back to:

{
  "type": "origins:store_origin",
  "key": "default_form",
  "origin": "origins:human"
}

Forget it again:

{
  "type": "origins:store_origin",
  "key": "before_curse",
  "clear": true
}