Osiris/API/ObjectIsInTrigger - Revision history

Tinkerer at 20:30, 12 January 2018

2018-01-12T20:30:06Z

← Older revision		Revision as of 20:30, 12 January 2018
Line 2:		Line 2:
	* query '''ObjectIsInTrigger'''('''''[in]'''(GUIDSTRING)'''''_Object''', '''''[in]'''(TRIGGERGUID)'''''_Trigger''', '''''[out]'''(INTEGER)'''''_Bool''')		* query '''ObjectIsInTrigger'''('''''[in]'''(GUIDSTRING)'''''_Object''', '''''[in]'''(TRIGGERGUID)'''''_Trigger''', '''''[out]'''(INTEGER)'''''_Bool''')
	===== Description =====		===== Description =====
	Returns whether '''_Object''' is inside '''_Trigger'''. It does not require that '''_Trigger''' has been registered for '''_Object'''. '''_Object''' can be a character, item, or another object such as a trigger or spline. In the non-character/item case, it will ~~use~~ check whether the centre/"position" (as shown in the editor) of this other object is in the trigger (it will not check whether an entire box trigger is inside the boundaries in another box trigger).		Returns whether '''_Object''' is inside '''_Trigger'''. It does not require that '''_Trigger''' has been registered for '''_Object'''. '''_Object''' can be a character, item, or another object such as a trigger or spline. In the non-character/item case, it will check whether the centre/"position" (as shown in the editor) of this other object is in the trigger (o/e/; it will not check whether an entire box trigger is inside the boundaries in another box trigger).

	If '''_Object''' is an item and it is currently inside a container or a character's inventory, the query will check whether the outermost container/character is inside '''_Trigger'''.		If '''_Object''' is an item and it is currently inside a container or a character's inventory, the query will check whether the outermost container/character is inside '''_Trigger'''.
Line 9:		Line 9:
	* '''_Bool''': '''1''' if '''_Object''', or its outermost container/owning character, is currently in the '''_Trigger'''.		* '''_Bool''': '''1''' if '''_Object''', or its outermost container/owning character, is currently in the '''_Trigger'''.
	===== Notes =====		===== Notes =====
	* /		* This is a fairly expensive check.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterEnteredTrigger\|CharacterEnteredTrigger]]		* [[Osiris/API/CharacterEnteredTrigger\|CharacterEnteredTrigger]]

Tinkerer at 14:40, 19 December 2017

2017-12-19T14:40:27Z

← Older revision		Revision as of 14:40, 19 December 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* query '''ObjectIsInTrigger'''('''''[in]'''(GUIDSTRING)'''''_Object''', ''''[in]''''(TRIGGERGUID)''''_Trigger''''', [out]'''''(INTEGER)'''_Bool''')		* query '''ObjectIsInTrigger'''('''''[in]'''(GUIDSTRING)'''''_Object''', '''''[in]'''(TRIGGERGUID)'''''_Trigger''', '''''[out]'''(INTEGER)'''''_Bool''')
	===== Description =====		===== Description =====
	Returns whether '''_Object''' is inside '''_Trigger'''. It does not require that '''_Trigger''' has been registered for '''_Object'''. '''_Object''' can be a character, item, or another object such as a trigger or spline. In the non-character/item case, it will use check whether the centre/"position" (as shown in the editor) of this other object is in the trigger (it will not check whether an entire box trigger is inside the boundaries in another box trigger).		Returns whether '''_Object''' is inside '''_Trigger'''. It does not require that '''_Trigger''' has been registered for '''_Object'''. '''_Object''' can be a character, item, or another object such as a trigger or spline. In the non-character/item case, it will use check whether the centre/"position" (as shown in the editor) of this other object is in the trigger (it will not check whether an entire box trigger is inside the boundaries in another box trigger).
Line 18:		Line 18:
	* Helper [[Osiris/Shared/DB_InRegion\|DB_InRegion]]		* Helper [[Osiris/Shared/DB_InRegion\|DB_InRegion]]

	[[Category:Osiris Queries]]		[[Category:Osiris Queries\|ObjectIsInTrigger]]

Tinkerer: Mention that it fails if trigger is not in the current level

2017-10-15T16:05:19Z

Mention that it fails if trigger is not in the current level

← Older revision		Revision as of 16:05, 15 October 2017
Line 6:		Line 6:
	If '''_Object''' is an item and it is currently inside a container or a character's inventory, the query will check whether the outermost container/character is inside '''_Trigger'''.		If '''_Object''' is an item and it is currently inside a container or a character's inventory, the query will check whether the outermost container/character is inside '''_Trigger'''.
	===== Return Values =====		===== Return Values =====
	* '''Success/Failure''': Default return value.		* '''Success/Failure''': Default return value. The query will also always fail if '''_Trigger''' is not in the current level (even if the trigger is global).
	* '''_Bool''': '''1''' if '''_Object''', or its outermost container/owning character, is currently in the '''_Trigger'''.		* '''_Bool''': '''1''' if '''_Object''', or its outermost container/owning character, is currently in the '''_Trigger'''.
	===== Notes =====		===== Notes =====

Tinkerer: Documented ObjectIsInTrigger

2017-10-15T15:33:09Z

Documented ObjectIsInTrigger

New page

===== Full Definition(s) =====
* query '''ObjectIsInTrigger'''('''''[in]'''(GUIDSTRING)'''''_Object''', ''''[in]''''(TRIGGERGUID)''''_Trigger''''', [out]'''''(INTEGER)'''_Bool''')
===== Description =====
Returns whether '''_Object''' is inside '''_Trigger'''. It does not require that '''_Trigger''' has been registered for '''_Object'''. '''_Object''' can be a character, item, or another object such as a trigger or spline. In the non-character/item case, it will use check whether the centre/"position" (as shown in the editor) of this other object is in the trigger (it will not check whether an entire box trigger is inside the boundaries in another box trigger).

If '''_Object''' is an item and it is currently inside a container or a character's inventory, the query will check whether the outermost container/character is inside '''_Trigger'''.
===== Return Values =====
* '''Success/Failure''': Default return value.
* '''_Bool''': '''1''' if '''_Object''', or its outermost container/owning character, is currently in the '''_Trigger'''.
===== Notes =====
* /
===== See Also =====
* [[Osiris/API/CharacterEnteredTrigger|CharacterEnteredTrigger]]
* [[Osiris/API/CharacterLeftTrigger|CharacterLeftTrigger]]
* [[Osiris/API/ItemEnteredTrigger|ItemEnteredTrigger]]
* [[Osiris/API/ItemLeftTrigger|ItemLeftTrigger]]
* [[Osiris/API/TriggerLaunchIterator|TriggerLaunchIterator]]
* Helper [[Osiris/Shared/DB_InRegion|DB_InRegion]]

[[Category:Osiris Queries]]