Osiris/API/ObjectEnteredCombat - Revision history

Tinkerer at 14:14, 19 December 2017

2017-12-19T14:14:53Z

← Older revision		Revision as of 14:14, 19 December 2017
Line 17:		Line 17:
	* Helper [[Osiris/Shared/DB_WasInCombat\|DB_WasInCombat]]		* Helper [[Osiris/Shared/DB_WasInCombat\|DB_WasInCombat]]

	[[Category:Osiris Events]]		[[Category:Osiris Events\|ObjectEnteredCombat]]

Tinkerer: reference DB_CombatCharacters/DB_WasInCombat

2017-09-14T20:04:53Z

reference DB_CombatCharacters/DB_WasInCombat

← Older revision		Revision as of 20:04, 14 September 2017
Line 14:		Line 14:
	* [[Osiris/API/ObjectLeftCombat\|ObjectLeftCombat]]		* [[Osiris/API/ObjectLeftCombat\|ObjectLeftCombat]]
	* [[Osiris/API/ObjectReadyInCombat\|ObjectReadyInCombat]]		* [[Osiris/API/ObjectReadyInCombat\|ObjectReadyInCombat]]
			* Helper [[Osiris/Shared/DB_CombatCharacters\|DB_CombatCharacters]]
			* Helper [[Osiris/Shared/DB_WasInCombat\|DB_WasInCombat]]

	[[Category:Osiris Events]]		[[Category:Osiris Events]]

Tinkerer at 08:47, 13 September 2017

2017-09-13T08:47:51Z

← Older revision		Revision as of 08:47, 13 September 2017
Line 8:		Line 8:
	===== Notes =====		===== Notes =====
	* This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.		* This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
	* ~~If the~~ combat ~~is still being set up,~~ not ~~all information may be available~~ yet ~~(e.g~~.~~, other initial objects may still be added after this one), and~~ you cannot use APIs such as ~~'''~~JumpToTurn~~''' yet~~. ~~If you wish~~ to ~~perform some action when~~ a combat ~~has completely started, use '''CombatStarted''' instead~~. ~~Note~~ that if the combat ~~had already been fully setup before (i~~.~~e., a~~ [[Osiris/API/~~CombatStarted~~\|~~CombatStarted~~]] ~~even was already thrown~~ for ~~this combat in the past), no new~~ [[Osiris/API/~~CombatStarted~~\|~~CombatStarted~~]] ~~event will be thrown due to this object entering~~.		* When this event gets thrown, this object's combat setup has not yet fully finished. This means you cannot yet use APIs such as [[Osiris/API/JumpToTurn\|JumpToTurn]] on them. You can only use it to react in general to the object getting involved in a combat (e.g. to change alignments so that others join the combat as well).
			* See [[Osiris/API/ObjectReadyInCombat\|ObjectReadyInCombat]] for an explanation about when you can use [[Osiris/API/JumpToTurn\|JumpToTurn]].
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CombatStarted\|CombatStarted]]		* [[Osiris/API/CombatStarted\|CombatStarted]]
	* [[Osiris/API/ObjectLeftCombat\|ObjectLeftCombat]]		* [[Osiris/API/ObjectLeftCombat\|ObjectLeftCombat]]
			* [[Osiris/API/ObjectReadyInCombat\|ObjectReadyInCombat]]

	[[Category:Osiris Events]]		[[Category:Osiris Events]]

Tinkerer at 13:00, 25 August 2017

2017-08-25T13:00:13Z

← Older revision		Revision as of 13:00, 25 August 2017
Line 8:		Line 8:
	===== Notes =====		===== Notes =====
	* This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.		* This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
	* If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as '''JumpToTurn''' yet. If you wish to perform some action when a combat has completely started, use '''CombatStarted''' instead.		* If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as '''JumpToTurn''' yet. If you wish to perform some action when a combat has completely started, use '''CombatStarted''' instead. Note that if the combat had already been fully setup before (i.e., a [[Osiris/API/CombatStarted\|CombatStarted]] even was already thrown for this combat in the past), no new [[Osiris/API/CombatStarted\|CombatStarted]] event will be thrown due to this object entering.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CombatStarted]]		* [[Osiris/API/CombatStarted\|CombatStarted]]
	* [[Osiris/API/ObjectLeftCombat]]		* [[Osiris/API/ObjectLeftCombat\|ObjectLeftCombat]]

	[[Category:Osiris Events]]		[[Category:Osiris Events]]

Tinkerer: Osiris Core APIs

2017-08-08T13:52:36Z

Osiris Core APIs

New page

===== Full Definition(s) =====
* event '''ObjectEnteredCombat'''(''(GUIDSTRING)'''''_Object''', ''(INTEGER)'''''_CombatID''')
===== Description =====
Thrown when an object (character or item) enters a combat.
===== Parameters =====
* '''_Object''': The object that has entered the combat
* '''_CombatID''': A handle that identifies the combat. Should always be > 0.
===== Notes =====
* This can be a combat that is still being set up, or an existing combat joined by a character that wandered too close.
* If the combat is still being set up, not all information may be available yet (e.g., other initial objects may still be added after this one), and you cannot use APIs such as '''JumpToTurn''' yet. If you wish to perform some action when a combat has completely started, use '''CombatStarted''' instead.
===== See Also =====
* [[Osiris/API/CombatStarted]]
* [[Osiris/API/ObjectLeftCombat]]

[[Category:Osiris Events]]