tecs.ecs.phases
The ordered frame phase constants.
Module contents
Functions
| Function | Kind | Description |
|---|---|---|
at | function | Returns a phase by its one-based frame position. |
selectionAt | function | Returns one leaf from a phase or predefined group. |
shutdownAt | function | Returns a shutdown phase by its one-based lifecycle position. |
startupAt | function | Returns a startup phase by its one-based lifecycle position. |
Values
| Value | Kind | Description |
|---|---|---|
AllGroups | variable | |
beforeFixedCount | variable | |
count | variable | |
First | variable | |
FixedFirst | variable | |
fixedFirstIndex | variable | |
FixedLast | variable | |
fixedLastIndex | variable | |
FixedPostUpdate | variable | |
FixedPreUpdate | variable | |
FixedUpdate | variable | |
FixedUpdateGroup | variable | |
Ingress | variable | |
Last | variable | |
MainGroup | variable | |
PostRender | variable | |
PostShutdown | variable | |
PostStartup | variable | |
PostUpdate | variable | |
PreRender | variable | |
PreShutdown | variable | |
PreStartup | variable | |
PreUpdate | variable | |
Render | variable | |
RenderFirst | variable | |
RenderGroup | variable | |
RenderLast | variable | |
Shutdown | variable | |
shutdownCount | variable | |
ShutdownGroup | variable | |
Startup | variable | |
startupCount | variable | |
StartupGroup | variable | |
Update | variable |
Functions#
atfunction#
function at(index: integer): Phase?Returns a phase by its one-based frame position.
Arguments
| Name | Type | Description |
|---|---|---|
index | integer | the one-based phase position |
Returns
| Type | Description |
|---|---|
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
| Name | Type | Description |
|---|---|---|
selection | Selection | the leaf or group to traverse |
index | integer | the one-based position inside the selection |
Returns
| Type | Description |
|---|---|
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
| Name | Type | Description |
|---|---|---|
index | integer | the one-based shutdown position |
Returns
| Type | Description |
|---|---|
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
| Name | Type | Description |
|---|---|---|
index | integer | the one-based startup position |
Returns
| Type | Description |
|---|---|
Phase? | the phase, or nil outside the startup order |
Values#
AllGroupsvariable#
const AllGroups: PhaseGroupbeforeFixedCountvariable#
const beforeFixedCount: integercountvariable#
const count: integerFirstvariable#
FixedFirstvariable#
const FixedFirst: PhasefixedFirstIndexvariable#
const fixedFirstIndex: integerFixedLastvariable#
fixedLastIndexvariable#
const fixedLastIndex: integerFixedPostUpdatevariable#
const FixedPostUpdate: PhaseFixedPreUpdatevariable#
const FixedPreUpdate: PhaseFixedUpdatevariable#
const FixedUpdate: PhaseFixedUpdateGroupvariable#
const FixedUpdateGroup: PhaseGroupIngressvariable#
Lastvariable#
MainGroupvariable#
const MainGroup: PhaseGroupPostRendervariable#
const PostRender: PhasePostShutdownvariable#
const PostShutdown: PhasePostStartupvariable#
const PostStartup: PhasePostUpdatevariable#
const PostUpdate: PhasePreRendervariable#
PreShutdownvariable#
const PreShutdown: PhasePreStartupvariable#
const PreStartup: PhasePreUpdatevariable#
Rendervariable#
RenderFirstvariable#
const RenderFirst: PhaseRenderGroupvariable#
const RenderGroup: PhaseGroupRenderLastvariable#
const RenderLast: PhaseShutdownvariable#
shutdownCountvariable#
const shutdownCount: integerShutdownGroupvariable#
const ShutdownGroup: PhaseGroupStartupvariable#
startupCountvariable#
const startupCount: integerStartupGroupvariable#
const StartupGroup: PhaseGroup