Osiris/Shared/ProcGetClosestAvailableCharacterTo - Revision history

LarSeb: Reverted edits by Greever (talk) to last revision by Tinkerer

2018-01-29T17:27:32Z

Reverted edits by Greever (talk) to last revision by Tinkerer

Can't load revision 5438

at 16:47, 29 January 2018

2018-01-29T16:47:52Z

Can't load revision 5437

at 16:46, 29 January 2018

2018-01-29T16:46:29Z

Notes

Can't load revision 5436

Tinkerer at 15:01, 19 December 2017

2017-12-19T15:01:46Z

← Older revision		Revision as of 15:01, 19 December 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''')		* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''', ''(INTEGER)'''''_SightCheck''')
	* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''',''(INTEGER)'''''_PartyCheck''',''(CHARACTERGUID)'''''_Player''')		* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''', ''(INTEGER)'''''_SightCheck''', ''(INTEGER)'''''_PartyCheck''', ''(CHARACTERGUID)'''''_Player''')
	* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''',''(INTEGER)'''''_PartyCheck''',''(CHARACTERGUID)'''''_Player''',''(CHARACTERGUID)'''''_ExceptPlayer''')		* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''', ''(INTEGER)'''''_SightCheck''', ''(INTEGER)'''''_PartyCheck''', ''(CHARACTERGUID)'''''_Player''', ''(CHARACTERGUID)'''''_ExceptPlayer''')

	===== Description =====		===== Description =====
Line 21:		Line 21:
	* [[Osiris/API/GetClosestAlivePlayer\|GetClosestAlivePlayer]]		* [[Osiris/API/GetClosestAlivePlayer\|GetClosestAlivePlayer]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers\|GetClosestAvailableCharacterTo]]

Tinkerer at 16:07, 30 August 2017

2017-08-30T16:07:31Z

← Older revision		Revision as of 16:07, 30 August 2017
Line 2:		Line 2:
	* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''')		* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''')
	* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''',''(INTEGER)'''''_PartyCheck''',''(CHARACTERGUID)'''''_Player''')		* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''',''(INTEGER)'''''_PartyCheck''',''(CHARACTERGUID)'''''_Player''')
			* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''',''(INTEGER)'''''_PartyCheck''',''(CHARACTERGUID)'''''_Player''',''(CHARACTERGUID)'''''_ExceptPlayer''')

	===== Description =====		===== Description =====
	The first invocation is equivalent to calling the second one with '''_PartyCheck == 0''' and '''_Player == NULL'''.		The first invocation is equivalent to calling the second one with '''_PartyCheck == 0''' and '''_Player == NULL'''.

			The second invocation is equivalent to calling the third one with '''_ExceptPlayer === NULL''' .
	Gets the closest '''player''' character to '''_Obj''' that is available to start a dialog with '''_Obj'''. Set '''_SightCheck''' to 1 if that character must be able to see '''_Obj'''. If '''_PartyCheck''' is 1, you must also and pass a valid parameter for '''_Player''', and the found player character (if any) will be guaranteed to be in the same party as '''_Player'''.
			Gets the closest '''player''' character to '''_Obj''' that is available to start a dialog with '''_Obj'''. Set '''_SightCheck''' to 1 if that character must be able to see '''_Obj'''. If '''_PartyCheck''' is 1, you must also and pass a valid parameter for '''_Player''', and the found player character (if any) will be guaranteed to be in the same party as '''_Player'''. If '''_ExceptPlayer''' is not NULL, then this routine will consider '''_ExceptPlayer''' to be unavailable even if they pass the other checks.

	===== Return Values =====		===== Return Values =====
	* '''DB_ClosestAvailablePlayer'''(''(CHARACTERGUID)'''''_Char''''',(CHARACTERGUID)'''''_Obj'''): closest player that can start a dialog with '''_Obj''' (conforming to all requested conditions), if any.		* '''DB_ClosestAvailablePlayer'''(''(CHARACTERGUID)'''''_Char''''',(CHARACTERGUID)'''''_Obj'''): closest player that can start a dialog with '''_Obj''' (conforming to all requested conditions), if any.
	* '''DB_ClosestAvailablePlayer_NoAvailablePlayer'''(''(CHARACTERGUID)'''''_Obj'''): Set if no player character is available that conforms to the requested conditions.		* '''DB_ClosestAvailablePlayer_NoAvailablePlayer'''(''(CHARACTERGUID)'''''_Obj'''): Set if no player character is available that conforms to the requested conditions.

	===== Notes =====		===== Notes =====
	* /		* /

	===== See Also =====		===== See Also =====
	* [[Osiris/API/GetClosestAlivePlayer\|GetClosestAlivePlayer]]		* [[Osiris/API/GetClosestAlivePlayer\|GetClosestAlivePlayer]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]

Tinkerer at 21:11, 25 August 2017

2017-08-25T21:11:18Z

← Older revision		Revision as of 21:11, 25 August 2017
Line 13:		Line 13:
	* /		* /
	===== See Also =====		===== See Also =====
	* /		* [[Osiris/API/GetClosestAlivePlayer\|GetClosestAlivePlayer]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers]]

Tinkerer: Osiris Helper Mod APIs

2017-08-08T13:56:33Z

Osiris Helper Mod APIs

New page

===== Full Definition(s) =====
* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''')
* PROC '''ProcGetClosestAvailableCharacterTo'''(''(CHARACTERGUID)'''''_Obj''',''(INTEGER)'''''_SightCheck''',''(INTEGER)'''''_PartyCheck''',''(CHARACTERGUID)'''''_Player''')
===== Description =====
The first invocation is equivalent to calling the second one with '''_PartyCheck == 0''' and '''_Player == NULL'''.

Gets the closest '''player''' character to '''_Obj''' that is available to start a dialog with '''_Obj'''. Set '''_SightCheck''' to 1 if that character must be able to see '''_Obj'''. If '''_PartyCheck''' is 1, you must also and pass a valid parameter for '''_Player''', and the found player character (if any) will be guaranteed to be in the same party as '''_Player'''.
===== Return Values =====
* '''DB_ClosestAvailablePlayer'''(''(CHARACTERGUID)'''''_Char''''',(CHARACTERGUID)'''''_Obj'''): closest player that can start a dialog with '''_Obj''' (conforming to all requested conditions), if any.
* '''DB_ClosestAvailablePlayer_NoAvailablePlayer'''(''(CHARACTERGUID)'''''_Obj'''): Set if no player character is available that conforms to the requested conditions.
===== Notes =====
* /
===== See Also =====
* /

[[Category:Osiris Shared Mod Helpers]]