Difference between revisions of "GetEquippedWeapon - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Rhavlovick
m (1 revision: Clobber re-import by Henning)
 
imported>Chesko
(Cleaned up grammar in Parameters section.)
 
(4 intermediate revisions by 2 users not shown)
Line 11: Line 11:


== Parameters ==
== Parameters ==
*abLeftHand: The get the weapon from the left hand.
*abLeftHand: If true, will return the weapon equipped in the actor's left hand. If false, will return the right-hand weapon instead.
**'''Default''': false - The default will use the actors right hand.
**'''Default''': False


== Return Value ==
== Return Value ==
Line 31: Line 31:
endIf
endIf
</source>
</source>
== See Also ==
== See Also ==
*[[Actor Script]]
*[[Actor Script]]
*[[EquipItem - Actor]]
*[[EquipItem - Actor]]
*[[GetEquippedShield - Actor]]

Latest revision as of 07:46, 6 September 2012

Member of: Actor Script

Gets the actor's currently equipped weapon.

Syntax[edit | edit source]

Weapon Function GetEquippedWeapon(bool abLeftHand = false) native

Parameters[edit | edit source]

  • abLeftHand: If true, will return the weapon equipped in the actor's left hand. If false, will return the right-hand weapon instead.
    • Default: False

Return Value[edit | edit source]

The Weapon the actor currently has equipped.

Examples[edit | edit source]

; Does the player have the uber dagger equipped in their right hand?
if (Game.GetPlayer().GetEquippedWeapon() == UberDagger)
  Debug.Trace("Player has uber-dagger equipped in their right hand")
endIf


; Does the player have the wimpy sword equipped in their left hand?
if (Game.GetPlayer().GetEquippedWeapon(true) == WimpyDagger)
  Debug.Trace("Player has wimpy sword in their left hand")
endIf

See Also[edit | edit source]