api

Instance Actions

Actions for replacing, transforming, spawning, moving, and modifying matched OpenMW objects.

Instance actions run from YAML actions arrays after a rule's conditions match. An action table may contain multiple fields; SSS executes those fields in a fixed priority order rather than YAML key order. See action execution order.

Choose a reference

NeedReference
Replacement, transforms, teleport, and spawningWorld and transform actions
Add, remove, equip, and unequip inventory itemsInventory and equipment actions
Locks, keys, traps, ownership, globals, disable, and deleteWorld-state actions
Scripts, activation, tags, and soundsScripts, tags, and sound actions
Sampled action values and required upper boundsRandom action ranges
Combined action order and chance rollsAction execution order

Common rule shape

instances:
  - conditions:
      - record_id: mudcrab
    actions:
      - chance: 0.25
        create:
          mudcrab:
            count: 2
            position:
              x: { min: -100, max: 100 }

chance belongs to an action block, not to a condition. It rolls independently each time that action block is reached. Per-entry or per-pool chance is documented with the relevant action. For rule persistence, once: true saves a successful rule application for the object; once: per_cell tracks it only for the current SSS activation batch; omitted once permits later activations. A failed or no-op action does not generally establish a successful rule application, except where a dependency caveat is called out.