pw::Mode

The mode base type

Derives From

pw::Object

Summary
pw::ModeThe mode base type
Static Actions
getActiveModeThis action returns the active pw::Mode if any, or an empty string if no mode is active.
Instance Actions
getEntitiesThis action gets a list of entities that were included when this mode began.
getAllEntitiesThis action gets a list of entities that are special in this mode.
endThis action ends this mode and saves changes made during the mode.
abortThis action ends this mode and discards changes made during the mode.

Static Actions

getActiveMode

pw::Application getActiveMode

This action returns the active pw::Mode if any, or an empty string if no mode is active.

Parameters

This action has no parameters.

Returns

This action returns either an empty string if no mode is active, or an pw::Mode object for the active mode.

Instance Actions

getEntities

$mode getEntities

This action gets a list of entities that were included when this mode began.

Parameters

none

Returns

This action returns a list of pw::Entity objects.

getAllEntities

$mode getAllEntities

This action gets a list of entities that are special in this mode.

Parameters

none

Returns

This action returns a list of pw::Entity objects.

end

$mode end

This action ends this mode and saves changes made during the mode.

Parameters

none

Returns

This action returns nothing.

abort

$mode abort

This action ends this mode and discards changes made during the mode.

Parameters

none

Returns

This action returns nothing.

pw::Application getActiveMode
This action returns the active pw::Mode if any, or an empty string if no mode is active.
The mode base type
$mode getEntities
This action gets a list of entities that were included when this mode began.
$mode getAllEntities
This action gets a list of entities that are special in this mode.
$mode end
This action ends this mode and saves changes made during the mode.
$mode abort
This action ends this mode and discards changes made during the mode.
Base type for all glyph types
Entity type
Close