Osiris/API/GetClosestAlivePlayer: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
(Osiris Core APIs)
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 8: Line 8:
===== Notes =====
===== Notes =====
* Be careful if you check for extra conditions on the returned player: if any of those conditions fail, no other players will be considered.
* Be careful if you check for extra conditions on the returned player: if any of those conditions fail, no other players will be considered.
* If you want to start a dialog, use '''ProcGetClosestAvailableCharacterTo'''
* If you want to start a dialog, use [[Osiris/Shared/ProcGetClosestAvailableCharacterTo|ProcGetClosestAvailableCharacterTo]]
===== See Also =====
===== See Also =====
* Helper [[Osiris/Shared/ProcGetClosestAvailableCharacterTo]]
* Helper [[Osiris/Shared/ProcGetClosestAvailableCharacterTo|ProcGetClosestAvailableCharacterTo]]
    
    
[[Category:Osiris Queries]]
[[Category:Osiris Queries|GetClosestAlivePlayer]]

Latest revision as of 14:29, 19 December 2017

Full Definition(s)
  • query GetClosestAlivePlayer([in](GUIDSTRING)_Target, [out](CHARACTERGUID)_Player)
Description

Gets the closest player to _Target that is alive and stores it in _Player.

Return Values
  • Success/Failure: Fails if no living player is found.
  • _Player: The found player character.
Notes
  • Be careful if you check for extra conditions on the returned player: if any of those conditions fail, no other players will be considered.
  • If you want to start a dialog, use ProcGetClosestAvailableCharacterTo
See Also