tecs.ecs.phases

The ordered frame phase constants.

Module contents

Functions

FunctionKindDescription
atfunctionReturns a phase by its one-based frame position.
selectionAtfunctionReturns one leaf from a phase or predefined group.
shutdownAtfunctionReturns a shutdown phase by its one-based lifecycle position.
startupAtfunctionReturns a startup phase by its one-based lifecycle position.

Values

ValueKindDescription
AllGroupsvariable
beforeFixedCountvariable
countvariable
Firstvariable
FixedFirstvariable
fixedFirstIndexvariable
FixedLastvariable
fixedLastIndexvariable
FixedPostUpdatevariable
FixedPreUpdatevariable
FixedUpdatevariable
FixedUpdateGroupvariable
Ingressvariable
Lastvariable
MainGroupvariable
PostRendervariable
PostShutdownvariable
PostStartupvariable
PostUpdatevariable
PreRendervariable
PreShutdownvariable
PreStartupvariable
PreUpdatevariable
Rendervariable
RenderFirstvariable
RenderGroupvariable
RenderLastvariable
Shutdownvariable
shutdownCountvariable
ShutdownGroupvariable
Startupvariable
startupCountvariable
StartupGroupvariable
Updatevariable

Functions#

atfunction#

function at(index: integer): Phase?

Returns a phase by its one-based frame position.

Arguments

NameTypeDescription
indexinteger

the one-based phase position

Returns

TypeDescription
Phase?

the phase, or nil outside the frame order

selectionAtfunction#

function selectionAt(selection: Selection, index: integer): Phase?

Returns one leaf from a phase or predefined group.

Arguments

NameTypeDescription
selectionSelection

the leaf or group to traverse

indexinteger

the one-based position inside the selection

Returns

TypeDescription
Phase?

the selected leaf, or nil after the selection is exhausted

shutdownAtfunction#

function shutdownAt(index: integer): Phase?

Returns a shutdown phase by its one-based lifecycle position.

Arguments

NameTypeDescription
indexinteger

the one-based shutdown position

Returns

TypeDescription
Phase?

the phase, or nil outside the shutdown order

startupAtfunction#

function startupAt(index: integer): Phase?

Returns a startup phase by its one-based lifecycle position.

Arguments

NameTypeDescription
indexinteger

the one-based startup position

Returns

TypeDescription
Phase?

the phase, or nil outside the startup order

Values#

AllGroupsvariable#

beforeFixedCountvariable#

const beforeFixedCount: integer

countvariable#

const count: integer

Firstvariable#

const First: Phase

FixedFirstvariable#

fixedFirstIndexvariable#

const fixedFirstIndex: integer

FixedLastvariable#

fixedLastIndexvariable#

const fixedLastIndex: integer

FixedPostUpdatevariable#

FixedPreUpdatevariable#

FixedUpdatevariable#

FixedUpdateGroupvariable#

Ingressvariable#

const Ingress: Phase

Lastvariable#

const Last: Phase

MainGroupvariable#

PostRendervariable#

PostShutdownvariable#

PostStartupvariable#

PostUpdatevariable#

PreRendervariable#

PreShutdownvariable#

PreStartupvariable#

PreUpdatevariable#

Rendervariable#

const Render: Phase

RenderFirstvariable#

RenderGroupvariable#

RenderLastvariable#

Shutdownvariable#

shutdownCountvariable#

const shutdownCount: integer

ShutdownGroupvariable#

Startupvariable#

const Startup: Phase

startupCountvariable#

const startupCount: integer

StartupGroupvariable#

Updatevariable#

const Update: Phase