Osiris/API/CharacterLaunchIteratorAroundCharacter: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| 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 | 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 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/CharacterLaunchIterator|CharacterLaunchIterator]] | |||
* [[Osiris/API/StoryEvent|StoryEvent]] | * [[Osiris/API/StoryEvent|StoryEvent]] | ||
* [[Osiris/API/TriggerLaunchIterator|TriggerLaunchIterator]] | * [[Osiris/API/TriggerLaunchIterator|TriggerLaunchIterator]] | ||
[[Category:Osiris Calls|CharacterLaunchIteratorAroundCharacter]] | [[Category:Osiris Calls|CharacterLaunchIteratorAroundCharacter]] | ||
Revision as of 19:46, 28 February 2018
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 clean-up or finalise processing.
Notes
- As mentioned in the description, this will only iterate over characters.