Difference between revisions of "Osiris/API/CharacterUseItem"

Revision as of 15:39, 24 November 2017

Full Definition(s)

• call CharacterUseItem((CHARACTERGUID)_Character, (ITEMGUID)_Item, (STRING)_Event)

Description

Makes _Character, which can either be a player character or an NPC, use _Item. If _Item is not in _Character's inventory, _Character will first walk to it if they're too far. Once they have used _Item, the story event _Event will be sent to _Character.

Notes

• Using an item results in the following flow:
  • Walk to the item, if necessary.
  • If the item is reachable by the character after trying to move to it,
    • A CanUseItem event is sent to story.
    • Story replies using RequestProcessed, which indicates whether the use should fail or succeed. You can hook into this and the previous step in a generic way using Helper ProcBlockUseOfItem.
  • If the item was reachable and using it failed, or was blocked using the above, then a CharacterUsedItemFailed event is thrown.
  • If the item was _not_ reachable, or using it was successful, a CharacterUsedItem event is thrown, as well as a CharacterUsedItemTemplate event.
  • Regardless of whether a CharacterUsedItemFailed or CharacterUsedItem event was thrown, finally a CharacterStoppedUsingItem event indicates when the item is no longer used (happens immediately in case of failure).
• If the item usage fails, _Event will never be thrown.
• _Item can be a consumable or an item in the world.

See Also

• CanUseItem
• CharacterUsedItem
• CharacterUsedItemTemplate
• CharacterUsedItemFailed
• CharacterStoppedUsingItem
• HasActiveStatus
• ItemStatusAttempt
• ItemStatusChange
• RequestProcessed
• StoryEvent
• Helper ProcBlockUseOfItem