Class UpdateComponent
A base class that implements Update(IScreenObject, TimeSpan) of IComponent.
Inheritance
UpdateComponent
Implements
Inherited Members
Namespace: SadConsole.Components
Assembly: SadConsole.dll
Syntax
public abstract class UpdateComponent : IComponent
Constructors
UpdateComponent()
Declaration
protected UpdateComponent()
Properties
SortOrder
Indicates priority to other components.
Declaration
public uint SortOrder { get; set; }
Property Value
Type | Description |
---|---|
uint |
Methods
OnAdded(IScreenObject)
Called when the component is added to a host.
Declaration
public virtual void OnAdded(IScreenObject host)
Parameters
Type | Name | Description |
---|---|---|
IScreenObject | host | The host that added the component. |
OnRemoved(IScreenObject)
Called when the component is removed from the host.
Declaration
public virtual void OnRemoved(IScreenObject host)
Parameters
Type | Name | Description |
---|---|---|
IScreenObject | host | The host that removed the component. |
Update(IScreenObject, TimeSpan)
Called by a host on the update frame.
Declaration
public abstract void Update(IScreenObject host, TimeSpan delta)
Parameters
Type | Name | Description |
---|---|---|
IScreenObject | host | The host calling the component. |
TimeSpan | delta | The time that has elapsed since this method was last called. |