Difference between revisions of "Osiris/API/CharacterAssignToUser"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
===== Notes =====
 
===== Notes =====
 
* This routine does nothing if '''_Character''' is '''NULL''', if it's not a player-controlled character, or if it is already assigned to the user with ID '''_UserID'''.
 
* This routine does nothing if '''_Character''' is '''NULL''', if it's not a player-controlled character, or if it is already assigned to the user with ID '''_UserID'''.
* Characters can also be assigned to users by the game engine itself when they connect to a game.
+
* Characters can also be assigned to users by the game engine itself when they connect to a game or when someone else disconnects.
* 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.
 
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/CharacterGetReservedUserID|CharacterGetReservedUserID]]
 
* [[Osiris/API/CharacterGetReservedUserID|CharacterGetReservedUserID]]
Line 14: Line 13:
 
* [[Osiris/API/CharacterReservedUserIDChanged|CharacterReservedUserIDChanged]]
 
* [[Osiris/API/CharacterReservedUserIDChanged|CharacterReservedUserIDChanged]]
  
[[Category:Osiris Calls]]
+
[[Category:Osiris Calls|CharacterAssignToUser]]

Latest revision as of 16:13, 19 December 2017

Full Definition(s)
  • call CharacterAssignToUser((INTEGER)_UserID, (CHARACTERGUID)_Character)
Description

Assigns control over the player-controlled character _Character to the user with ID _UserID. The character will also be moved to the new user's party.

Notes
  • This routine does nothing if _Character is NULL, if it's not a player-controlled character, or if it is already assigned to the user with ID _UserID.
  • Characters can also be assigned to users by the game engine itself when they connect to a game or when someone else disconnects.
See Also