Osiris/Shared/ProcBlockUseOfItem - Revision history

Tinkerer at 07:14, 14 March 2019

2019-03-14T07:14:56Z

← Older revision		Revision as of 07:14, 14 March 2019
Line 14:		Line 14:
	* This routine is also called if an NPC uses the item, not just players. Especially in case of doors or stairs, note that this can happen in reaction to an NPC fleeing out of sight.		* This routine is also called if an NPC uses the item, not just players. Especially in case of doors or stairs, note that this can happen in reaction to an NPC fleeing out of sight.
	* Setting the '''DB_CustomUseItemResponse()''' database entry will block any further handling of this use-action by generic routines in the Shared mod, such as the crime handling system. You can also carry out a number of checks and/or actions and not set '''DB_CustomUseItemResponse()'''. In this case, the default Shared mode story functionality of using an item will still be executed.		* Setting the '''DB_CustomUseItemResponse()''' database entry will block any further handling of this use-action by generic routines in the Shared mod, such as the crime handling system. You can also carry out a number of checks and/or actions and not set '''DB_CustomUseItemResponse()'''. In this case, the default Shared mode story functionality of using an item will still be executed.
	* The [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]] event is only thrown if this proc ~~allowed~~ the use of the item.		* The [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]] event is only thrown if this proc did not block the use of the item.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CanUseItem\|CanUseItem]]		* [[Osiris/API/CanUseItem\|CanUseItem]]

Tinkerer at 09:27, 28 January 2018

2018-01-28T09:27:48Z

← Older revision		Revision as of 09:27, 28 January 2018
Line 16:		Line 16:
	* The [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]] event is only thrown if this proc allowed the use of the item.		* The [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]] event is only thrown if this proc allowed the use of the item.
	===== See Also =====		===== See Also =====
			* [[Osiris/API/CanUseItem\|CanUseItem]]
	* [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]]		* [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]]

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

Tinkerer at 09:26, 28 January 2018

2018-01-28T09:26:12Z

← Older revision		Revision as of 09:26, 28 January 2018
Line 2:		Line 2:
	* PROC '''ProcBlockUseOfItem'''(''(CHARACTERGUID)'''''_Char''',''(ITEMGUID)'''''_Item''')		* PROC '''ProcBlockUseOfItem'''(''(CHARACTERGUID)'''''_Char''',''(ITEMGUID)'''''_Item''')
	===== Description =====		===== Description =====
	This procedure is called every time a character ('''_Char''') attempts to use an interactable item ('''_Item''') in the game world (in response to a ~~CanUse()~~ event sent by Osiris). As the name implies, you can overload it to dynamically block the default use action of said item, but you can also use it to completely change the way the item interaction behaves.		This procedure is called every time a character ('''_Char''') attempts to use an interactable item ('''_Item''') in the game world (in response to a [[Osiris/API/CanUseItem\|CanUseItem]] event sent by Osiris). As the name implies, you can overload it to dynamically block the default use action of said item, but you can also use it to completely change the way the item interaction behaves.

	The default implementation of this procedure is a dummy that does nothing. In order to affect the interaction with the item, you can override this procedure with your own implementation. Then, inside its body, perform the actions you wish to happen as a result of using this item (if any), and set the following DB:		The default implementation of this procedure is a dummy that does nothing. In order to affect the interaction with the item, you can override this procedure with your own implementation. Then, inside its body, perform the actions you wish to happen as a result of using this item (if any), and set the following DB:

Tinkerer at 15:00, 19 December 2017

2017-12-19T15:00:30Z

← Older revision		Revision as of 15:00, 19 December 2017
Line 18:		Line 18:
	* [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]]		* [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]]

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

Tinkerer: Link CharacterUsedItem

2017-10-17T19:19:56Z

Link CharacterUsedItem

← Older revision		Revision as of 19:19, 17 October 2017
Line 14:		Line 14:
	* This routine is also called if an NPC uses the item, not just players. Especially in case of doors or stairs, note that this can happen in reaction to an NPC fleeing out of sight.		* This routine is also called if an NPC uses the item, not just players. Especially in case of doors or stairs, note that this can happen in reaction to an NPC fleeing out of sight.
	* Setting the '''DB_CustomUseItemResponse()''' database entry will block any further handling of this use-action by generic routines in the Shared mod, such as the crime handling system. You can also carry out a number of checks and/or actions and not set '''DB_CustomUseItemResponse()'''. In this case, the default Shared mode story functionality of using an item will still be executed.		* Setting the '''DB_CustomUseItemResponse()''' database entry will block any further handling of this use-action by generic routines in the Shared mod, such as the crime handling system. You can also carry out a number of checks and/or actions and not set '''DB_CustomUseItemResponse()'''. In this case, the default Shared mode story functionality of using an item will still be executed.
			* The [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]] event is only thrown if this proc allowed the use of the item.
	===== See Also =====		===== See Also =====
	* /		* [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]]

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

Tinkerer at 21:08, 25 August 2017

2017-08-25T21:08:02Z

← Older revision		Revision as of 21:08, 25 August 2017
Line 4:		Line 4:
	This procedure is called every time a character ('''_Char''') attempts to use an interactable item ('''_Item''') in the game world (in response to a CanUse() event sent by Osiris). As the name implies, you can overload it to dynamically block the default use action of said item, but you can also use it to completely change the way the item interaction behaves.		This procedure is called every time a character ('''_Char''') attempts to use an interactable item ('''_Item''') in the game world (in response to a CanUse() event sent by Osiris). As the name implies, you can overload it to dynamically block the default use action of said item, but you can also use it to completely change the way the item interaction behaves.


	The default implementation of this procedure is a dummy that does nothing. In order to affect the interaction with the item, you can override this procedure with your own implementation. Then, inside its body, perform the actions you wish to happen as a result of using this item (if any), and set the following DB:		The default implementation of this procedure is a dummy that does nothing. In order to affect the interaction with the item, you can override this procedure with your own implementation. Then, inside its body, perform the actions you wish to happen as a result of using this item (if any), and set the following DB:


	* '''DB_CustomUseItemResponse'''(''(CHARACTERGUID)'''''_Char''',''(ITEMGUID)'''''_Item''',''(INTEGER)'''''_Result''')		* '''DB_CustomUseItemResponse'''(''(CHARACTERGUID)'''''_Char''',''(ITEMGUID)'''''_Item''',''(INTEGER)'''''_Result''')
	~~Set~~ '''_Char''' and '''_Item''' ~~to the parameters you received via the procedure call~~. ~~Set~~ '''_Result''' ~~to 1~~ if you want Osiris to perform the default action of the item after your procedure returns, or to 0 if you do not wish this to happen. Other values are undefined.		Specify the parameters received via this call as '''_Char''' and '''_Item'''. Specify '''1''' as '''_Result''' if you want Osiris to perform the default action of the item after your procedure returns, or '''0''' if you do not wish this to happen. Other result values are undefined.
	===== Return Values =====		===== Return Values =====
	* /		* /

Tinkerer: Osiris Helper Mod APIs

2017-08-08T13:56:33Z

Osiris Helper Mod APIs

New page

===== Full Definition(s) =====
* PROC '''ProcBlockUseOfItem'''(''(CHARACTERGUID)'''''_Char''',''(ITEMGUID)'''''_Item''')
===== Description =====
This procedure is called every time a character ('''_Char''') attempts to use an interactable item ('''_Item''') in the game world (in response to a CanUse() event sent by Osiris). As the name implies, you can overload it to dynamically block the default use action of said item, but you can also use it to completely change the way the item interaction behaves.

The default implementation of this procedure is a dummy that does nothing. In order to affect the interaction with the item, you can override this procedure with your own implementation. Then, inside its body, perform the actions you wish to happen as a result of using this item (if any), and set the following DB:

* '''DB_CustomUseItemResponse'''(''(CHARACTERGUID)'''''_Char''',''(ITEMGUID)'''''_Item''',''(INTEGER)'''''_Result''')
Set '''_Char''' and '''_Item''' to the parameters you received via the procedure call. Set '''_Result''' to 1 if you want Osiris to perform the default action of the item after your procedure returns, or to 0 if you do not wish this to happen. Other values are undefined.
===== Return Values =====
* /
===== Notes =====
* Use with restraint, as in general item behaviour should be systemic/consistent, and not change depending on many different conditions.
* This routine is also called if an NPC uses the item, not just players. Especially in case of doors or stairs, note that this can happen in reaction to an NPC fleeing out of sight.
* Setting the '''DB_CustomUseItemResponse()''' database entry will block any further handling of this use-action by generic routines in the Shared mod, such as the crime handling system. You can also carry out a number of checks and/or actions and not set '''DB_CustomUseItemResponse()'''. In this case, the default Shared mode story functionality of using an item will still be executed.
===== See Also =====
* /

[[Category:Osiris Shared Mod Helpers]]

← Older revision		Revision as of 09:27, 28 January 2018
Line 16:		Line 16:
	* The [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]] event is only thrown if this proc allowed the use of the item.		* The [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]] event is only thrown if this proc allowed the use of the item.
	===== See Also =====		===== See Also =====
			* [[Osiris/API/CanUseItem\|CanUseItem]]
	* [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]]		* [[Osiris/API/CharacterUsedItem\|CharacterUsedItem]]

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