Difference between revisions of "IsEquipped - Actor"
Jump to navigation
Jump to search
imported>Rhavlovick m (1 revision: Clobber re-import by Henning) |
imported>Chesko |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 11: | Line 11: | ||
== Parameters == | == Parameters == | ||
*akItem: The item to check for. | *akItem: The item to check for. If a FormList, checks if any form in the list is equipped. | ||
== Return Value == | == Return Value == | ||
| Line 23: | Line 23: | ||
endIf | endIf | ||
</source> | </source> | ||
== Notes == | |||
* Specifying a light that can be carried (e.g., torches) as akItem will always return false no matter if the light is equipped or not. To determine if the actor has a light equipped, use [[GetEquippedItemType - Actor|GetEquippedItemType()]]. Light forms will send [[OnObjectEquipped - Actor|OnObjectEquipped()]] events, however. | |||
* This function doesn't check the left hand when a character is dual wielding. See [[Talk:IsEquipped - Actor]] for an alternative. | |||
== See Also == | == See Also == | ||
*[[Actor Script]] | *[[Actor Script]] | ||
*[[EquipItem - Actor]] | *[[EquipItem - Actor]] | ||
Latest revision as of 20:31, 5 November 2016
Member of: Actor Script
Does the actor have the specified item equipped?
Syntax[edit | edit source]
bool Function IsEquipped(Form akItem) nativeParameters[edit | edit source]
- akItem: The item to check for. If a FormList, checks if any form in the list is equipped.
Return Value[edit | edit source]
If the actor has the item equipped or not.
Examples[edit | edit source]
; Does the player have the uber sword equipped?
if (Game.GetPlayer().IsEquipped(UberSwordProperty))
Debug.Trace("The player has the uber sword equipped")
endIfNotes[edit | edit source]
- Specifying a light that can be carried (e.g., torches) as akItem will always return false no matter if the light is equipped or not. To determine if the actor has a light equipped, use GetEquippedItemType(). Light forms will send OnObjectEquipped() events, however.
- This function doesn't check the left hand when a character is dual wielding. See Talk:IsEquipped - Actor for an alternative.