forked from AdamAtomic/flixel
/
class-summary.html
60 lines (59 loc) · 21.8 KB
/
class-summary.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>All Classes</title><link rel="stylesheet" href="style.css" type="text/css" media="screen"><link rel="stylesheet" href="print.css" type="text/css" media="print"><link rel="stylesheet" href="override.css" type="text/css"></head><body><script language="javascript" type="text/javascript" src="asdoc.js"></script><script language="javascript" type="text/javascript" src="help.js"></script><script language="javascript" type="text/javascript" src="cookies.js"></script><script language="javascript" type="text/javascript"><!--
asdocTitle = 'All Classes - API Documentation';
var baseRef = '';
window.onload = configPage;
--></script>
<script type="text/javascript">
scrollToNameAnchor();
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">API Documentation</td><td class="titleTableTopNav" align="right"><a href="package-summary.html" onclick="loadClassListFrame('all-classes.html')">All Packages</a> | <a href="all-index-A.html" onclick="loadClassListFrame('index-list.html')">Index</a> | <a id="framesLink1" href="index.html?class-summary.html&all-classes.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="images/logo.jpg" class="logoImage" alt=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">All Classes</td><td class="titleTableSubNav" id="subNav" align="right"></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("All Classes"); titleBar_setSubNav(false,false,false,false,false,false,false,false,false,false,false ,false,false,false,false,false);}
-->
</script><div class="MainContent"><br><p>Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.</p><br><table cellpadding="3" cellspacing="0" class="summaryTable"><tr><th> </th><th width="20%">Class</th><th width="20%">Package</th><th width="60%">Description</th></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/plugin/DebugPathDisplay.html">DebugPathDisplay</a><br></td><td class="summaryTableCol"><a href="org/flixel/plugin/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/plugin/class-list.html');">org.flixel.plugin</a></td><td class="summaryTableLastCol">
A simple manager for tracking and drawing FlxPath debug data to the screen.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxAnim.html">FlxAnim</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
Just a helper structure for the FlxSprite animation system.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxBasic.html">FlxBasic</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is a useful "generic" Flixel object.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxButton.html">FlxButton</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
A simple button class that calls a function when clicked by the mouse.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxCamera.html">FlxCamera</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
The camera class is used to display the game's visuals in the Flash player.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxDebugger.html">FlxDebugger</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
Container for the new debugger overlay.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxEmitter.html">FlxEmitter</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
FlxEmitter is a lightweight particle emitter.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxG.html">FlxG</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is a global helper class full of useful functions for audio,
input, basic info, and the camera system among other things.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxGame.html">FlxGame</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
FlxGame is the heart of all flixel games, and contains a bunch of basic game loops and things.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxGroup.html">FlxGroup</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is an organizational class that can update and render a bunch of FlxBasics.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxList.html">FlxList</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
A miniature linked list class.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxObject.html">FlxObject</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is the base class for most of the display objects (FlxSprite, FlxText, etc).</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxParticle.html">FlxParticle</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is a simple particle class that extends the default behavior
of FlxSprite to have slightly more specialized behavior
common to many game scenarios.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxPath.html">FlxPath</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is a simple path data container.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxPoint.html">FlxPoint</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
Stores a 2D floating point coordinate.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxPreloader.html">FlxPreloader</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
This class handles the 8-bit style preloader.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxQuadTree.html">FlxQuadTree</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
A fairly generic quad tree structure for rapid overlap checks.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxRect.html">FlxRect</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
Stores a rectangle.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxReplay.html">FlxReplay</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
The replay object both records and replays game recordings,
as well as handle saving and loading replays to and from files.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxSave.html">FlxSave</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
A class to help automate and simplify save game functionality.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxSound.html">FlxSound</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is the universal flixel sound object, used for streaming, music, and sound effects.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxSprite.html">FlxSprite</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
The main "game object" class, the sprite is a FlxObject
with a bunch of graphics options and abilities, like animation and stamping.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxState.html">FlxState</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is the basic game "state" object - e.g.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxText.html">FlxText</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
Extends FlxSprite to support rendering text.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxTile.html">FlxTile</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
A simple helper object for FlxTilemap that helps expand collision opportunities and control.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxTileblock.html">FlxTileblock</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is a basic "environment object" class, used to create simple walls and floors.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxTilemap.html">FlxTilemap</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
This is a traditional tilemap display and collision class.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxTilemapBuffer.html">FlxTilemapBuffer</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
A helper object to keep tilemap drawing performance decent across the new multi-camera system.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxTimer.html">FlxTimer</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol">
A simple timer class, leveraging the new plugins system.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/FlxU.html">FlxU</a><br></td><td class="summaryTableCol"><a href="org/flixel/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/class-list.html');">org.flixel</a></td><td class="summaryTableLastCol"> </td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/FlxWindow.html">FlxWindow</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/class-list.html');">org.flixel.system</a></td><td class="summaryTableLastCol">
A generic, Flash-based window class, created for use in FlxDebugger.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/replay/FrameRecord.html">FrameRecord</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/replay/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/replay/class-list.html');">org.flixel.system.replay</a></td><td class="summaryTableLastCol">
Helper class for the new replay system.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/input/Input.html">Input</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/input/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/input/class-list.html');">org.flixel.system.input</a></td><td class="summaryTableLastCol">
Basic input class that manages the fast-access Booleans and detailed key-state tracking.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/input/Keyboard.html">Keyboard</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/input/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/input/class-list.html');">org.flixel.system.input</a></td><td class="summaryTableLastCol">
Keeps track of what keys are pressed and how with handy booleans or strings.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/debug/Log.html">Log</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/debug/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/debug/class-list.html');">org.flixel.system.debug</a></td><td class="summaryTableLastCol">
A simple trace output window for use in the debugger overlay.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/input/Mouse.html">Mouse</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/input/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/input/class-list.html');">org.flixel.system.input</a></td><td class="summaryTableLastCol">
This class helps contain and track the mouse pointer in your game.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/replay/MouseRecord.html">MouseRecord</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/replay/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/replay/class-list.html');">org.flixel.system.replay</a></td><td class="summaryTableLastCol">
A helper class for the frame records, part of the replay/demo/recording system.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/debug/Perf.html">Perf</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/debug/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/debug/class-list.html');">org.flixel.system.debug</a></td><td class="summaryTableLastCol">
A simple performance monitor widget, for use in the debugger overlay.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/plugin/TimerManager.html">TimerManager</a><br></td><td class="summaryTableCol"><a href="org/flixel/plugin/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/plugin/class-list.html');">org.flixel.plugin</a></td><td class="summaryTableLastCol">
A simple manager for tracking and updating game timer objects.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/debug/VCR.html">VCR</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/debug/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/debug/class-list.html');">org.flixel.system.debug</a></td><td class="summaryTableLastCol">
This class contains the record, stop, play, and step 1 frame buttons seen on the top edge of the debugger overlay.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/debug/Vis.html">Vis</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/debug/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/debug/class-list.html');">org.flixel.system.debug</a></td><td class="summaryTableLastCol">
This control panel has all the visual debugger toggles in it, in the debugger overlay.</td></tr><tr class="prow0"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/debug/Watch.html">Watch</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/debug/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/debug/class-list.html');">org.flixel.system.debug</a></td><td class="summaryTableLastCol">
A Visual Studio-style "watch" window, for use in the debugger overlay.</td></tr><tr class="prow1"><td class="summaryTablePaddingCol"> </td><td class="summaryTableSecondCol"><a href="org/flixel/system/debug/WatchEntry.html">WatchEntry</a><br></td><td class="summaryTableCol"><a href="org/flixel/system/debug/package-detail.html" onclick="javascript:loadClassListFrame('org/flixel/system/debug/class-list.html');">org.flixel.system.debug</a></td><td class="summaryTableLastCol">
Helper class for the debugger overlay's Watch window.</td></tr></table><p></p><center class="copyright"><footer></footer><br/>Wed May 25 2011, 09:29 AM -05:00 </center></div></body></html><!--<br/>Wed May 25 2011, 09:29 AM -05:00 -->