Difference between revisions of "Osiris/API/CharacterLaunchIterator"
From Divinity Engine Wiki
(Documented CharacterLaunchIterator) |
m |
||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
* call '''CharacterLaunchIterator'''(''(STRING)'''''_Event''') | * call '''CharacterLaunchIterator'''(''(STRING)'''''_Event''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Causes story event '''_Event''' to be thrown for every ''character'' in the current level. Once the last such character has been iterated, an additional story event '''_Event''' will be thrown for object '''''NULL_00000000-0000-0000-0000-000000000000''''', so that you can perform any necessary clean-up or finalise processing. | + | Causes [[Osiris/API/StoryEvent|story event]] '''_Event''' to be thrown for every ''character'' in the current level. Once the last such character has been iterated, an additional story event '''_Event''' will be thrown for object '''''NULL_00000000-0000-0000-0000-000000000000''''', so that you can perform any necessary clean-up or finalise processing. |
===== Notes ===== | ===== Notes ===== | ||
* As mentioned in the description, this will only iterate over characters. | * As mentioned in the description, this will only iterate over characters. | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterLaunchIteratorAroundCharacter|CharacterLaunchIteratorAroundCharacter]] | * [[Osiris/API/CharacterLaunchIteratorAroundCharacter|CharacterLaunchIteratorAroundCharacter]] | ||
| + | * [[Osiris/API/CharacterLaunchOsirisOnlyIterator|CharacterLaunchOsirisOnlyIterator]] | ||
* [[Osiris/API/StoryEvent|StoryEvent]] | * [[Osiris/API/StoryEvent|StoryEvent]] | ||
* [[Osiris/API/TriggerLaunchIterator|TriggerLaunchIterator]] | * [[Osiris/API/TriggerLaunchIterator|TriggerLaunchIterator]] | ||
[[Category:Osiris Calls|CharacterLaunchIterator]] | [[Category:Osiris Calls|CharacterLaunchIterator]] | ||
Latest revision as of 21:39, 20 February 2019
Full Definition(s)
- call CharacterLaunchIterator((STRING)_Event)
Description
Causes story event _Event to be thrown for every character in the current level. Once the last such character has been iterated, an additional story event _Event will be thrown for object NULL_00000000-0000-0000-0000-000000000000, so that you can perform any necessary clean-up or finalise processing.
Notes
- As mentioned in the description, this will only iterate over characters.
