Osiris/API/ApplyStatus - Revision history

Tinkerer at 13:17, 7 June 2019

2019-06-07T13:17:48Z

← Older revision		Revision as of 13:17, 7 June 2019
Line 24:		Line 24:
	* [[Osiris/API/ItemStatusChange\|ItemStatusChange]]		* [[Osiris/API/ItemStatusChange\|ItemStatusChange]]
	* [[Osiris/API/ItemStatusRemoved\|ItemStatusRemoved]]		* [[Osiris/API/ItemStatusRemoved\|ItemStatusRemoved]]
			* [[Osiris/API/RemoveHarmfulStatuses\|RemoveHarmfulStatuses]]
			* [[Osiris/API/RemoveStatus\|RemoveStatus]]

	[[Category:Osiris Calls\|ApplyStatus]]		[[Category:Osiris Calls\|ApplyStatus]]

Tinkerer at 08:57, 10 September 2018

2018-09-10T08:57:07Z

← Older revision		Revision as of 08:57, 10 September 2018
Line 14:		Line 14:
	** ignore physical armor, which normally blocks '''KNOCKED_DOWN'''		** ignore physical armor, which normally blocks '''KNOCKED_DOWN'''
	** not apply the '''KNOCKED_DOWN''' status, but instead remove the '''RESTED''' status (since that status and '''KNOCKED_DOWN''' cancel each other out)		** not apply the '''KNOCKED_DOWN''' status, but instead remove the '''RESTED''' status (since that status and '''KNOCKED_DOWN''' cancel each other out)
			* The duration of a single combat round is 6.0 seconds
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterStatusApplied\|CharacterStatusApplied]]		* [[Osiris/API/CharacterStatusApplied\|CharacterStatusApplied]]

Tinkerer at 13:51, 19 December 2017

2017-12-19T13:51:33Z

← Older revision		Revision as of 13:51, 19 December 2017
Line 24:		Line 24:
	* [[Osiris/API/ItemStatusRemoved\|ItemStatusRemoved]]		* [[Osiris/API/ItemStatusRemoved\|ItemStatusRemoved]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls\|ApplyStatus]]

Tinkerer at 10:32, 8 December 2017

2017-12-08T10:32:28Z

← Older revision		Revision as of 10:32, 8 December 2017
Line 8:		Line 8:
	If '''_Force''' is '''1''', normal status immunities are ignored (e.g., a status that is normally blocked by physical armour, can be force-applied to ignore the fact that the target may have physical armour left). If it is '''0''', normal status immunities apply.		If '''_Force''' is '''1''', normal status immunities are ignored (e.g., a status that is normally blocked by physical armour, can be force-applied to ignore the fact that the target may have physical armour left). If it is '''0''', normal status immunities apply.

	(New parameter in DOS2 Patch 5) '''_Source''' specifies the object, either a character or item, that the game should consider as the source of this status effect. This is mainly useful for scripted skill applications, where you want '''_Object''' to react as if '''_Source''' applied this status. You can pass '''NULL_00000000-0000-0000-0000-000000000000''' if there is no specific source.		''(New parameter in DOS2 Patch 5)'' '''_Source''' specifies the object, either a character or item, that the game should consider as the source of this status effect. This is mainly useful for scripted skill applications, where you want '''_Object''' to react as if '''_Source''' applied this status. You can pass '''NULL_00000000-0000-0000-0000-000000000000''' if there is no specific source.
	===== Notes =====		===== Notes =====
	* The overloads in the Shared mod use the defaults '''_Force''' = '''0''', and '''_Source''' = '''NULL_00000000-0000-0000-0000-000000000000'''.		* The overloads in the Shared mod use the defaults '''_Force''' = '''0''', and '''_Source''' = '''NULL_00000000-0000-0000-0000-000000000000'''.

Tinkerer at 16:20, 6 December 2017

2017-12-06T16:20:23Z

← Older revision		Revision as of 16:20, 6 December 2017
Line 10:		Line 10:
	(New parameter in DOS2 Patch 5) '''_Source''' specifies the object, either a character or item, that the game should consider as the source of this status effect. This is mainly useful for scripted skill applications, where you want '''_Object''' to react as if '''_Source''' applied this status. You can pass '''NULL_00000000-0000-0000-0000-000000000000''' if there is no specific source.		(New parameter in DOS2 Patch 5) '''_Source''' specifies the object, either a character or item, that the game should consider as the source of this status effect. This is mainly useful for scripted skill applications, where you want '''_Object''' to react as if '''_Source''' applied this status. You can pass '''NULL_00000000-0000-0000-0000-000000000000''' if there is no specific source.
	===== Notes =====		===== Notes =====
	* The overloads in the Shared mod ~~for~~ use the defaults '''_Force''' = '''0''', and '''_Source''' = '''NULL_00000000-0000-0000-0000-000000000000'''.		* The overloads in the Shared mod use the defaults '''_Force''' = '''0''', and '''_Source''' = '''NULL_00000000-0000-0000-0000-000000000000'''.
	* Even when using '''_Force''' == 1, '''_Object''' may not actually have '''_Status''' after calling this routine, because another status may nullify this one. E.g., if a character has the '''RESTED''' status and you force-apply '''KNOCKED_DOWN''', then this application will		* Even when using '''_Force''' == 1, '''_Object''' may not actually have '''_Status''' after calling this routine, because another status may nullify this one. E.g., if a character has the '''RESTED''' status and you force-apply '''KNOCKED_DOWN''', then this application will
	** ignore physical armor, which normally blocks '''KNOCKED_DOWN'''		** ignore physical armor, which normally blocks '''KNOCKED_DOWN'''

