Ceiling_LowerInstant

Name

Ceiling_LowerInstant — instantly lowers selected ceilings a specified amount.

Synopsis

Ceiling_LowerInstant (tag, unused, height);

Ceiling_LowerInstant (
  tag,       // tag of affected sector(s)
  unused,    // unused
  height     // how far to lower the ceiling
);

Parameters

tag: Only sectors with this tag will move their ceilings.
unused: This is a placeholder so that Ceiling_LowerByValueTimes8 and Ceiling_LowerInstant can be used interchangeably.
height: How far to lower the ceiling. To determine the actual height the ceiling moves, this parameter is multiplied by 8.

ACS

This special's function is the same whether you activate it on a line or use it in a script.

Remarks

If more than one sector matches the specified tag, the sectors will move their ceilings independantly. If a ceiling is blocked in one sector, the other sectors will still be able to move their ceilings.

If tag is zero, then the sector on the back side of the activating line will be used.

If you want to instantly move a ceiling some distance that is not a multiple of eight, you can use Ceiling_LowerByValue with a speed equal to eight times the height:

Ceiling_LowerByValue (1, 160, 20);

Example

The following will instantly lower the ceilings in all sectors tagged 1 by 32 units. 4 is used as the height because when you divide 32 by 8, the result is 4.

Ceiling_LowerInstant (1, 0, 4);

This is equivalent to the following Ceiling_LowerByValue call:

Ceiling_LowerByValue (1, 256, 32);

First Available In

ZDoom 1.16

193:Ceiling_LowerInstant