ForceWeaponJamAnim
From GECK
A function added by the ShowOff NVSE Plugin version 1.17.
Contents
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
(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
- GetWeaponAnimJamTime
- GetWeaponHasFlag - "No Jam After Reload" flag may be of interest, though it has no impact on this function.
- fWeaponConditionReloadJamXX
- fWeaponConditionJamXX
