Difference between revisions of "A WeaponReady"

From DoomWiki.org

[checked revision][checked revision]
m (External links)
(add more detail)
Line 1: Line 1:
 
{{DISPLAYTITLE:A_WeaponReady}}
 
{{DISPLAYTITLE:A_WeaponReady}}
{{stub}}
 
 
'''A_WeaponReady''' is a [[code pointer]] used in the normal weapon animation for all weapons.
 
'''A_WeaponReady''' is a [[code pointer]] used in the normal weapon animation for all weapons.
 +
 +
<code>A_WeaponReady</code> is used in every weapon's idle/weapon bobbing sequence; most weapons (with the exception of the chainsaw) have an idle sequence that simply calls this code pointer every [[tic]]. The function performs a number of different actions:
 +
 +
* If the player's attack button is held down, it begins the firing animation for the current weapon. For this reason, if the player is switching weapons, pressing fire will do nothing until the weapon raise sequence has completed and <code>A_WeaponReady</code> is called.
 +
 +
* If the player is selecting a new weapon, begins the weapon lower sequence to switch to the new weapon. For this reason, if the player tries to switch to a new weapon while firing their current weapon, the change will not begin until the current firing sequence has completed and <code>A_WeaponReady</code> is called.
 +
 +
* If the player's avatar is in state <code>S_PLAY_ATK1</code> (Dehacked frame 154) or <code>S_PLAY_ATK2</code> (frame 155), transitions to <code>S_PLAY</code> (frame 149). This ensures that once a player stops firing, other players in a multiplayer game see their
 +
avatar stop firing.
 +
 +
* Performs the weapon "bobbing" effect. As a result, because the chainsaw only calls <code>A_WeaponReady</code> once every four tics, its bobbing is visibly less smooth than other weapons.
 +
 +
* If the chainsaw is equipped, the DSSAWIDL sound effect is played.
  
 
== Uses ==
 
== Uses ==

Revision as of 19:12, 21 March 2020

A_WeaponReady is a code pointer used in the normal weapon animation for all weapons.

A_WeaponReady is used in every weapon's idle/weapon bobbing sequence; most weapons (with the exception of the chainsaw) have an idle sequence that simply calls this code pointer every tic. The function performs a number of different actions:

  • If the player's attack button is held down, it begins the firing animation for the current weapon. For this reason, if the player is switching weapons, pressing fire will do nothing until the weapon raise sequence has completed and A_WeaponReady is called.
  • If the player is selecting a new weapon, begins the weapon lower sequence to switch to the new weapon. For this reason, if the player tries to switch to a new weapon while firing their current weapon, the change will not begin until the current firing sequence has completed and A_WeaponReady is called.
  • If the player's avatar is in state S_PLAY_ATK1 (Dehacked frame 154) or S_PLAY_ATK2 (frame 155), transitions to S_PLAY (frame 149). This ensures that once a player stops firing, other players in a multiplayer game see their

avatar stop firing.

  • Performs the weapon "bobbing" effect. As a result, because the chainsaw only calls A_WeaponReady once every four tics, its bobbing is visibly less smooth than other weapons.
  • If the chainsaw is equipped, the DSSAWIDL sound effect is played.

Uses

The A_WeaponReady code pointer appears in the following states in Doom's state table:

Example

The following is an example of how to set the A_WeaponReady code pointer in a Dehacked file:

Pointer 21 (Frame 34)
Codep Frame = 81

Or using BEX syntax:

[CODEPTR]
Frame 1234 = WeaponReady

External links