CAST II Game Engine

	Name	Description
	`AsyncMessages`	Asynchronous messages container
	`Compiler`	Scripting subsystem
	`FEditorMode`	Should be True if world-editing capabilities are required
	`FRoot`	Root of a hierarchy
	`FState`	Current manager state
	`ProcessingClasses`	Item processing classes (see `TProcessingClass`)
	`StateNames`	Names of all possible state flags

Methods

Overview

	`constructor Create; virtual;`
	`destructor Destroy; override;`
	`function ChangeClass(Item: TItem; NewClass: CItem): TItem;`
	`procedure ClearItems; virtual;`
	`procedure CollectGarbage; virtual;`
	`function FindItemClass(const AName: string): CItem; virtual;`
	`procedure HandleMessage(const Msg: TMessage); virtual;`
	`function IsSceneLoading: Boolean;`
	`function IsShuttingdown: Boolean;`
	`function LoadItem(Stream: TStream; AParent: TItem): TItem;`
	`function LoadScene(Stream: TStream): Boolean;`
	`procedure OnDestroy; virtual;`
	`procedure ProcessAsyncMessages;`
	`procedure RegisterItemClass(NewClass: CItem);`
	`procedure RegisterItemClasses(NewClasses: array of TClass);`
	`function RegisterState(const AName: string): Boolean;`
	`procedure RemoveItem(Item: TItem);`
	`function SaveScene(Stream: TStream): Boolean;`
	`procedure SendAsyncMessage(const Msg: TMessage; Recipient: TItem); virtual;`
	`procedure SendMessage(const Msg: TMessage; Recipient: TItem; Destination: TMessageFlags);`

Description

constructor Create; virtual;

destructor Destroy; override;

function ChangeClass(Item: TItem; NewClass: CItem): TItem;

Changes class of an item to NewClass.
All direct references to the item except via object linking mechanism become invalid.

procedure ClearItems; virtual;

Clears the current scene

procedure CollectGarbage; virtual;

Handles items market to remove and release

function FindItemClass(const AName: string): CItem; virtual;

Returns an item class by its name or nil if not found

procedure HandleMessage(const Msg: TMessage); virtual;

Default core message handler

function IsSceneLoading: Boolean;

Returns True if a scene is currently loading

function IsShuttingdown: Boolean;

Returns True if manager is shutting down

function LoadItem(Stream: TStream; AParent: TItem): TItem;

Loads an item from a stream specified and adds it to AParent as a child. Returns the loaded item.

function LoadScene(Stream: TStream): Boolean;

Clears the current scene and loads a new scene from a stream

procedure OnDestroy; virtual;

This event occurs right before destruction of the manager

procedure ProcessAsyncMessages;

Handles all asyncronous messages

procedure RegisterItemClass(NewClass: CItem);

Registers an item class. Only items of registered classes can be saved/loaded or be linked to via item link property.

procedure RegisterItemClasses(NewClasses: array of TClass);

Registers an array of item classes. Only items of registered classes can be saved/loaded or be linked to via item link property.

function RegisterState(const AName: string): Boolean;

Registers an item state flag

procedure RemoveItem(Item: TItem);

Removes an item from the manager

function SaveScene(Stream: TStream): Boolean;

Saves the current scene to a stream

procedure SendAsyncMessage(const Msg: TMessage; Recipient: TItem); virtual;

Adds a message to the asyncronous queue to be handled later in ProcessAsyncMessages

procedure SendMessage(const Msg: TMessage; Recipient: TItem; Destination: TMessageFlags);

Sends the specified message according to the specified destination

Properties

Overview

	`property EditorMode: Boolean;`
	`property ItemClasses[Index: Integer]: CItem;`
	`property Root: TRootItem;`
	`property TotalItemClasses: Integer;`
	`property TotalProcessingClasses: Integer;`

Description

property EditorMode: Boolean;

Should be set to True if world-editing capabilities are required

property ItemClasses[Index: Integer]: CItem;

Registered item classes

property Root: TRootItem;

Root of a hierarchy

property TotalItemClasses: Integer;

Number of registered item classes

property TotalProcessingClasses: Integer;

Number of processing classes