Point spotlight: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 4: Line 4:
An entity to draw a spotlight. Will draw a beam when the player views it side on, and a halo when it's facing towards the player. Unless the 'No Dynamic Light' spawnflag is checked, it will also create a dynamic light wherever the end of the spotlight rests.
An entity to draw a spotlight. Will draw a beam when the player views it side on, and a halo when it's facing towards the player. Unless the 'No Dynamic Light' spawnflag is checked, it will also create a dynamic light wherever the end of the spotlight rests.


==Entity Values==
==Keyvalues==
===Keys===


* '''Name''' ''targetname <target_source>''
* {{kv targetname}}
: The name that other entities refer to this entity by.


* '''Parent''' ''parentname <target_destination>''
* {{kv parentname}}
: The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.


* '''Pitch Yaw Roll (Y Z X)''' ''angles <angle>''
* {{kv angles}}
: This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.


* '''Spotlight Length''' ''spotlightlength <integer>''
* '''Spotlight Length''' ''spotlightlength <integer>''
Line 25: Line 21:
: The color of the spotlight cone.
: The color of the spotlight cone.


===Flags===
==Flags==


* '''Start On'''
* '''Start On'''
Line 33: Line 29:
: Prevents a dynamic light from being generated by the point_spotlight. Dynamic lights can be costly for performance, so this flag should be checked to improve framerate.
: Prevents a dynamic light from being generated by the point_spotlight. Dynamic lights can be costly for performance, so this flag should be checked to improve framerate.


===Inputs===
==Inputs==


* '''Kill'''
* {{i targetname}}
: Removes this entity from the world.


* '''KillHierarchy''' 
* {{i parentname}}
: Removes this entity and all its children from the world.
 
* '''AddOutput''' ''<string> <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>''
: Adds an entity I/O connection to this entity. Very dangerous, use with care.
 
* '''FireUser1'''
: Causes this entity's OnUser1 output to be fired.
 
* '''FireUser2'''
: Causes this entity's OnUser2 output to be fired.
 
* '''FireUser3'''
: Causes this entity's OnUser3 output to be fired.
 
* '''FireUser4'''
: Causes this entity's OnUser4 output to be fired.
 
* '''SetParent''' ''<string>''
: Changes the entity's parent in the movement hierarchy.
 
* '''SetParentAttachment''' ''<string>''
: Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
 
* '''ClearParent'''
: Removes this entity from the the movement hierarchy, leaving it free to move independently.


* '''LightOn'''
* '''LightOn'''
Line 71: Line 41:
: Turn the spotlight off
: Turn the spotlight off


===Outputs===
==Outputs==
 
* '''OnUser1'''
: Fired in response to FireUser1 input.
 
* '''OnUser2'''
: Fired in response to FireUser2 input.
 
* '''OnUser3'''
: Fired in response to FireUser3 input.


* '''OnUser4'''
* {{o targetname}}
: Fired in response to FireUser4 input.


==See Also==
==See Also==

Revision as of 22:51, 11 July 2005

Template:Wrongtitle

Entity Description

An entity to draw a spotlight. Will draw a beam when the player views it side on, and a halo when it's facing towards the player. Unless the 'No Dynamic Light' spawnflag is checked, it will also create a dynamic light wherever the end of the spotlight rests.

Keyvalues

  • Spotlight Length spotlightlength <integer>
Length of the spotlight beam.
  • Spotlight Width spotlightwidth <integer>
Width of the spotlight beam.
  • Color (R G B) rendercolor <color255>
The color of the spotlight cone.

Flags

  • Start On
Sets the point_spotlight to be turned on when it spawns.
  • No Dynamic Light
Prevents a dynamic light from being generated by the point_spotlight. Dynamic lights can be costly for performance, so this flag should be checked to improve framerate.

Inputs

  • LightOn
Turn the spotlight on.
  • LightOff
Turn the spotlight off

Outputs

See Also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Point_spotlight&oldid=6998"