Difference between revisions of "Osiris/API/CharacterGetReservedUserID"
From Divinity Engine Wiki
m (link GetUserProfileID) |
m (CharacterGetReservedUserID is a query, not a call) |
||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * | + | * query '''CharacterGetReservedUserID'''('''''[in]'''(CHARACTERGUID)'''''_Character''','''''[out]'''(INTEGER)'''''_User''') |
===== Description ===== | ===== Description ===== | ||
Returns the ID of the user that controls '''_Character''' in '''_User'''. | 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 ===== | ===== 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. | ||
| Line 12: | Line 15: | ||
* [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] | * [[Osiris/API/CharacterRecruitCharacter|CharacterRecruitCharacter]] | ||
| − | [[Category:Osiris | + | [[Category:Osiris Queries]] |
Revision as of 21:03, 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.
