OverlayLightService

Provides a create and destroy function for light sources.

# Methods

[{"index":"void DestroyOverlayLight(integer serial) (ClientOnly)","0":"Removes a light source. Deliveres the identifier of the light source that will be removed to serial."}]

[{"index":"void SetOverlayLightEnabled(boolean enable) (ClientOnly)","0":"Determines the overlay light's activation status."}]

[{"index":"integer SpawnFreeformTypeOverlayLight(FreeformTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Freeform-type light source on the map. Delivers the FreeformTypeOverlayLightInfo, which is the Freeform light source information to overlayLightinfo. The return value is the identifier number of the created light source and returns 0 if creation fails."}]

[{"index":"integer SpawnFreeformTypeOverlayLightAttached(AttachedFreeformTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Freeform-type light source as a child entity. Delivers the AttachedFreeformTypeOverlayLightInfo, which is the Freeform light source information to overlayLightinfo. The return value is the identifier number of the created light source and returns 0 if creation fails."}]

[{"index":"integer SpawnGlobalTypeOverlayLight(GlobalTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Global-type light source on the map. Delivers the GlobalTypeOverlayLightInfo, which is the Global light source information to overlayLightinfo. The return value is the identifier number of the created light source and returns 0 if creation fails."}]

[{"index":"integer SpawnGlobalTypeOverlayLightAttached(AttachedGlobalTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Global-type light source as a child entity. Delivers the AttachedGlobalTypeOverlayLightInfo, which is the Global light source information to overlayLightinfo. The return value is the identifying number of the created light source and returns 0 if creation fails."}]

[{"index":"integer SpawnSpotTypeOverlayLight(SpotTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Spot-type light source on the map. Delivers the SpotTypeOverlayLightInfo, which is the Spot light source information to overlayLightinfo. The return value is the identifier number of the created light source and returns 0 if creation fails."}]

[{"index":"integer SpawnSpotTypeOverlayLightAttached(AttachedSpotTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Spot-type light source as a child entity. Delivers the AttachedSpotTypeOverlayLightInfo, which is the Spot light source information to overlayLightinfo. The return value is the identifier number of the created light source and returns 0 if creation fails."}]

[{"index":"integer SpawnSpriteTypeOverlayLight(SpriteTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Sprite-type light source on the map. Delivers the SpriteTypeOverlayLightInfo, which is the Sprite light source information to overlayLightinfo. The return value is the identifier number of the created light source and returns 0 if creation fails."}]

[{"index":"integer SpawnSpriteTypeOverlayLightAttached(AttachedSpriteTypeOverlayLightInfo overlayLightInfo) (ClientOnly)","0":"Spawns a Sprite-type light source as a child entity. Delivers the AttachedSpriteTypeOverlayLightInfo, which is the Sprite light source information to overlayLightinfo. The return value is the identifier number of the created light source and returns 0 if creation fails."}]

##### inherited from Service:

[{"index":"EventHandlerBase ConnectEvent(string key, IScriptFunction eventHandler)","0":"Links events. When a key-type event occurs in this service, a handler is notified. The handler receives event parameters."}]

[{"index":"EventHandlerBase ConnectEvent(Type eventType, IScriptFunction eventHandler)","0":"Links events. This service notifies a handler when an eventType event occurs. The handler receives event parameters."}]

[{"index":"boolean DisconnectEvent(string key, EventHandlerBase eventHandler)","0":"Disconnects the event with the key-type event and the handler."}]

[{"index":"boolean DisconnectEvent(Type eventType, EventHandlerBase eventHandler)","0":"Disconnects the eventType event from its handler."}]

[{"index":"void SendEvent(EventType sendEvent)","0":"Generates an event."}]