Class HandheldLightComponent

Inheritance
System.Object
HandheldLightComponent
Namespace: Content.Shared.Light.Components
Assembly: Content.Shared.dll
Syntax
public sealed class HandheldLightComponent : Component

Fields

| Improve this Doc View Source

Activated

Declaration
public bool Activated
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

AddPrefix

Whether to automatically set item-prefixes when toggling the flashlight.

Declaration
public bool AddPrefix
Field Value
Type Description
System.Boolean
Remarks

Flashlights should probably be using explicit unshaded sprite, in-hand and clothing layers, this is mostly here for backwards compatibility.

| Improve this Doc View Source

Level

Declaration
public byte? Level
Field Value
Type Description
System.Nullable<System.Byte>
| Improve this Doc View Source

SelfToggleActionEntity

Declaration
public EntityUid? SelfToggleActionEntity
Field Value
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

StatusLevels

Declaration
public const int StatusLevels = null
Field Value
Type Description
System.Int32
| Improve this Doc View Source

ToggleAction

Declaration
public string ToggleAction
Field Value
Type Description
System.String
| Improve this Doc View Source

ToggleActionEntity

Declaration
public EntityUid? ToggleActionEntity
Field Value
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

ToggleOnInteract

Whether or not the light can be toggled via standard interactions (alt verbs, using in hand, etc)

Declaration
public bool ToggleOnInteract
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

TurnOffSound

Declaration
public SoundSpecifier TurnOffSound
Field Value
Type Description
Robust.Shared.Audio.SoundSpecifier
| Improve this Doc View Source

TurnOnFailSound

Declaration
public SoundSpecifier TurnOnFailSound
Field Value
Type Description
Robust.Shared.Audio.SoundSpecifier
| Improve this Doc View Source

TurnOnSound

Declaration
public SoundSpecifier TurnOnSound
Field Value
Type Description
Robust.Shared.Audio.SoundSpecifier

Properties

| Improve this Doc View Source

BlinkingBehaviourId

Specify the ID of the light behaviour to use when the state of the light is Dying

Declaration
public string BlinkingBehaviourId { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RadiatingBehaviourId

Specify the ID of the light behaviour to use when the state of the light is LowPower

Declaration
public string RadiatingBehaviourId { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Wattage

Declaration
public float Wattage { get; set; }
Property Value
Type Description
System.Single