Func_beam commands
 
Specific commands for the func_beam entity. The func_beam entity is a subclass of scriptslave entities, it also responds to many entity, trigger and scriptslave commands (gameX86 source code reference: specialfx.cpp).

Specific entity commands are colored in brown in my custom SinScript syntax coloring wordfile for UltraEdit32.


activate
 
Function
 
This turns on the beam.

Syntax
 
$<beam_name> activate

Notes & examples
 
A beam can be turned off with the deactivate command.


alpha  
 
Function
 
This sets the translucency of the beam.

Syntax
 
$<beam_name> alpha <value>

Notes & examples
 
The values are from 0.0 to 1.0 : 0 is completely invisible and 1.0 is 100% opaque. This command overrides the value of the entity's "alpha" key.


beamstyle  
 
Function
 
This sets the style of the beam.

Syntax
 
$<beam_name> beamstyle <style_number>

Notes & examples
 
This command overrides the value of the entity's "beamstyle" key. For a list of possible style numbers, refer to the docs of the func_beam entity.

Note:
This command only works if the entity's "model" key is not set.



color  
 
Function
 
This sets the color of the beam.

Syntax
 
$<beam_name> color "<R G B>"

Notes & examples
 
This command overrides the value of the entity's "color" key.

Note:
This command doesn't work if the entity's "beamstyle" or "model" key is set.



deactivate
 
Function
 
This turns off the beam.

Syntax
 
$<beam_name> deactivate

Notes & examples
 
A beam can be turned off with the activate command.


diameter  
 
Function
 
This sets the diameter of the beam.

Syntax
 
$<beam_name> diameter <value>

Notes & examples
 
This command overrides the value of the entity's "diameter" key.

Note:
This command only works if the entity's "model" key is not set.



maxoffset  
 
Function
 
This sets the amount of electrical variation at the endpoints of the beam.

Syntax
 
$<beam_name> maxoffset <value>

Notes & examples
 
This command overrides the value of the entity's "maxoffset" key.

Note:
This command only works if the entity's "model" key and ELECTRIC spawnflag are set.



minoffset  
 
Function
 
This sets the amount of electrical variation in the middle of the beam.

Syntax
 
$<beam_name> minoffset <value>

Notes & examples
 
This command overrides the value of the entity's "minoffset" key.

Note:
This command only works if the entity's "model" key and ELECTRIC spawnflag are set.