A player-controlled point light entity component. Exposes props for on/off, shadows, color, brightness, radius, attenuation, temperature, plus a flicker animation set, drives a child PointLight each time a property changes, and handles key bindings, signal inputs and held/toggle modes through IPlayerControllable and IControlEvents.
/// <summary>
/// A player-controlled point light.
/// </summary>
[Title( "#entity.name.pointlightentity" )]
public sealed class PointLightEntity : Component, IPlayerControllable, Global.IControlEvents
{
/// <summary>
/// Whether the light is switched on.
/// </summary>
[Property, Title( "#entity.property.on" ), Description( "#entity.description.on" ), ClientEditable, Group( "#entity.group.light" ), SignalInput]
public bool On { get; set { if ( field == value ) return; field = value; UpdateLight(); } } = true;
/// <summary>
/// Whether the light casts shadows.
/// </summary>
[Property, Title( "#entity.property.shadows" ), Description( "#entity.description.shadows" ), ClientEditable, Group( "#entity.group.light" )]
public bool Shadows { get; set { field = value; UpdateLight(); } }
/// <summary>
/// The color of the light.
/// </summary>
[Property, Title( "#entity.property.color" ), Description( "#entity.description.color" ), Range( 0, 1 ), ClientEditable, Group( "#entity.group.light" )]
public Color Color { get; set { field = value; UpdateLight(); } }
/// <summary>
/// The brightness of the light.
/// </summary>
[Property, Title( "#entity.property.brightness" ), Description( "#entity.description.brightness" ), Range( 0, 50 ), ClientEditable, Group( "#entity.group.light" )]
public float Brightness { get; set { field = value; UpdateLight(); } }
/// <summary>
/// The radius affected by the light.
/// </summary>
[Property, Title( "#entity.property.radius" ), Description( "#entity.description.radius" ), Range( 0, 1000 ), ClientEditable, Group( "#entity.group.light" )]
public float Radius { get; set { field = value; UpdateLight(); } }
/// <summary>
/// How quickly the light fades with distance.
/// </summary>
[Property, Title( "#entity.property.attenuation" ), Description( "#entity.description.attenuation" ), Range( 0, 16 ), ClientEditable, Group( "#entity.group.light" )]
public float Attenuation { get; set { field = value; UpdateLight(); } } = 2.4f;
/// <summary>
/// The color temperature of the light in Kelvin, 6500 is neutral white.
/// </summary>
[Property, Title( "#entity.property.temperature" ), Description( "#entity.description.temperature" ), Range( 1000, 12000 ), ClientEditable, Group( "#entity.group.light" )]
[SliderGradient( "#ff4400", "#ff890e", "#ffb270", "#ffdabf", "#ffffff", "#cadbff", "#bfd4ff",
Positions = new float[] { 0, 1000f / 11000, 2000f / 11000, 3500f / 11000, 0.5f, 9000f / 11000, 1 } )]
public float Temperature { get; set { field = value; UpdateLight(); } } = 6500;
/// <summary>
/// Whether the light's brightness is animated.
/// </summary>
[Property, Title( "#entity.property.animated" ), Description( "#entity.description.animated" ), ClientEditable, ToggleGroup( "Animated", Label = "#entity.group.animation" )]
public bool Animated { get; set { field = value; UpdateLight(); } }
/// <summary>
/// The animation the light plays.
/// </summary>
[Property, Title( "#entity.property.animationpattern" ), Description( "#entity.description.animationpattern" ), ClientEditable, ToggleGroup( "Animated", Label = "#entity.group.animation" )]
public LightAnimationPattern AnimationPattern { get; set { field = value; UpdateLight(); } } = LightAnimationPattern.Flicker;
/// <summary>
/// How fast the animation plays.
/// </summary>
[Property, Title( "#entity.property.animationspeed" ), Description( "#entity.description.animationspeed" ), Range( 0, 10 ), ClientEditable, ToggleGroup( "Animated", Label = "#entity.group.animation" )]
public float AnimationSpeed { get; set { field = value; UpdateLight(); } } = 1;
/// <summary>
/// Shifts the animation in time, so identical lights don't play in step.
/// </summary>
[Property, Title( "#entity.property.animationoffset" ), Description( "#entity.description.animationoffset" ), Range( 0, 5 ), ClientEditable, ToggleGroup( "Animated", Label = "#entity.group.animation" )]
public float AnimationOffset { get; set { field = value; UpdateLight(); } }
/// <summary>
/// Whether the light's model casts shadows.
/// </summary>
[Property, Title( "#entity.property.castshadows" ), Description( "#entity.description.castshadows" ), ClientEditable, Group( "#entity.group.rendering" )]
public ModelRenderer.ShadowRenderType CastShadows { get; set { field = value; UpdateLight(); } } = ModelRenderer.ShadowRenderType.On;
/// <summary>
/// The input that switches the light on.
/// </summary>
[Property, Title( "#entity.property.turnon" ), Description( "#entity.description.turnon" ), ClientEditable, Group( "#entity.group.state" )]
public ClientInput TurnOn { get; set; }
/// <summary>
/// The input that switches the light off.
/// </summary>
[Property, Title( "#entity.property.turnoff" ), Description( "#entity.description.turnoff" ), ClientEditable, Group( "#entity.group.state" )]
public ClientInput TurnOff { get; set; }
/// <summary>
/// The input that toggles the light.
/// </summary>
[Property, Title( "#tool.setting.light_input" ), Description( "#tool.setting.light_input.description" ), ClientEditable, Group( "#entity.group.state" )]
public ClientInput Toggle { get; set; }
[Property, Title( "#tool.setting.light_toggle" ), Description( "#tool.setting.light_toggle.description" ), ClientEditable, Group( "#entity.group.state" )]
public bool ToggleMode
{
get;
set
{
if ( field == value ) return;
field = value;
if ( !value && !IsProxy ) UpdateHeldState();
}
} = true;
bool _keyDown;
bool _wireDown;
/// <summary>
/// The object shown while the light is on.
/// </summary>
[Property]
public GameObject OnGameObject { get; set; }
/// <summary>
/// The object shown while the light is off.
/// </summary>
[Property]
public GameObject OffGameObject { get; set; }
/// <summary>
/// Toggles on a rising edge, or stays on while the key or signal is held.
/// </summary>
[SignalInput( Id = nameof( Toggle ), Name = "#entity.signal.light_trigger", Default = true )]
public void ToggleSignal( bool down )
{
if ( IsProxy ) return;
bool pressed = down && !_wireDown;
_wireDown = down;
if ( ToggleMode )
{
if ( pressed ) On = !On;
}
else UpdateHeldState();
}
/// <summary>
/// Switches the light on when its signal input is triggered.
/// </summary>
[SignalInput( Id = nameof( TurnOn ) ), Title( "#entity.property.turnon" )]
public void TurnOnSignal() => On = true;
/// <summary>
/// Switches the light off when its signal input is triggered.
/// </summary>
[SignalInput( Id = nameof( TurnOff ) ), Title( "#entity.property.turnoff" )]
public void TurnOffSignal() => On = false;
/// <summary>
/// Applies the owning player's light controls.
/// </summary>
public void OnControl()
{
if ( IsProxy ) return;
_keyDown = Toggle.Down();
if ( ToggleMode )
{
if ( Toggle.Pressed() ) On = !On;
}
else UpdateHeldState();
if ( TurnOn.Pressed() ) On = true;
if ( TurnOff.Pressed() ) On = false;
}
void UpdateHeldState() => On = _keyDown || _wireDown;
void Global.IControlEvents.OnControlStopped( ControlEvent e )
{
if ( !Networking.IsHost || !e.Target.IsValid() ) return;
var linked = new LinkedGameObjectBuilder();
linked.AddConnected( GameObject );
if ( !linked.Objects.Contains( e.Target.Root ) ) return;
_keyDown = false;
if ( !ToggleMode ) UpdateHeldState();
}
protected override void OnEnabled()
{
if ( !ToggleMode && !IsProxy ) UpdateHeldState();
UpdateLight();
}
protected override void OnDisabled()
{
_keyDown = _wireDown = false;
if ( !ToggleMode && !IsProxy ) UpdateHeldState();
}
void UpdateLight()
{
OnGameObject?.Enabled = On;
OffGameObject?.Enabled = !On;
// the lit bulb surrounds its own light so it can never cast shadows, shadows only just hides it
foreach ( var renderer in OnGameObject?.GetComponentsInChildren<ModelRenderer>( true ) ?? [] )
renderer.Enabled = CastShadows != ModelRenderer.ShadowRenderType.ShadowsOnly;
foreach ( var renderer in OffGameObject?.GetComponentsInChildren<ModelRenderer>( true ) ?? [] )
renderer.RenderType = CastShadows;
if ( GetComponentInChildren<PointLight>( true ) is not PointLight light )
return;
light.Enabled = On;
var color = Color;
color.r *= Brightness;
color.g *= Brightness;
color.b *= Brightness;
light.Shadows = Shadows;
light.LightColor = color;
light.Temperature = Temperature;
light.Radius = Radius;
light.Attenuation = Attenuation;
light.AnimationEnabled = Animated;
light.AnimationPattern = AnimationPattern;
light.AnimationSpeed = AnimationSpeed;
light.AnimationTimeOffset = AnimationOffset;
if ( Network.Active && !IsProxy ) Network.Refresh();
}
}