A powerful console for the flixel debugger screen with supports custom commands, registering objects and functions and saves the last 25 commands used. Inspired by Eric Smith's "CoolConsole".

See also:

Constructor

new(completionList:CompletionList)

Creates a new console window object.

Variables

@:value([])objectStack:Array<FlxObject> = []

Internal helper var containing all the FlxObjects created via the create command.

@:value(new Map<String,Dynamic>())registeredFunctions:Map<String, Dynamic> = new Map<String,Dynamic>()

Map containing all registered Functions. You can use registerFunction() or add them directly to this map.

@:value(new Map<String,String>())registeredHelp:Map<String, String> = new Map<String,String>()

Map containing all registered help text. Set these values from registerObject() or registerFunction().

@:value(new Map<String,Dynamic>())registeredObjects:Map<String, Dynamic> = new Map<String,Dynamic>()

Map containing all registered Objects. You can use registerObject() or add them directly to this map.

Methods

inlineregisterClass(c:Class<Dynamic>):Void

Register a new class to use in any command.

Parameters:

c

The class to register.

inlineregisterEnum(e:Enum<Dynamic>):Void

Register a new enum to use in any command.

Parameters:

e

The enum to register.

Available since

4.4.0

.

registerFunction(alias:String, func:Dynamic, ?helpText:String):Void

Register a new function to use in any command.

Parameters:

alias

The name with which you want to access the function.

func

The function to register.

helpText

An optional string to trace to the console using the "help" command.

registerObject(alias:String, object:Dynamic):Void

Register a new object to use in any command.

Parameters:

alias

The name with which you want to access the object.

object

The object to register.

removeByAlias(alias:String):Void

Removes an object or function from the command registry.

Parameters:

alias

The alias to remove.

Available since

5.4.0

.

inlineremoveClass(c:Class<Dynamic>):Void

Removes a class from the command registry.

Parameters:

c

The class to remove.

Available since

5.4.0

.

inlineremoveEnum(e:Enum<Dynamic>):Void

Removes an enum from the command registry.

Parameters:

e

The enum to remove.

Available since

5.4.0

.

@:has_untypedremoveFunction(func:Dynamic):Void

Removes a function from the command registry by searching through the list.

Note: removeByAlias is more performant.

Parameters:

func

The object to remove.

Available since

5.4.0

.

@:has_untypedremoveObject(object:Dynamic):Void

Removes an object from the command registry by searching through the list.

Note: removeByAlias is more performant.

Parameters:

object

The object to remove.

Available since

5.4.0

.

Inherited Variables

Defined by Window

Defined by Sprite

@:flash.propertybuttonMode:Bool

@:flash.propertyread onlydropTarget:DisplayObject

@:flash.propertyread onlygraphics:Graphics

@:flash.propertyhitArea:Sprite

@:flash.propertyuseHandCursor:Bool

Defined by DisplayObjectContainer

@:flash.propertymouseChildren:Bool

@:flash.propertyread onlynumChildren:Int

@:flash.propertytabChildren:Bool

@:flash.propertyread onlytextSnapshot:TextSnapshot

Defined by InteractiveObject

@:flash.propertycontextMenu:ContextMenu

@:flash.propertydoubleClickEnabled:Bool

@:flash.propertyfocusRect:Dynamic

@:flash.propertymouseEnabled:Bool

@:flash.property@:require(flash11)needsSoftKeyboard:Bool

@:flash.property@:require(flash11)softKeyboardInputAreaOfInterest:Rectangle

@:flash.propertytabEnabled:Bool

@:flash.propertytabIndex:Int

Defined by DisplayObject

@:flash.propertyalpha:Float

@:flash.propertyblendMode:BlendMode

@:flash.property@:require(flash10)write onlyblendShader:Shader

@:flash.propertycacheAsBitmap:Bool

@:flash.propertycacheAsBitmapMatrix:Matrix

@:flash.propertyfilters:Array<BitmapFilter>

@:flash.propertyheight:Float

@:flash.propertyread onlyloaderInfo:LoaderInfo

@:flash.propertymask:DisplayObject

@:flash.propertyread onlymouseX:Float

@:flash.propertyread onlymouseY:Float

@:flash.propertyname:String

@:flash.propertyopaqueBackground:Null<UInt>

@:flash.propertyread onlyparent:DisplayObjectContainer

@:flash.propertyread onlyroot:DisplayObject

@:flash.propertyrotation:Float

@:flash.property@:require(flash10)rotationX:Float

@:flash.property@:require(flash10)rotationY:Float

@:flash.property@:require(flash10)rotationZ:Float

@:flash.propertyscale9Grid:Rectangle

@:flash.propertyscaleX:Float

@:flash.propertyscaleY:Float

@:flash.property@:require(flash10)scaleZ:Float

@:flash.propertyscrollRect:Rectangle

@:flash.propertyshader:Shader

@:flash.propertyread onlystage:Stage

@:flash.propertytransform:Transform

@:flash.propertyvisible:Bool

@:flash.propertywidth:Float

@:flash.propertyx:Float

@:flash.propertyy:Float

@:flash.property@:require(flash10)z:Float

Inherited Methods

Defined by Window

bound():Void

Keep the window within the pre-specified bounding rectangle.

inlineputOnTop():Void

resize(Width:Float, Height:Float):Void

Resize the window. Subject to pre-specified minimums, maximums, and bounding rectangles.

Parameters:

Width

How wide to make the window.

Height

How tall to make the window.

Defined by Sprite

@:value({ bounds : null, lockCenter : false })startDrag(lockCenter:Bool = false, ?bounds:Null<Rectangle>):Void

@:value({ bounds : null, lockCenter : false })@:require(flash10_1)startTouchDrag(touchPointID:Int, lockCenter:Bool = false, ?bounds:Null<Rectangle>):Void

@:require(flash10_1)stopTouchDrag(touchPointID:Int):Void

Defined by DisplayObjectContainer

Defined by InteractiveObject

@:require(flash11)requestSoftKeyboard():Bool

Defined by DisplayObject

getBounds(targetCoordinateSpace:DisplayObject):Rectangle

getRect(targetCoordinateSpace:DisplayObject):Rectangle

@:require(flash10)globalToLocal3D(point:Point):Vector3D

@:value({ shapeFlag : false })hitTestPoint(x:Float, y:Float, shapeFlag:Bool = false):Bool

@:require(flash10)local3DToGlobal(point3d:Vector3D):Point

Defined by EventDispatcher

@:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

@:value({ useCapture : false })removeEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false):Void