Class Comment
Adds Custom data to the scenario
Inherited Members
Namespace: Xareus.Scenarios.Unity
Assembly: Xareus.Scenarios.Unity.Edition.dll
Syntax
public class Comment : Identifiable
Constructors
Comment(Identifiable, string, string, Vector2, string, Color)
Declaration
public Comment(Identifiable owner, string id, string label, Vector2 position, string text, Color color = default)
Parameters
Type | Name | Description |
---|---|---|
Identifiable | owner | |
string | id | |
string | label | |
Vector2 | position | |
string | text | |
Color | color |
Fields
Color
The color of the comment
Declaration
public Color Color
Field Value
Type | Description |
---|---|
Color |
Height
Contains the height of a comment.
Declaration
public float Height
Field Value
Type | Description |
---|---|
float |
IsFolded
Indicates if the comment is folded or not.
Declaration
public bool IsFolded
Field Value
Type | Description |
---|---|
bool |
Text
Contains the text of a comment. NOTE : This is the main content of the comment.
Declaration
public string Text
Field Value
Type | Description |
---|---|
string |
Width
Contains the width of a comment.
Declaration
public float Width
Field Value
Type | Description |
---|---|
float |
X
Contains the abscissa of a comment.
Declaration
public float X
Field Value
Type | Description |
---|---|
float |
Y
Contains the ordinate of a comment.
Declaration
public float Y
Field Value
Type | Description |
---|---|
float |
Properties
Id
Contains the id of the comment.
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
string |
Label
Contains the label of the comment
Declaration
public string Label { get; set; }
Property Value
Type | Description |
---|---|
string |
Owner
Contains an object. The object owns the comment.
Declaration
public Identifiable Owner { get; }
Property Value
Type | Description |
---|---|
Identifiable |