| Package | artcustomer.maxima.context |
| Class | public class GameContext |
| Inheritance | GameContext  ServiceContext CrossPlatformInputsContext InteractiveContext EventContext Object |
| Method | Defined By | ||
|---|---|---|---|
GameContext(contextView:DisplayObjectContainer = null)
Constructor
| GameContext | ||
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Add an eventListener. | EventContext | |
| allowDomain(... rest):void
Allow a domain in application. | ServiceContext | |
| allowInsecureDomain(... rest):void
Allow an insecure domain in application. | ServiceContext | |
debug():String
Get Debug version of Context. | GameContext | ||
destroy():void [override]
Destroy the context. | GameContext | ||
| dispatchEvent(e:Event):Boolean
Dispatch an event. | EventContext | |
| dumpParameters():String
Get properties and values of Flash parameters in String format. | ServiceContext | |
| exitPlayer(code:uint = 0):void
Exit Flash Player. | ServiceContext | |
| getParameter(name:String):Object
Get Flash parameter by name. | ServiceContext | |
| hasEventListener(type:String):Boolean
Test an eventlistener. | EventContext | |
| hideLogo():void
Hide Framework logo. | InteractiveContext | |
| hideMenu():void
Hide Framework context menu. | InteractiveContext | |
infos():String
Get Debug version of Player. | GameContext | ||
| loadPolicyFile(url:String):void
Load policy file (XML Crossdomain). | ServiceContext | |
| move(x:int = 0, y:int = 0):void
Move the context view. | InteractiveContext | |
| moveLogo(align:String, verticalMargin:int = 0, horizontalMargin:int = 0):void
Move Framework logo. | InteractiveContext | |
| pausePlayer():void
Pause Flash Player
| ServiceContext | |
| refreshView():void
Refresh the context view. | InteractiveContext | |
| releaseMemory():void
Force the garbage collection process. | ServiceContext | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Remove an eventlistener. | EventContext | |
reset():void
Reset the context. | GameContext | ||
resize():void
Called by InteractiveContext during resizing. | GameContext | ||
| resumePlayer():void
Resume Flash Player
| ServiceContext | |
sendExternalMessage(message:String, id:String = null):void
Send external message from internal elements of the framework. | GameContext | ||
setup():void [override]
Setup the context. | GameContext | ||
| showLogo():void
Show Framework logo. | InteractiveContext | |
| showMenu():void
Show Framework context menu. | InteractiveContext | |
start():void
Start Game after called setup and set all core classes. | GameContext | ||
throwCustomError(error:Class, message:*, id:* = 0):void
Throw a custom Error. | GameContext | ||
throwError(message:*, id:* = 0):void
Throw an Error. | GameContext | ||
| toggleFullScreen():void
Switch Normal / FullScreen mode
| InteractiveContext | |
| willTrigger(type:String):Boolean
Test event trigger. | EventContext | |
| GameContext | () | Constructor |
Hide Inherited Public Methods
Show Inherited Public Methodspublic function GameContext(contextView:DisplayObjectContainer = null)Constructor
ParameterscontextView:DisplayObjectContainer (default = null) |
| debug | () | method |
public function debug():StringGet Debug version of Context.
ReturnsString —
|
| destroy | () | method |
override public function destroy():voidDestroy the context. Must be overrided and called at end.
| infos | () | method |
public function infos():StringGet Debug version of Player.
ReturnsString —
|
| reset | () | method |
public function reset():voidReset the context. Must be overrided.
| resize | () | method |
public final function resize():voidCalled by InteractiveContext during resizing. Don't call it !
| sendExternalMessage | () | method |
public function sendExternalMessage(message:String, id:String = null):voidSend external message from internal elements of the framework. Must be overrided.
Parameters
message:String | |
id:String (default = null) |
| setup | () | method |
override public function setup():voidSetup the context. Must be overrided and called at first.
| start | () | method |
public function start():voidStart Game after called setup and set all core classes. Override it !
| throwCustomError | () | method |
public function throwCustomError(error:Class, message:*, id:* = 0):voidThrow a custom Error.
Parameters
error:Class | |
message:* | |
id:* (default = 0) |
| throwError | () | method |
public function throwError(message:*, id:* = 0):voidThrow an Error.
Parameters
message:* | |
id:* (default = 0) |
| gameDestroy | Event |
| gamePause | Event |
| gameReset | Event |
| gameResume | Event |
| gameSetup | Event |