Difference between revisions of "Osiris/API/CharacterGetReservedUserID"
From Divinity Engine Wiki
m (CharacterGetReservedUserID is a query, not a call) |
m (Mention that GetUserProfileID|GetUserProfileID can be used to get persistent identifiers for player) |
||
| Line 8: | Line 8: | ||
===== Notes ===== | ===== Notes ===== | ||
* "Users" are the game term for human players in the game. Every client that connects to the game, including the one that started the host game, gets assigned a User ID. | * "Users" are the game term for human players in the game. Every client that connects to the game, including the one that started the host game, gets assigned a User ID. | ||
| − | * User IDs are volatile: they can change at any time, in particular when loading a saved game, or when someone disconnects and reconnects. Never store this value in a database. Only use it immediately after requesting it, within the same frame. | + | * User IDs are volatile: they can change at any time, in particular when loading a saved game, or when someone disconnects and reconnects. Never store this value in a database. Only use it immediately after requesting it, within the same frame. If you need a persistent identifier for a user (or rather, user profile), pass the result of this query to [[Osiris/API/GetUserProfileID|GetUserProfileID]]. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterAssignToUser|CharacterAssignToUser]] | * [[Osiris/API/CharacterAssignToUser|CharacterAssignToUser]] | ||
| − | |||
* [[Osiris/API/CharacterMakePlayer|CharacterMakePlayer]] | * [[Osiris/API/CharacterMakePlayer|CharacterMakePlayer]] | ||
* [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] | * [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] | ||
| + | * [[Osiris/API/GetUserProfileID|GetUserProfileID]] | ||
[[Category:Osiris Queries]] | [[Category:Osiris Queries]] | ||
Revision as of 20:12, 28 November 2017
Full Definition(s)
- query CharacterGetReservedUserID([in](CHARACTERGUID)_Character,[out](INTEGER)_User)
Description
Returns the ID of the user that controls _Character in _User.
Return Values
- Success/Failure: Fails if _Character does not exist or is NUULL.
- _User: The user ID of the player to which _Character is assigned. If it is not assigned to anyone, the special value -65536 is returned.
Notes
- "Users" are the game term for human players in the game. Every client that connects to the game, including the one that started the host game, gets assigned a User ID.
- User IDs are volatile: they can change at any time, in particular when loading a saved game, or when someone disconnects and reconnects. Never store this value in a database. Only use it immediately after requesting it, within the same frame. If you need a persistent identifier for a user (or rather, user profile), pass the result of this query to GetUserProfileID.
