Class PaintableItemData

Synced data for persisting color data for a paintable world object.

Inheritance
System.Object
PaintableItemData
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: Eco.Gameplay.Components
Assembly: Eco.Gameplay.dll
Syntax
public sealed class PaintableItemData : Object, IController, IViewController, IHasUniversalID, INotifyPropertyChanged, IClearRequestHandler

Constructors

PaintableItemData()

Declaration
public PaintableItemData()

Properties

AnyChannelPainted

Declaration
public bool AnyChannelPainted { get; }
Property Value
Type Description
System.Boolean

ChannelOneColor

Represents the red color channel on the world object's material.

Declaration
public ByteColor ChannelOneColor { get; set; }
Property Value
Type Description
ByteColor

ChannelThreeColor

Represents the blue color channel on the world object's material.

Declaration
public ByteColor ChannelThreeColor { get; set; }
Property Value
Type Description
ByteColor

ChannelTwoColor

Represents the green color channel on the world object's material.

Declaration
public ByteColor ChannelTwoColor { get; set; }
Property Value
Type Description
ByteColor

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

HasDataThatCanBeCleared

Declaration
public bool HasDataThatCanBeCleared { get; }
Property Value
Type Description
System.Boolean

Methods

SetAllChannelsColor(ByteColor)

Declaration
public bool SetAllChannelsColor(ByteColor color)
Parameters
Type Name Description
ByteColor color
Returns
Type Description
System.Boolean

SetChannelOneColor(ByteColor)

Declaration
public bool SetChannelOneColor(ByteColor color)
Parameters
Type Name Description
ByteColor color
Returns
Type Description
System.Boolean

SetChannelThreeColor(ByteColor)

Declaration
public bool SetChannelThreeColor(ByteColor color)
Parameters
Type Name Description
ByteColor color
Returns
Type Description
System.Boolean

SetChannelTwoColor(ByteColor)

Declaration
public bool SetChannelTwoColor(ByteColor color)
Parameters
Type Name Description
ByteColor color
Returns
Type Description
System.Boolean

TryHandleClearRequest(Player)

Attempts to clear th configured colors on the world object. This restores it to its original color state as defined by the art team.

Declaration
public Result TryHandleClearRequest(Player player)
Parameters
Type Name Description
Player player
Returns
Type Description
Result

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods