Packageorg.flixel.plugin
Classpublic class DebugPathDisplay
InheritanceDebugPathDisplay Inheritance FlxBasic Inheritance Object

A simple manager for tracking and drawing FlxPath debug data to the screen.



Public Properties
 PropertyDefined By
 Inheritedactive : Boolean
Controls whether update() is automatically called by FlxState/FlxGroup.
FlxBasic
 Inherited_ACTIVECOUNT : uint
[static]
FlxBasic
 Inheritedalive : Boolean
Useful state for many game objects - "dead" (!alive) vs alive.
FlxBasic
 Inheritedcameras : Array
An array of camera objects that this object will use during draw().
FlxBasic
 Inheritedexists : Boolean
Controls whether update() and draw() are automatically called by FlxState/FlxGroup.
FlxBasic
 InheritedID : int
IDs seem like they could be pretty useful, huh? They're not actually used for anything yet though.
FlxBasic
 InheritedignoreDrawDebug : Boolean
Setting this to true will prevent the object from appearing when the visual debug mode in the debugger overlay is toggled on.
FlxBasic
 Inheritedvisible : Boolean
Controls whether draw() is automatically called by FlxState/FlxGroup.
FlxBasic
 Inherited_VISIBLECOUNT : uint
[static]
FlxBasic
Protected Properties
 PropertyDefined By
  _paths : Array
DebugPathDisplay
Public Methods
 MethodDefined By
  
Instantiates a new debug path display manager.
DebugPathDisplay
  
add(Path:FlxPath):void
Add a path to the path debug display manager.
DebugPathDisplay
  
clear():void
Removes all the paths from the path debug display manager.
DebugPathDisplay
  
destroy():void
[override] Clean up memory.
DebugPathDisplay
  
draw():void
[override] Called by FlxG.drawPlugins() after the game state has been drawn.
DebugPathDisplay
  
drawDebug(Camera:FlxCamera = null):void
[override] Similar to FlxObject's drawDebug() functionality, this function calls drawDebug() on each FlxPath for the specified camera.
DebugPathDisplay
 Inherited
kill():void
Handy function for "killing" game objects.
FlxBasic
 Inherited
postUpdate():void
Post-update is called right after update() on each object in the game loop.
FlxBasic
 Inherited
preUpdate():void
Pre-update is called right before update() on each object in the game loop.
FlxBasic
  
remove(Path:FlxPath):void
Remove a path from the path debug display manager.
DebugPathDisplay
 Inherited
revive():void
Handy function for bringing game objects "back to life".
FlxBasic
 Inherited
toString():String
Convert object to readable string name.
FlxBasic
 Inherited
update():void
Override this function to update your class's position and appearance.
FlxBasic
Property Detail
_pathsproperty
protected var _paths:Array

Constructor Detail
DebugPathDisplay()Constructor
public function DebugPathDisplay()

Instantiates a new debug path display manager.

Method Detail
add()method
public function add(Path:FlxPath):void

Add a path to the path debug display manager. Usually called automatically by FlxPath's constructor.

Parameters

Path:FlxPath — The FlxPath you want to add to the manager.

clear()method 
public function clear():void

Removes all the paths from the path debug display manager.

destroy()method 
override public function destroy():void

Clean up memory.

draw()method 
override public function draw():void

Called by FlxG.drawPlugins() after the game state has been drawn. Cycles through cameras and calls drawDebug() on each one.

drawDebug()method 
override public function drawDebug(Camera:FlxCamera = null):void

Similar to FlxObject's drawDebug() functionality, this function calls drawDebug() on each FlxPath for the specified camera. Very helpful for debugging!

Parameters

Camera:FlxCamera (default = null) — Which FlxCamera object to draw the debug data to.

remove()method 
public function remove(Path:FlxPath):void

Remove a path from the path debug display manager. Usually called automatically by FlxPath's destroy() function.

Parameters

Path:FlxPath — The FlxPath you want to remove from the manager.