Skip to main content

Signal

                            
                              
                                interface 
                                Signal
                                
                                  
                                    
                                      TSetterValue
                                    
                                    
                                      TValue
                                       extends 
                                      TSetterValue
                                    
                                    
                                      TOwner
                                       = 
                                      void
                                    
                                    
                                      TContext
                                       = 
                                      SignalContext
                                      
                                        
                                          
                                            TSetterValue
                                          
                                          
                                            TValue
                                          
                                          
                                            TOwner
                                          
                                        
                                      
                                    
                                  
                                
                                extends 
                                
                                  
                                    
                                      SignalSetter
                                      
                                        
                                          
                                            TSetterValue
                                          
                                          
                                            TOwner
                                          
                                        
                                      
                                    
                                    
                                      SignalGetter
                                      
                                        
                                          
                                            TValue
                                          
                                        
                                      
                                    
                                    
                                      SignalTween
                                      
                                        
                                          
                                            TSetterValue
                                          
                                          
                                            TValue

Type Parameters

Callable

                            
                              
                                public 
                                Signal
                                
                                  
                                    
                                      value
                                      : 
                                      
                                        
                                          
                                            typeof 
                                            DEFAULT
                                          
                                          
                                            SignalValue
                                            
                                              
                                                
                                                  TSetterValue
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                TOwner
                              
                              

                            
                          
                            
                              
                                public 
                                Signal
                                (): 
                                TValue
                              
                              

                            
                          
                            
                              
                                public 
                                Signal
                                
                                  
                                    
                                      value
                                      : 
                                      
                                        
                                          
                                            typeof 
                                            DEFAULT
                                          
                                          
                                            SignalValue
                                            
                                              
                                                
                                                  TSetterValue
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                    
                                      time
                                      : 
                                      number
                                    
                                    
                                      timingFunction
                                      ?: 
                                      TimingFunction
                                    
                                    
                                      interpolationFunction
                                      ?: 
                                      InterpolationFunction
                                      
                                        
                                          
                                            TValue
                                          
                                          
                                            any
                                            []
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                SignalGenerator
                                
                                  
                                    
                                      TSetterValue
                                    
                                    
                                      TValue

Parameters

Properties ​

context ​ 

                            
                              
                                context
                                : 
                                TContext

Methods ​

isInitial ​ 

                            
                              
                                public 
                                isInitial
                                (): 
                                boolean

Check if the signal is currently using its initial value.

reset ​ 

                            
                              
                                public 
                                reset
                                (): 
                                TOwner

Reset the signal to its initial value (if one has been set).

save ​ 

                            
                              
                                public 
                                save
                                (): 
                                TOwner

Compute the current value of the signal and immediately set it.

This method can be used to stop the signal from updating while keeping itscurrent value.