CAST II Game Engine

Class TAppStarter

Unit

Declaration

type TAppStarter = class

Description

Application starter base class The class manages application startup process, creates window, forwards windows messages, etc

Fields

	Name	Description
	`CallDefaultMsgHandler`	Determines if a default window message handler should be called
	`FProgramExeDir`	Application .exe directory
	`FProgramExeName`	Application .exe file name
	`FProgramName`	Application name
	`FProgramVersionStr`	Application version string
	`FProgramWorkDir`	Application working directory
	`FWindowHandle`	Application window handle
	`FWindowStyle`	Application window style
	`HandleMessages`	Determines if message handling is needed. True by default.
	`InactiveSleepAmount`	Time to sleep in milliseconds when the application is not active (60 default)
	`MessageHandler`	A message handler to forward Window messages to

Methods

Overview

	`constructor Create(const AProgramName: string; AWindowProc: TWndProc; Options: TStarterOptions);`
	`destructor Destroy; override;`
	`function GetTerminated: Boolean; virtual;`
	`procedure Init; virtual;`
	`function isAlreadyRunning(ActivateExisting: Boolean): Boolean; virtual; abstract;`
	`procedure ParseParamStr; virtual;`
	`procedure PrintError(const Msg: string; ErrorType: TLogLevel); virtual; abstract;`
	`function Process: Boolean; virtual; abstract;`
	`function ProcessMessage(Msg: Longword; wParam: Integer; lParam: Integer): Integer; virtual;`
	`procedure Terminate; virtual;`

Description

constructor Create(const AProgramName: string; AWindowProc: TWndProc; Options: TStarterOptions);

Create and setup an application with the given name. If AWindowProc is nil a default procedure will be used.

destructor Destroy; override;

Immediate termination

function GetTerminated: Boolean; virtual;

Returns True if the application is terminated

procedure Init; virtual;

This method should be overridden for variables custom initialization

function isAlreadyRunning(ActivateExisting: Boolean): Boolean; virtual; abstract;

Returns True if another instance of the application is already rinning. If ActivateExisting is True the other instance will be activated.

procedure ParseParamStr; virtual;

This method should be overridden to do command line parameters parsing

procedure PrintError(const Msg: string; ErrorType: TLogLevel); virtual; abstract;

Prints an error information

function Process: Boolean; virtual; abstract;

Should be called each application cycle. Usally overridden to perform message processing. Returns negate value of Terminated property.

function ProcessMessage(Msg: Longword; wParam: Integer; lParam: Integer): Integer; virtual;

Windows message handler

procedure Terminate; virtual;

Set Terminated flag. Normally the application will be terminated as soon as possible.

Properties

Overview

	`property Active: Boolean;`
	`property ProgramExeDir: string;`
	`property ProgramExeName: string;`
	`property ProgramName: string;`
	`property ProgramWorkDir: string;`
	`property Terminated: Boolean;`
	`property WindowHandle: Cardinal;`
	`property WindowStyle: Cardinal;`

Description

property Active: Boolean;

True if the application's window is currently active

property ProgramExeDir: string;

Application .exe directory including trailing path delimiter

property ProgramExeName: string;

Application .exe file name

property ProgramName: string;

Application name

property ProgramWorkDir: string;

Application working directory including trailing path delimiter

property Terminated: Boolean;

True if the application is terminated

property WindowHandle: Cardinal;

Application window handle

property WindowStyle: Cardinal;

Application window style