Struct MarkerDrawOptions

The user-defined options for drawing a marker.

Namespace: UnityEditor.Timeline

Syntax

public struct MarkerDrawOptions

Properties

errorText

Text that indicates if the marker should display an error.

Declaration

public string errorText { get; set; }

Property Value

Type	Description
String

Remarks

If the error text is not empty or null, then the marker displays a warning. The error text is used as the tooltip.

The tooltip for the marker.

Declaration

public string tooltip { get; set; }

Property Value

Type	Description
String

Methods

Equals(Object)

Indicates whether this instance and a specified object are equal.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare with the current instance.

Returns

Type	Description
Boolean	Returns `true` if `obj` and this instance are the same type and represent the same value.

Equals(MarkerDrawOptions)

Compares this object with another MarkerDrawOptions.

Declaration

public bool Equals(MarkerDrawOptions other)

Parameters

Type	Name	Description
MarkerDrawOptions	other	The object to compare with.

Returns

Type	Description
Boolean	Returns true if `this` and `other` are equal.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A 32-bit signed integer that is the hash code for this instance.

Operators

Equality(MarkerDrawOptions, MarkerDrawOptions)

Compares two MarkerDrawOptions objects.

Declaration

public static bool operator ==(MarkerDrawOptions options1, MarkerDrawOptions options2)

Parameters

Type	Name	Description
MarkerDrawOptions	options1	The first object.
MarkerDrawOptions	options2	The second object.

Returns

Type	Description
Boolean	Returns true if they are equal.

Inequality(MarkerDrawOptions, MarkerDrawOptions)

Compares two MarkerDrawOptions objects.

Declaration

public static bool operator !=(MarkerDrawOptions options1, MarkerDrawOptions options2)

Parameters

Type	Name	Description
MarkerDrawOptions	options1	The first object.
MarkerDrawOptions	options2	The second object.

Returns

Type	Description
Boolean	Returns true if they are not equal.