Tinkerer at 07:37, 27 November 2017

2017-11-27T07:37:33Z

← Older revision		Revision as of 07:37, 27 November 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
			* (Shared mod) call '''ApplyStatus'''(''(GUIDSTRING)'''''_Object''', ''(STRING)'''''_Status''', ''(REAL)'''''_Duration''')
			* (Shared mod) call '''ApplyStatus'''(''(GUIDSTRING)'''''_Object''', ''(STRING)'''''_Status''', ''(REAL)'''''_Duration''', ''(INTEGER)'''''_Force''')
	* call '''ApplyStatus'''(''(GUIDSTRING)'''''_Object''', ''(STRING)'''''_Status''', ''(REAL)'''''_Duration''', ''(INTEGER)'''''_Force''', ''(GUIDSTRING)'''''_Source''')		* call '''ApplyStatus'''(''(GUIDSTRING)'''''_Object''', ''(STRING)'''''_Status''', ''(REAL)'''''_Duration''', ''(INTEGER)'''''_Force''', ''(GUIDSTRING)'''''_Source''')
	===== Description =====		===== Description =====
Line 6:		Line 8:
	If '''_Force''' is '''1''', normal status immunities are ignored (e.g., a status that is normally blocked by physical armour, can be force-applied to ignore the fact that the target may have physical armour left). If it is '''0''', normal status immunities apply.		If '''_Force''' is '''1''', normal status immunities are ignored (e.g., a status that is normally blocked by physical armour, can be force-applied to ignore the fact that the target may have physical armour left). If it is '''0''', normal status immunities apply.

	'''_Source''' specifies the object, either a character or item, that the game should consider as the source of this status effect. This is mainly useful for scripted skill applications, where you want '''_Object''' to react as if '''_Source''' applied this status. You can pass '''NULL_00000000-0000-0000-0000-000000000000''' if there is no specific source.		(New parameter in DOS2 Patch 5) '''_Source''' specifies the object, either a character or item, that the game should consider as the source of this status effect. This is mainly useful for scripted skill applications, where you want '''_Object''' to react as if '''_Source''' applied this status. You can pass '''NULL_00000000-0000-0000-0000-000000000000''' if there is no specific source.
	===== Notes =====		===== Notes =====
	* The ~~'''_Source''' parameter is new in DOS2 Patch 5.~~		* The overloads in the Shared mod for use the defaults '''_Force''' = '''0''', and '''_Source''' = '''NULL_00000000-0000-0000-0000-000000000000'''.
	* There are overloads in the ~~shared~~ mod for ~~this call without~~ the '''_Force''' ~~and/or~~ '''~~_Source~~''' ~~parameters for backwards compatibility. They use the defaults~~ '''0''' ~~and~~ '''NULL_00000000-0000-0000-0000-000000000000'''~~, respectively~~.
	* Even when using '''_Force''' == 1, '''_Object''' may not actually have '''_Status''' after calling this routine, because another status may nullify this one. E.g., if a character has the '''RESTED''' status and you force-apply '''KNOCKED_DOWN''', then this application will		* Even when using '''_Force''' == 1, '''_Object''' may not actually have '''_Status''' after calling this routine, because another status may nullify this one. E.g., if a character has the '''RESTED''' status and you force-apply '''KNOCKED_DOWN''', then this application will
	** ignore physical armor, which normally blocks '''KNOCKED_DOWN'''		** ignore physical armor, which normally blocks '''KNOCKED_DOWN'''
	** not apply the '''KNOCKED_DOWN''' status, but instead remove the '''RESTED''' status (since that status ~~blocks~~ '''KNOCKED_DOWN''')		** not apply the '''KNOCKED_DOWN''' status, but instead remove the '''RESTED''' status (since that status and '''KNOCKED_DOWN''' cancel each other out)
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterStatusApplied\|CharacterStatusApplied]]		* [[Osiris/API/CharacterStatusApplied\|CharacterStatusApplied]]

Tinkerer at 07:32, 27 November 2017

2017-11-27T07:32:54Z

