Skip to main content

Revoke Origin (Entity Action Type)

Takes an origin away from a player. It is the reverse of origins:grant_origin.

Type ID: origins:revoke_origin

note

This action comes from the Origins mod and only runs for players.

Fields

FieldTypeDefaultDescription
originIdentifieroptionalThe origin to take. Leave it out to clear the layer and everything the player was granted in its swap pool.
layerIdentifierorigins:originThe layer to take it from.

With origin set, the swap pool is searched first. If the origin isn't there and it is the layer's current pick, the layer is cleared instead. Revoking the origin a player is currently swapped into returns them to their own origin automatically.

Clearing a layer doesn't leave the player without an origin for good. A layer that uses auto_choose derives one again straight away. On the player's next join, a layer with a default_origin gives them that origin, and any other layer opens the choose screen.

Examples

{
  "type": "origins:revoke_origin",
  "origin": "example:wolf_form",
  "layer": "origins:origin"
}

This takes example:wolf_form back out of the player's swap pool.

{
  "type": "origins:revoke_origin",
  "layer": "origins:origin"
}

This clears the main layer completely, both the pick and the pool.