Difference between revisions of "Osiris/API/CharacterIsControlled"
From Divinity Engine Wiki
(Documented CharacterIsControlled) |
m |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''CharacterIsControlled'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_IsControlled''') | + | * query '''CharacterIsControlled'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[out]'''(INTEGER)'''''_IsControlled''') |
===== Description ===== | ===== Description ===== | ||
Returns whether '''_Character''' is currently controlled by a [[Osiris/API/CharacterGetReservedUserID|user]]/player. | Returns whether '''_Character''' is currently controlled by a [[Osiris/API/CharacterGetReservedUserID|user]]/player. | ||
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Fails if '''_Character''' is '''NULL'''. | * '''Success/Failure''': Fails if '''_Character''' is '''NULL'''. | ||
| − | * ''' | + | * '''_IsControlled''': '''1''' if '''_Character''' is currently controlled by a user, '''0''' if not. |
===== Notes ===== | ===== Notes ===== | ||
* / | * / | ||
===== See Also ===== | ===== See Also ===== | ||
| + | * [[Osiris/API/MakePlayerActive|MakePlayerActive]] | ||
* [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] | * [[Osiris/API/CharacterIsPlayer|CharacterIsPlayer]] | ||
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|CharacterIsControlled]] |
Latest revision as of 16:24, 19 December 2017
Full Definition(s)
- query CharacterIsControlled([in](CHARACTERGUID)_Character, [out](INTEGER)_IsControlled)
Description
Returns whether _Character is currently controlled by a user/player.
Return Values
- Success/Failure: Fails if _Character is NULL.
- _IsControlled: 1 if _Character is currently controlled by a user, 0 if not.
Notes
- /
