A_Raise

From ZDoom Wiki
Jump to navigation Jump to search
Note: this function should not be confused with the resurrection functions which have similar naming.

void A_Raise [(int raisespeed)]

Usage

This function must be called in a weapon's Select state sequence. It should not be used anywhere else. It is responsible for raising the weapon and for entering the Ready state sequence when it is done.

Each time the function is called, the weapon moves further up the screen as it approaches the ready position. You can therefore make a weapon raise faster than the default by calling the function more than once within the same tic, or by passing the desired speed directly.


Error.gif
Warning: Do not call this function repeatedly in the same state, which is achieved by the use of a function, anonymous or otherwise. Since unlike calling the function per state, all calls to it are executed fully inside a function, even if the weapon has reached its ready position, resulting in unwanted side effects.


Parameters

  • raisespeed: how much the weapon is raised by. Default is 6.

Examples

Here is an example of a basic Select state that makes use of this function to bring the weapon up to the ready position:

Select:
   SHTG A 1 A_Raise
   Loop

This will raise the weapon up from the bottom of the screen when it is selected. Once it has reached the ready position, A_Raise will automatically jump to the Ready state.


This weapon raises into view twice as fast as normal:

Select:
   FAST A 1 A_Raise(12)
   Loop

See also