Difference between revisions of "Osiris/API/JumpToTurn"
From Divinity Engine Wiki
m (Link DB_CombatCharacters, ObjectTurnStarted and ObjectTurnEnded) |
m |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * call '''JumpToTurn'''(''( | + | * call '''JumpToTurn'''(''(GUIDSTRING)'''''_Target''') |
===== Description ===== | ===== Description ===== | ||
Switches the current combat turn to '''_Target''', so that it can act immediately. | Switches the current combat turn to '''_Target''', so that it can act immediately. | ||
| Line 6: | Line 6: | ||
* '''_Target''' must be in a combat. | * '''_Target''' must be in a combat. | ||
* '''_Target''''s combat information needs to have been fully initialised before this API can be used. See [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] for more information. | * '''_Target''''s combat information needs to have been fully initialised before this API can be used. See [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] for more information. | ||
| + | * The turn of the character currently active in the same combat ends when this call is used (so they will only have a turn again in the next combat round). | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CombatStarted|CombatStarted]] | * [[Osiris/API/CombatStarted|CombatStarted]] | ||
| + | * [[Osiris/API/EndTurn|EndTurn]] | ||
* [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] | * [[Osiris/API/ObjectReadyInCombat|ObjectReadyInCombat]] | ||
* [[Osiris/API/ObjectTurnStarted|ObjectTurnStarted]] | * [[Osiris/API/ObjectTurnStarted|ObjectTurnStarted]] | ||
| Line 13: | Line 15: | ||
* Helper [[Osiris/Shared/DB_CombatCharacters|DB_CombatCharacters]] | * Helper [[Osiris/Shared/DB_CombatCharacters|DB_CombatCharacters]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|JumpToTurn]] |
Latest revision as of 12:27, 2 October 2018
Full Definition(s)
- call JumpToTurn((GUIDSTRING)_Target)
Description
Switches the current combat turn to _Target, so that it can act immediately.
Notes
- _Target must be in a combat.
- _Target's combat information needs to have been fully initialised before this API can be used. See ObjectReadyInCombat for more information.
- The turn of the character currently active in the same combat ends when this call is used (so they will only have a turn again in the next combat round).
