ForceWeaponJamAnim

From GECK
(Redirected from ForceJamAnim)
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin version 1.17.

Description

Attempts to force the calling actor to play the jam animation for their drawn-out Weapon. Returns true (1) for success, false (0) for failure.

Syntax

[help]
(success:bool) actorRefr.ForceWeaponJamAnim 

Or:

(success:bool) actorRefr.ForceJamAnim

Example

player.ForceJamAnim

Will attempt to force the player to play the "weapon jammed" animation, assuming they have a weapon out that has such an animation.

Notes

  • Will do nothing if the weapon does not have a jam animation. For example, in unmodded New Vegas, the .357 Magnum Revolver cannot jam at all.
  • Interrupts the player's current hand animation. For example, if this function is called in the middle of an actor reloading their weapon, that reloading action gets cancelled and a new one replaces it.

See Also