Skip to content

Commit 3fe8010

Browse files
committed
doc: Document API changes for ApplyEffect.
1 parent 723f74b commit 3fe8010

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

doc/nyan/api_reference/reference_util.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,18 @@ Generalization object for conditions that can be used in `XORGate` nodes.
5454
**node**
5555
Node that is visited when the condition is true.
5656

57+
## util.activity.condition.type.AbilityUsable
58+
59+
```python
60+
AbilityUsable(Condition):
61+
ability : abstract(Ability)
62+
```
63+
64+
Is true when an ability can be used by the game entity when the node is visited.
65+
66+
**ability**
67+
Ability definition used for the usability check. This can reference a specific ability of the game entity or an abstract API object from the `engine.ability.type` namespace. If a specific ability is referenced, the ability must be assigned to the game entity **and** be enabled for the check to pass. If an API object is referenced, at least one ability of the same type must be enabled for the check to pass.
68+
5769
## util.activity.condition.type.CommandInQueue
5870

5971
```python
@@ -87,7 +99,7 @@ Is true when the target of the next command in the game entity's command queue i
8799
**ability**
88100
Ability definition used for the range check.
89101

90-
This can reference a specific ability of the game entity or an abstract API object from the `engine.ability.type` namespace. If a specific ability is referenced, the ability must be assigned to the game entity and must not be disabled. Otherwise, the range check fails. If an API object is referenced, the first active ability with the same type as the API object is executed.
102+
This can reference a specific ability of the game entity or an abstract API object from the `engine.ability.type` namespace. If a specific ability is referenced, the ability must be assigned to the game entity and must be enabled. Otherwise, the range check fails. If an API object is referenced, the first active ability with the same type as the API object is executed.
91103

92104
If the ability has the property `Ranged`, the attributes of this property are utilized for the range check calculations. If the ability does not have a `Ranged` property, the condition is only true when the game entity is at the same position as the target.
93105

@@ -159,7 +171,7 @@ Next node in the activity graph.
159171
**ability**
160172
Ability that is executed.
161173

162-
This can reference a specific ability of the game entity or an abstract API object from the `engine.ability.type` namespace. If a specific ability is referenced, the ability must be assigned to the game entity and must not be disabled. Otherwise, the ability is not executed. If an API object is referenced, the first active ability with the same type as the API object is executed.
174+
This can reference a specific ability of the game entity or an abstract API object from the `engine.ability.type` namespace. If a specific ability is referenced, the ability must be assigned to the game entity and must be enabled. Otherwise, the ability is not executed. If an API object is referenced, the first active ability with the same type as the API object is executed.
163175

164176
## util.activity.node.type.End
165177

0 commit comments

Comments
 (0)