OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub Class Reference

Ignore semantic lighting requests. More...

Inheritance diagram for ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub:
ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf

Public Member Functions

None request_power (self, bool enabled)
 Request that lighting power be enabled or disabled.
 
None request_color (self, LightingColor color)
 Request a normalized RGB lighting color.
 
None request_brightness (self, int percent)
 Request brightness from zero through 100 percent.
 
None request_pattern (self, int pattern_index)
 Request a controller lighting pattern.
 
None request_music_mode (self, int mode_index)
 Request a music-reactive mode.
 

Detailed Description

Ignore semantic lighting requests.

Member Function Documentation

◆ request_brightness()

None ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.request_brightness (   self,
int  percent 
)

Request brightness from zero through 100 percent.

Parameters
percentRequested brightness percentage in the range 0..100.

Reimplemented from ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.

◆ request_color()

None ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.request_color (   self,
LightingColor  color 
)

Request a normalized RGB lighting color.

Parameters
colorRequested RGB color.

Reimplemented from ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.

◆ request_music_mode()

None ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.request_music_mode (   self,
int  mode_index 
)

Request a music-reactive mode.

Parameters
mode_indexController-defined music mode index.

Reimplemented from ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.

◆ request_pattern()

None ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.request_pattern (   self,
int  pattern_index 
)

Request a controller lighting pattern.

Parameters
pattern_indexController-defined pattern index.

Reimplemented from ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.

◆ request_power()

None ui.lighting.lighting_request_handler_stub.LightingRequestHandlerStub.request_power (   self,
bool  enabled 
)

Request that lighting power be enabled or disabled.

Parameters
enabledTrue to enable lighting power.

Reimplemented from ui.lighting.lighting_request_handler_if.LightingRequestHandlerIf.


The documentation for this class was generated from the following file: