Difference between revisions of "Osiris/API/IterateParties"

From Divinity Engine Wiki
Jump to: navigation, search
(Documented IterateParties)
 
m
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
 
Iterates over all characters in that are in any [[Osiris/API/AddToParty|party]], and throws the [[Osiris/API/StoryEvent|event]] '''_Event''' for every one of them.
 
Iterates over all characters in that are in any [[Osiris/API/AddToParty|party]], and throws the [[Osiris/API/StoryEvent|event]] '''_Event''' for every one of them.
 
===== Notes =====
 
===== Notes =====
* /
+
* Since only player characters can be in parties, and since all player characters are guaranteed to be in a party, the practical upshot is that this call sends '''_Event''' to all current player characters.
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/AddToParty|AddToParty]]
 
* [[Osiris/API/AddToParty|AddToParty]]
Line 19: Line 19:
 
* [[Osiris/API/LeaveParty|LeaveParty]]
 
* [[Osiris/API/LeaveParty|LeaveParty]]
  
[[Category:Osiris Calls]]
+
[[Category:Osiris Calls|IterateParties]]

Latest revision as of 08:28, 12 April 2018

Full Definition(s)
  • call IterateParties((STRING)_Event)
Description

Iterates over all characters in that are in any party, and throws the event _Event for every one of them.

Notes
  • Since only player characters can be in parties, and since all player characters are guaranteed to be in a party, the practical upshot is that this call sends _Event to all current player characters.
See Also