Difference between revisions of "Osiris/API/IterateUsers"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
Line 2: Line 2:
 
* call '''IterateUsers'''(''(STRING)'''''_Event''')
 
* call '''IterateUsers'''(''(STRING)'''''_Event''')
 
===== Description =====
 
===== Description =====
Throws a [[Osiris/API/UserEvent|UserEvent]] for each [[Osiris/API/CharacterGetReservedUserID|user]] in the game.
+
Throws a [[Osiris/API/UserEvent|user event]] for each [[Osiris/API/CharacterGetReservedUserID|user]] in the game.
 
===== Notes =====
 
===== Notes =====
 
* No special event is thrown after the last user has been iterated. You can use [[Osiris/API/GetUserCount|GetUserCount]] in advance to record the number of users and decrease it every time you get a user event, but keep in mind this creates a (very unlikely) race condition in case someone connects while the events are still firing.
 
* No special event is thrown after the last user has been iterated. You can use [[Osiris/API/GetUserCount|GetUserCount]] in advance to record the number of users and decrease it every time you get a user event, but keep in mind this creates a (very unlikely) race condition in case someone connects while the events are still firing.

Revision as of 15:43, 28 November 2017

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

Throws a user event for each user in the game.

Notes
  • No special event is thrown after the last user has been iterated. You can use GetUserCount in advance to record the number of users and decrease it every time you get a user event, but keep in mind this creates a (very unlikely) race condition in case someone connects while the events are still firing.
See Also