Difference between revisions of "Osiris/API/CharacterLaunchIteratorAroundCharacter"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| Line 2: | Line 2: | ||
* call '''CharacterLaunchIteratorAroundCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Radius''', ''(STRING)'''''_Event''') | * call '''CharacterLaunchIteratorAroundCharacter'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Radius''', ''(STRING)'''''_Event''') | ||
===== Description ===== | ===== Description ===== | ||
| − | + | Causes story event '''_Event''' to be thrown for every ''character'' within '''_Radius''' meters of '''_Character'''. 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 cleanup or finalise processing. | |
===== Notes ===== | ===== Notes ===== | ||
* As mentioned in the description, this will only iterate over character. | * As mentioned in the description, this will only iterate over character. | ||
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/TriggerLaunchIterator]] | + | * [[Osiris/API/TriggerLaunchIterator|TriggerLaunchIterator]] |
[[Category:Osiris Calls]] | [[Category:Osiris Calls]] | ||
Revision as of 22:22, 16 August 2017
Full Definition(s)
- call CharacterLaunchIteratorAroundCharacter((CHARACTERGUID)_Character, (REAL)_Radius, (STRING)_Event)
Description
Causes story event _Event to be thrown for every character within _Radius meters of _Character. 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 cleanup or finalise processing.
Notes
- As mentioned in the description, this will only iterate over character.
