Osiris/API/CharacterAssignToUser: Difference between revisions
Jump to navigation
Jump to search
(CharacterAssignToUser also moves the character to the user's party, and documented when this routine fails) |
mNo edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
Assigns control over the [[Osiris/API/CharacterIsPlayer|player-controlled character]] '''_Character''' to the [[Osiris/API/CharacterGetReservedUserID|user]] with ID '''_UserID'''. The character will also be moved to the new user's [[Osiris/API/AddToParty|party]]. | Assigns control over the [[Osiris/API/CharacterIsPlayer|player-controlled character]] '''_Character''' to the [[Osiris/API/CharacterGetReservedUserID|user]] with ID '''_UserID'''. The character will also be moved to the new user's [[Osiris/API/AddToParty|party]]. | ||
===== Notes ===== | ===== Notes ===== | ||
* This routine does nothing if '''_Character''' is '''NULL''', if it's not a | * 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. | ||
===== 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 15: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.