ESPHome 2026.6.0-dev
Loading...
Searching...
No Matches
esphome::light::LightEffectCycleAction< Forward, Ts > Class Template Reference

#include <automation.h>

Inheritance diagram for esphome::light::LightEffectCycleAction< Forward, Ts >:
esphome::Action< Ts... >

Public Member Functions

 LightEffectCycleAction (LightState *parent)
 
void set_include_none (bool include_none)
 
void play (const Ts &...) override
 
- Public Member Functions inherited from esphome::Action< Ts... >
virtual void play_complex (const Ts &...x)
 
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running.
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain.
 

Protected Attributes

LightStateparent_
 
bool include_none_ {false}
 
- Protected Attributes inherited from esphome::Action< Ts... >
friend ActionList< Ts... >
 
Action< Ts... > * next_
 
int num_running_
 The number of instances of this sequence in the list of actions that is currently being executed.
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Action< Ts... >
virtual void play (const Ts &...x)=0
 
void play_next_ (const Ts &...x)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple, std::index_sequence< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
virtual void stop ()
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Detailed Description

template<bool Forward, typename... Ts>
class esphome::light::LightEffectCycleAction< Forward, Ts >

Definition at line 111 of file automation.h.

Constructor & Destructor Documentation

◆ LightEffectCycleAction()

template<bool Forward, typename... Ts>
esphome::light::LightEffectCycleAction< Forward, Ts >::LightEffectCycleAction ( LightState * parent)
inlineexplicit

Definition at line 113 of file automation.h.

Member Function Documentation

◆ play()

template<bool Forward, typename... Ts>
void esphome::light::LightEffectCycleAction< Forward, Ts >::play ( const Ts & ...)
inlineoverride

Definition at line 117 of file automation.h.

◆ set_include_none()

template<bool Forward, typename... Ts>
void esphome::light::LightEffectCycleAction< Forward, Ts >::set_include_none ( bool include_none)
inline

Definition at line 115 of file automation.h.

Field Documentation

◆ include_none_

template<bool Forward, typename... Ts>
bool esphome::light::LightEffectCycleAction< Forward, Ts >::include_none_ {false}
protected

Definition at line 145 of file automation.h.

◆ parent_

template<bool Forward, typename... Ts>
LightState* esphome::light::LightEffectCycleAction< Forward, Ts >::parent_
protected

Definition at line 144 of file automation.h.


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