LarIlya at 14:24, 18 December 2017

2017-12-18T14:24:31Z

← Older revision		Revision as of 14:24, 18 December 2017
Line 1:		Line 1:
	~~'''WIP'''~~
	== Overview ==		== Overview ==
	In the item [[sidebar]], there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike.		In the item [[sidebar]], there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike.
Line 36:		Line 35:
	<br>		<br>
	'''CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])''' checks if a character is capable of using an item in their inventory.		'''CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])''' checks if a character is capable of using an item in their inventory.

			== Use Description ==
			Use actions have a default use action name that shows up in the context menu (on right-click). It is possible to override this by filling in the '''Use Description''', so that e.g. a lever may be Pulled instead of Used, or a button may be Pushed.

LarIlya at 15:57, 4 December 2017

2017-12-04T15:57:15Z

← Older revision		Revision as of 15:57, 4 December 2017
Line 1:		Line 1:
			'''WIP'''
	== Overview ==		== Overview ==
	In the item [[sidebar]], there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike.		In the item [[sidebar]], there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike.

LarIlya: Created page with "== Overview == In the item sidebar, there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike. == Things that block use of..."

2017-12-04T13:58:40Z

Created page with "== Overview == In the item sidebar, there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike. == Things that block use of..."

New page

== Overview ==
In the item [[sidebar]], there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike.

== Things that block use of items ==
A character cannot use an item if any of the following is true:
* the item has been marked as [[Osiris/API/ItemSetOnlyOwnerCanUse|only usable by its owner]], and '''_Character''' is not its owner.
* the item is ''stuck''. An item is ''stuck'' if it has the '''FROZEN''' or '''PETRIFIED''' status.
* the item is locked and '''_Character''', nor anyone in their party in case of a player character, has the key.
Also (see below), players cannot use items if they are set to non-interactable.

== Interaction with Osiris ==
Osiris scripting can react to items being used, make characters use items, and intercept attempts to use an items. For more details on each call and event, see its documentation.
=== Events to Osiris ===
Whenever a character interacts with an item, a [[Osiris/API/CharacterUseItem|CharacterUsedItem]] event is sent to Osiris.
 
If the character fails to use the item, a [[Osiris/API/CharacterUsedItemFailed|CharacterUsedItemFailed]] event is sent to Osiris.
 
The [[Osiris/API/CanUseItem|CanUseItem]] event is sent as a character attempts to use an item. The Shared Story scripting intercepts this to call the [[Osiris/Shared/ProcBlockUseOfItem|ProcBlockUseOfItem]] procedure. If this procedure sets the '''DB_CustomUseItemResponse'''(''(CHARACTERGUID)'''''_Char''',''(ITEMGUID)'''''_Item''',''(INTEGER)'''''_Result''') with '''_Result''' equal to 1, the item use is blocked.

=== Calls from Osiris ===
The [[Osiris/API/CharacterUseItem|CharacterUseItem]] call makes a character use an item. If necessary, the character first moves to the item.
 
The [[Osiris/API/ItemSetCanInteract|ItemSetCanInteract]] makes it impossible for players to interact with an item by clicking on it. It remains possible to interact with the item through script, however.

== Interaction with Behaviour Script ==
[[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour script]] can react to items being used and make character use items.
=== Events to Behaviour Script ===
'''OnUseItem(CHARACTER:source, ITEM:item)''' is thrown when a character uses an item.
=== Calls from Behaviour Script ===
'''CharacterUseItem(ITEM:item [, INTEGER:LongPath])''' makes a character use an item, moving to it if necessary.
 
'''ItemSetCanInteract(ITEM:item, INTEGER:bool)''' changes whether or not an item can be interacted with by the player. Script can still make a character interact with such an item.
=== Queries from Behaviour Script ===
'''CharacterCanUseItem(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])''' checks if a character is capable of using an item in the world.
 
'''CharacterCanUseItemInInventory(CHARACTER:source, ITEM:item[, INT:ignoreActionPoints=0])''' checks if a character is capable of using an item in their inventory.

Category:Use Actions - Revision history

LarIlya at 14:24, 18 December 2017

LarIlya at 15:57, 4 December 2017

LarIlya: Created page with "== Overview == In the item sidebar, there is a "Use Actions" entry. This defines what interaction with the item does, for NPCs and PCs alike. == Things that block use of..."