Class CascadeMenuPage

One page of a cascade menu: a title plus one or more CascadeColumns. Single-column pages are ordinary menus (command, magic, item); multi-column pages show all columns at once and are navigable between them (target selection = Enemies + Party).

OffsetX/OffsetY (when HasOffset is true) define this page's position RELATIVE TO ITS PARENT page when cascaded — so each level's spacing is configurable, FF8-style. PreferredColumn is the column the cursor starts on (e.g. Party for an item's target step). All are plain values (no engine dependency) so a page can be authored from a ScriptableObject.

Inheritance

object

CascadeMenuPage

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Menu.Application.Cascade

Assembly: Serenity.Menu.Application.dll

Syntax

public sealed class CascadeMenuPage

Constructors

CascadeMenuPage(string, IReadOnlyList<CascadeColumn>)

Declaration

public CascadeMenuPage(string title, IReadOnlyList<CascadeColumn> columns)

Parameters

Type	Name	Description
string	title
IReadOnlyList<CascadeColumn>	columns

CascadeMenuPage(string, IReadOnlyList<CascadeOption>)

Single-column convenience constructor.

Declaration

public CascadeMenuPage(string title, IReadOnlyList<CascadeOption> options)

Parameters

Type	Name	Description
string	title
IReadOnlyList<CascadeOption>	options

Properties

Columns

Declaration

public IReadOnlyList<CascadeColumn> Columns { get; }

Property Value

Type	Description
IReadOnlyList<CascadeColumn>

HasOffset

Declaration

public bool HasOffset { get; }

Property Value

Type	Description
bool

OffsetX

Declaration

public float OffsetX { get; }

Property Value

Type	Description
float

OffsetY

Declaration

public float OffsetY { get; }

Property Value

Type	Description
float

PreferredColumn

Declaration

public int PreferredColumn { get; }

Property Value

Type	Description
int

Title

Declaration

public string Title { get; }

Property Value

Type	Description
string

Methods

WithInitialColumn(int)

Returns a copy of this page whose cursor starts on the given column.

Declaration

public CascadeMenuPage WithInitialColumn(int column)

Parameters

Type	Name	Description
int	column

Returns

Type	Description
CascadeMenuPage

WithOffset(float, float)

Returns a copy of this page carrying an explicit cascade offset relative to its parent.

Declaration

public CascadeMenuPage WithOffset(float offsetX, float offsetY)

Parameters

Type	Name	Description
float	offsetX
float	offsetY

Returns

Type	Description
CascadeMenuPage