Action On Entity Set (Entity Action Type)

Executes an action on entities stored within the power that uses the apoli:entity_set.

Type ID: apoli:action_on_entity_set (but can use it’s old action_on_set type id as an alias)

In the context of this entity action type, the actor will be the entity that invoked the entity action while the target will be the entities within the power. The action will be executed on the entities stored within the power regardless of their dimension.

Fields#

Field	Type	Default	Description
set	Identifier		The ID of the power.
bientity_action	Bi-entity Action Type		The bi-entity action to execute on both or either the actor and target.
bientity_condition	Bi-entity Condition Type	optional	If specified, only execute the bi-entity action if this bi-entity condition is fulfilled by both or either the actor and target.
limit	Integer	0	Determines the max amount of times the entity action type should iterate and execute the bi-entity action on the entities stored within the power. If the value is less than or equal to 0, then there will be no limit.
reverse	Boolean	false	Determines whether to reverse the order of the entities within the power when processing.
iterate	Set Iteration	members	Which side of the set to walk — members for the set you own, owners for every set that has you in it.

Walking the owners instead of the members#

By default the entity running this action must hold the apoli:entity_set power itself; if it doesn’t, nothing happens. That makes the common “get me out of the set that captured me” case impossible to write, because the set lives on the entity that added you, not on you.

"iterate": "owners" flips the walk: it finds every entity whose set power currently contains you, and runs the bi-entity action once per such entity with the set’s owner as the actor and you as the target. Those are exactly the roles apoli:remove_from_entity_set expects, so leaving a set someone else put you in is a one-liner.

limit and reverse apply to the owner list in this mode. bientity_condition is tested with the same actor/target pair that the action would receive.

Examples#

"entity_action": {
	"type": "apoli:action_on_entity_set",
	"set": "example:special_pets",
	"bientity_action": {
		"type": "apoli:target_action",
		"action": {
			"type": "apoli:heal",
			"amount": 4
		}
	}
}

This example will restore 2 hearts to entities that were added to the example:special_pets (data/example/powers/special_pets.json) power using the apoli:add_to_entity_set.

{
	"type": "apoli:action_when_hit",
	"entity_action": {
		"type": "apoli:action_on_entity_set",
		"set": "example:mind_controlled",
		"iterate": "owners",
		"bientity_action": {
			"type": "apoli:remove_from_entity_set",
			"set": "example:mind_controlled"
		}
	}
}

Put this on the victim: taking any damage removes them from every example:mind_controlled set they are in, firing that set’s action_on_remove on the way out. Without "iterate": "owners" this does nothing, because the victim never holds the set power.