HU/Element/Searchlight

From Multi Theft Auto: Wiki

The searchlight class represents special spotlights in the GTA world. They are different to common spotlights because their visual effects.

The element type of this class is "searchlight".


[[{{{image}}}|link=]] Note: The XML syntax is not implemented yet, but is a representation of what it would be if implemented.

XML syntax

<searchlight startX="" startY="" startZ="" endX="" endY="" endZ="" startRadius="" endRadius="" renderSpot="" />

Required Attributes

  • startX: the X coordinate where the searchlight light cone will start.
  • startY: the Y coordinate where the searchlight light cone will start.
  • startZ: the Z coordinate where the searchlight light cone will start.
  • endX: the X coordinate of the direction where the searchlight will point to.
  • endY: the Y coordinate of the direction where the searchlight will point to.
  • endZ: the Z coordinate of the direction where the searchlight will point to.
  • startRadius: the radius of the searchlight's light cone in its beginning.
  • endRadius: the radius of the searchlight's light cone in its end.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • renderSpot: if true, the searchlight will lighten the surface where it ends.

Related scripting functions