CAST II Game Engine

   DESCRIPTION       FEATURES       SCREENSHOTS       FORUMS       DOCUMENTATION       DOWNLOADS       CONTACTS   
Units
Class Hierarchy
Classes, Interfaces and Objects
Types
Enumerations
Variables
Constants
Functions and Procedures
Identifiers

Class TCast2App

Unit

C2AppHelper

Declaration

type TCast2App = class(TApp)

Description

Base class for applications which uses CAST II engine

Hierarchy

TApp

Fields

 NameDescription
PublicCoreCAST II core reference

Methods

Overview

Publicconstructor Create(const AProgramName: string; AStarter: TAppStarter); override;
Publicdestructor Destroy; override;
Protectedprocedure ApplyControls; virtual;
Publicprocedure ApplyOptions; virtual;
Publicprocedure ApplyOptionSet(const OptionSet: string); virtual;
Publicfunction ApplyVideoOptions: Boolean; virtual;
Publicprocedure BindAction(Msg: CMessage; const AName, AActivateBinding, ADeactivateBinding: string);
Protectedprocedure BindStandardControls; virtual;
Publicprocedure CreateCore(CoreClass: C2Core.CCore); virtual;
Publicprocedure DeleteAction(const AName: string);
Protectedprocedure EnumAll;
Protectedprocedure EnumModes;
Publicprocedure GotoURL(const URLFileName: string);
Publicprocedure HandleMessage(const Msg: TMessage); virtual;
Publicfunction LoadScene(const FileName: string): Boolean;
Publicprocedure LogOff;
Publicprocedure LogOn(UserName: string);
Publicprocedure ObtainViewportCenter(out X, Y: Integer); virtual;
Publicprocedure PreviewOptions(OptionName, Value: string); virtual;
Publicprocedure Process; virtual;
Protectedfunction UserNameToFileName(const UserName: string): string;

Description

Publicconstructor Create(const AProgramName: string; AStarter: TAppStarter); override;

 

Publicdestructor Destroy; override;

 

Protectedprocedure ApplyControls; virtual;

Applies controls

Publicprocedure ApplyOptions; virtual;

Applies all option sets

Publicprocedure ApplyOptionSet(const OptionSet: string); virtual;

Applies the specified option set. An option set is a grouped by category set of options. For example "VIDEOOPTIONS" set includes video mode options, gamma control options and so on.

Publicfunction ApplyVideoOptions: Boolean; virtual;

Applies video option set ("VIDEOOPTIONS")

Publicprocedure BindAction(Msg: CMessage; const AName, AActivateBinding, ADeactivateBinding: string);

Binds an action or message to the specified in AActivateBinding input event or a sequence of events. If Msg is not nil the message will be generated when the specified in AActivateBinding set of input events will occur. Otherwise an action named AName will be activated when input will match AActivateBinding and deactivated when input will match ADeactivateBinding.

Protectedprocedure BindStandardControls; virtual;

Binds default controls for some standard actions

Publicprocedure CreateCore(CoreClass: C2Core.CCore); virtual;

Creates engine core of the specified class and registers standard item classes

Publicprocedure DeleteAction(const AName: string);

Delete the specified action

Protectedprocedure EnumAll;

Enumerate video modes and users

Protectedprocedure EnumModes;

Enumerate video modes

Publicprocedure GotoURL(const URLFileName: string);

Opens the specified URL in system default browser. If application is operating in full screen mode it's minimized.

Publicprocedure HandleMessage(const Msg: TMessage); virtual;

Messages handler. Handles full screen toggling, forced quit, etc

Publicfunction LoadScene(const FileName: string): Boolean;

Loads a scene from the specified file and returns True if success

Publicprocedure LogOff;

Saves current user's profile and logs off the user

Publicprocedure LogOn(UserName: string);

Logs on a user with the specified name and loads its profile

Publicprocedure ObtainViewportCenter(out X, Y: Integer); virtual;

Fills X and Y with X and Y of current viewport center

Publicprocedure PreviewOptions(OptionName, Value: string); virtual;

Temporarily applies the specified value to the specified option for preview purposes

Publicprocedure Process; virtual;

Performs OS message processing (calls Starter.Process) and engine core processing. Should be called in main application cycle.

Protectedfunction UserNameToFileName(const UserName: string): string;

Returns profile file name by a user name

Last modified: 4 Jul, 2008
Copyright (C) 2006-2008, casteng.com