Spotlight behavior

INI reference·Enums·LightBehaviorType

Modes a structure's spotlight beam runs in, from sweeping an arc to standing still and undrawn.

Engine enum

LightBehaviorType

Input form

Integer

Follow drops back to Sweep the moment its quarry dies or moves beyond SpotlightMovementRadius, which makes it a temporary state rather than a standing one; a beam is given Sweep when its structure is placed, so 0 is only ever reached by a map or a trigger asking for it. Which of the modes runs the intruder scan, and when, is covered by SpotlightRadius.

A value outside the four is drawn but never moves

The four modes are the whole of this domain and no branch of the beam logic answers to anything else. A beam holding a figure above 3, or a negative one, is still visible, since only 0 suppresses the drawing, but nothing moves it and nothing scans from it, so it sits over one spot until something sets its behavior again.

Values

Filter values

4 of 4

Input	Meaning	Engine constant	Stored value
0	Beam held in place and not drawn at all.	LIGHT_BEHAVIOR_NONE	0
1	Sweep the beam back and forth across an arc centered on the structure's facing.	LIGHT_BEHAVIOR_SWEEP	1
2	Carry the beam around the structure at a constant rate.	LIGHT_BEHAVIOR_CIRCLE	2
3	Track the nearest enemy soldier or vehicle standing where the beam sat when the mode was set.	LIGHT_BEHAVIOR_FOLLOW	3

Used by

• Change Light Behavior TACTION_CHANGE_SPOTLIGHT_BEHAVIOR

Related resources

• Change Light BehaviorTrigger action
• Enemy In Spotlight...Trigger event

Source files

Linked at revision 59fae722af8c.

• code/blight.hh
• code/blight.cpp
• code/building.cpp

Page feedback

Report an error or missing detail. The issue includes this page and revision.

Open issueSource revision 59fae722af8c