← Older revision		Revision as of 07:32, 27 November 2017
Line 2:		Line 2:
	* call '''ApplyStatus'''(''(GUIDSTRING)'''''_Object''', ''(STRING)'''''_Status''', ''(REAL)'''''_Duration''', ''(INTEGER)'''''_Force''', ''(GUIDSTRING)'''''_Source''')		* call '''ApplyStatus'''(''(GUIDSTRING)'''''_Object''', ''(STRING)'''''_Status''', ''(REAL)'''''_Duration''', ''(INTEGER)'''''_Force''', ''(GUIDSTRING)'''''_Source''')
	===== Description =====		===== Description =====
	Applies the status with name '''_Status''' to '''_Object''', which can either be a character or an item. The status will last for '''_Duration''' seconds. If '''_Duration''' is -1.0, it will last until explicitly removed by either script or another status/effect interaction (e.g. a permanent '''BURNING''' status can still be removed by making the object '''WET''').		Applies the status with stats name '''_Status''' to '''_Object''', which can either be a character or an item. The status will last for '''_Duration''' seconds. If '''_Duration''' is -1.0, it will last until explicitly removed by either script or another status/effect interaction (e.g. a permanent '''BURNING''' status can still be removed by making the object '''WET''').

	If '''_Force''' is '''1''', normal status immunities are ignored (e.g., a status that is normally blocked by physical armour, can be force-applied to ignore the fact that the target may have physical armour left). If it is '''0''', normal status immunities apply.		If '''_Force''' is '''1''', normal status immunities are ignored (e.g., a status that is normally blocked by physical armour, can be force-applied to ignore the fact that the target may have physical armour left). If it is '''0''', normal status immunities apply.

Tinkerer: Link CharacterUseSkill

2017-11-26T13:03:04Z

Link CharacterUseSkill

← Older revision		Revision as of 13:03, 26 November 2017
Line 17:		Line 17:
	* [[Osiris/API/CharacterStatusAttempt\|CharacterStatusAttempt]]		* [[Osiris/API/CharacterStatusAttempt\|CharacterStatusAttempt]]
	* [[Osiris/API/CharacterStatusRemoved\|CharacterStatusRemoved]]		* [[Osiris/API/CharacterStatusRemoved\|CharacterStatusRemoved]]
			* [[Osiris/API/CharacterUseSkill\|CharacterUseSkill]]
	* [[Osiris/API/HasActiveStatus\|HasActiveStatus]]		* [[Osiris/API/HasActiveStatus\|HasActiveStatus]]
	* [[Osiris/API/ItemStatusAttempt\|ItemStatusAttempt]]		* [[Osiris/API/ItemStatusAttempt\|ItemStatusAttempt]]

Tinkerer: Documented ApplyStatus

2017-11-24T12:45:44Z

Documented ApplyStatus

New page

===== Full Definition(s) =====
* call '''ApplyStatus'''(''(GUIDSTRING)'''''_Object''', ''(STRING)'''''_Status''', ''(REAL)'''''_Duration''', ''(INTEGER)'''''_Force''', ''(GUIDSTRING)'''''_Source''')
===== Description =====
Applies the status with name '''_Status''' to '''_Object''', which can either be a character or an item. The status will last for '''_Duration''' seconds. If '''_Duration''' is -1.0, it will last until explicitly removed by either script or another status/effect interaction (e.g. a permanent '''BURNING''' status can still be removed by making the object '''WET''').

If '''_Force''' is '''1''', normal status immunities are ignored (e.g., a status that is normally blocked by physical armour, can be force-applied to ignore the fact that the target may have physical armour left). If it is '''0''', normal status immunities apply.

'''_Source''' specifies the object, either a character or item, that the game should consider as the source of this status effect. This is mainly useful for scripted skill applications, where you want '''_Object''' to react as if '''_Source''' applied this status. You can pass '''NULL_00000000-0000-0000-0000-000000000000''' if there is no specific source.
===== Notes =====
* The '''_Source''' parameter is new in DOS2 Patch 5.
* There are overloads in the shared mod for this call without the '''_Force''' and/or '''_Source''' parameters for backwards compatibility. They use the defaults '''0''' and '''NULL_00000000-0000-0000-0000-000000000000''', respectively.
* Even when using '''_Force''' == 1, '''_Object''' may not actually have '''_Status''' after calling this routine, because another status may nullify this one. E.g., if a character has the '''RESTED''' status and you force-apply '''KNOCKED_DOWN''', then this application will
** ignore physical armor, which normally blocks '''KNOCKED_DOWN'''
** not apply the '''KNOCKED_DOWN''' status, but instead remove the '''RESTED''' status (since that status blocks '''KNOCKED_DOWN''')
===== See Also =====
* [[Osiris/API/CharacterStatusApplied|CharacterStatusApplied]]
* [[Osiris/API/CharacterStatusAttempt|CharacterStatusAttempt]]
* [[Osiris/API/CharacterStatusRemoved|CharacterStatusRemoved]]
* [[Osiris/API/HasActiveStatus|HasActiveStatus]]
* [[Osiris/API/ItemStatusAttempt|ItemStatusAttempt]]
* [[Osiris/API/ItemStatusChange|ItemStatusChange]]
* [[Osiris/API/ItemStatusRemoved|ItemStatusRemoved]]

[[Category:Osiris Calls]]