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.


 ClassPackageDescription
 AnimatedComponent
com.pblabs.engine.components Base class for components that need to perform actions every frame.
 AnimationController
com.pblabs.rendering2D Manage sprite sheet and frame selection based on named animation definitions.
 AnimationControllerInfo
com.pblabs.rendering2D Information describing an animation, for use in an AnimationController.
 AnimationEvent
com.pblabs.animation Event type used by the Animator class to indicate when certain playback events have happened.
 Animator
com.pblabs.animation Class for animating between a start value and end value.
 AnimatorComponent
com.pblabs.animation Component for animating any value on its owner.
 AnimatorType
com.pblabs.animation An enumeration that holds all the possible values for a type of animation.
 b2AABB
Box2D.Collision 
 b2Body
Box2D.Dynamics 
 b2BodyDef
Box2D.Dynamics 
 b2Bound
Box2D.Collision 
 b2BoundaryListener
Box2D.Dynamics 
 b2BoundValues
Box2D.Collision 
 b2BroadPhase
Box2D.Collision 
 b2BufferedPair
Box2D.Collision 
 b2CircleContact
Box2D.Dynamics.Contacts 
 b2CircleDef
Box2D.Collision.Shapes 
 b2CircleShape
Box2D.Collision.Shapes 
 b2Collision
Box2D.Collision 
 b2Color
Box2D.Common 
 b2Contact
Box2D.Dynamics.Contacts 
 b2ContactConstraint
Box2D.Dynamics.Contacts 
 b2ContactConstraintPoint
Box2D.Dynamics.Contacts 
 b2ContactEdge
Box2D.Dynamics.Contacts 
 b2ContactFilter
Box2D.Dynamics 
 b2ContactID
Box2D.Collision 
 b2ContactListener
Box2D.Dynamics 
 b2ContactManager
Box2D.Dynamics 
 b2ContactPoint
Box2D.Collision 
 b2ContactRegister
Box2D.Dynamics.Contacts 
 b2ContactResult
Box2D.Dynamics.Contacts 
 b2ContactSolver
Box2D.Dynamics.Contacts 
 b2DebugDraw
Box2D.Dynamics 
 b2DestructionListener
Box2D.Dynamics 
 b2Distance
Box2D.Collision 
 b2DistanceJoint
Box2D.Dynamics.Joints 
 b2DistanceJointDef
Box2D.Dynamics.Joints 
 b2FilterData
Box2D.Collision.Shapes 
 b2GearJoint
Box2D.Dynamics.Joints 
 b2GearJointDef
Box2D.Dynamics.Joints 
 b2Island
Box2D.Dynamics 
 b2Jacobian
Box2D.Dynamics.Joints 
 b2Joint
Box2D.Dynamics.Joints 
 b2JointDef
Box2D.Dynamics.Joints 
 b2JointEdge
Box2D.Dynamics.Joints 
 b2Manifold
Box2D.Collision 
 b2ManifoldPoint
Box2D.Collision 
 b2MassData
Box2D.Collision.Shapes 
 b2Mat22
Box2D.Common.Math 
 b2Math
Box2D.Common.Math 
 b2MouseJoint
Box2D.Dynamics.Joints 
 b2MouseJointDef
Box2D.Dynamics.Joints 
 b2NullContact
Box2D.Dynamics.Contacts 
 b2OBB
Box2D.Collision 
 b2Pair
Box2D.Collision 
 b2PairCallback
Box2D.Collision 
 b2PairManager
Box2D.Collision 
 b2Point
Box2D.Collision 
 b2PolyAndCircleContact
Box2D.Dynamics.Contacts 
 b2PolygonContact
Box2D.Dynamics.Contacts 
 b2PolygonDef
Box2D.Collision.Shapes 
 b2PolygonShape
Box2D.Collision.Shapes 
 b2PrismaticJoint
Box2D.Dynamics.Joints 
 b2PrismaticJointDef
Box2D.Dynamics.Joints 
 b2Proxy
Box2D.Collision 
 b2PulleyJoint
Box2D.Dynamics.Joints 
 b2PulleyJointDef
Box2D.Dynamics.Joints 
 b2RevoluteJoint
Box2D.Dynamics.Joints 
 b2RevoluteJointDef
Box2D.Dynamics.Joints 
 b2Segment
Box2D.Collision 
 b2Settings
Box2D.Common 
 b2Shape
Box2D.Collision.Shapes 
 b2ShapeDef
Box2D.Collision.Shapes 
 b2Sweep
Box2D.Common.Math 
 b2TimeOfImpact
Box2D.Collision 
 b2TimeStep
Box2D.Dynamics 
 b2Vec2
Box2D.Common.Math 
 b2World
Box2D.Dynamics 
 b2XForm
Box2D.Common.Math 
 BackgroundMusicComponent
com.pblabs.sound Simple component to manage background music.
 BaseScreen
com.pblabs.screens Most basic implementation of IScreen.
 BasicSpatialManager2D
com.pblabs.rendering2D Basic 2d spatial manager that stores everything in a list.
 BasicState
com.pblabs.components.stateMachine Simple state that allows for generic transition rules.
 BasicThinkingState
com.pblabs.components.stateMachine 
 BitmapDataScene
com.pblabs.rendering2D A scene which draws to a BitmapData.
 BitmapRenderer
com.pblabs.rendering2D Simple way to render a bitmap to a scene.
 BloomModifier
com.pblabs.rendering2D.modifier 
 BlurModifier
com.pblabs.rendering2D.modifier 
 BorderModifier
com.pblabs.rendering2D.modifier 
 Box2DDebugComponent
com.pblabs.box2D Helper component to visualize Box2D debug state.
 Box2DManagerComponent
com.pblabs.box2D 
 Box2DSpatialComponent
com.pblabs.box2D Wraps a b2Body for use with a Box2DManagerComponent and integration into PushButton Engine.
 BuildVersion
com.pblabs.engine.version 
 BulkLoader
br.com.stimuli.loading Manages loading for simultaneous items and multiple formats.
 BulkLoaderResourceProvider
com.pblabs.engine.resource.provider The BulkLoaderResourceProvider provides the ResourceManager with resources that are loaded using this provider's BulkLoader instance
 BulkProgressEvent
br.com.stimuli.loading An event that holds information about the status of a BulkLoader.
 CellCountDivider
com.pblabs.rendering2D.spritesheet Divide a spritesheet into cells based on count - ie, 4 cells by 3 cells.
 CircleCollisionShape
com.pblabs.box2D 
 ClipVertex
Box2D.Collision 
 CollisionEvent
com.pblabs.box2D 
 CollisionShape
com.pblabs.box2D 
 ColorizeModifier
com.pblabs.rendering2D.modifier 
 Console
com.pblabs.engine.debug Process simple text commands from the user.
 ContactFilter
com.pblabs.box2D 
 ContactListener
com.pblabs.box2D 
 DataComponent
com.pblabs.engine.components Container for arbitrary data.
 DataResource
com.pblabs.engine.resource This is a Resource subclass for arbitrary data.
 DeathState
com.pblabs.components.stateMachine State which destroys its owning container when it is entered.
 DelayState
com.pblabs.components.stateMachine State that enforces a delay (measured in ticks) before attempting to transition.
 DisplayObjectRenderer
com.pblabs.rendering2D Base renderer for Rendering2D.
 DisplayObjectScene
com.pblabs.rendering2D Basic Rendering2D scene; it is given a SceneView and some DisplayObjectRenderers, and makes sure that they are drawn.
 DisplayObjectSceneLayer
com.pblabs.rendering2D Layer within a DisplayObjectScene which manages a list of DisplayObjectRenderers.
 EmbeddedResourceProvider
com.pblabs.engine.resource.provider The EmbeddedResourceProvider provides the ResourceManager with the embedded resources that were loaded from ResourceBundle and ResourceBinding classes This class works using a singleton pattern so when resource bundles and/or resource bindings are initialized they will register the resources with the EmbeddedResourceProvider.instance
 EntityComponent
com.pblabs.engine.entity An implementation of the IEntityComponent interface, providing all the basic functionality required of all components.
 Enumerable
com.pblabs.engine.serialization Base class that implements common functionality for enumeration classes.
 EventSoundTrigger
com.pblabs.components.basic Play sounds when events are triggered on an entity.
 ExceptionAppender
com.pblabs.engine.debug 
 FallbackResourceProvider
com.pblabs.engine.resource.provider The LoadedResourceProvider is used by the ResourceManager to request resources that no other resource provider can provide.
 Features
Box2D.Collision 
 FixedSizeDivider
com.pblabs.rendering2D.spritesheet Divide a sprite sheet into fixed-size cells.
 FlexSceneView
com.pblabs.rendering2D.ui 
 FlexSDKVersion
com.pblabs.engine.version Utility class to parse Flex SDK version strings.
 FrameAnimator
com.pblabs.animation Class for spritesheet frameIndex animation ( from start frame number to end frame number )
 FSMComponent
com.pblabs.components.stateMachine Component that wraps a state machine and updates it based on game ticks.
 GlowModifier
com.pblabs.rendering2D.modifier 
 GlyphCache
com.pblabs.engine.debug Helper class to cache glyphs as bitmaps and draw them fast, with color.
 GoogleSpreadsheetTweaker
com.pblabs.tweaker Put values from a Google Spreadsheet into your game for tweaking purposes.
 GrayscaleModifier
com.pblabs.rendering2D.modifier 
 GroupManagerComponent
com.pblabs.engine.components Utility class to manage a group of entities marked with GroupManagerComponent.
 GroupMemberComponent
com.pblabs.engine.components Helper component to group entities.
 GroupReference
com.pblabs.engine.mxml The GroupReference class is meant to be used as an MXML tag to associate groups with level numbers in the LevelManager.
 HealthComponent
com.pblabs.components.basic General purpose component for tracking health.
 HealthEvent
com.pblabs.components.basic Event fired by the HealthComponent on the entity when health changes.
 IAnimatedObject
com.pblabs.engine.core This interface should be implemented by objects that need to perform actions every frame.
 ICachingLayer
com.pblabs.rendering2D Interface for a scene layer which does caching and needs to know when a renderer has changed its state.
 ICopyPixelsRenderer
com.pblabs.rendering2D This interface is implemented by objects that support a fast bitmap render path.
 IEntity
com.pblabs.engine.entity Game objects in PBE are referred to as entities.
 IEntityComponent
com.pblabs.engine.entity A component in PBE is used to define specific pieces of functionality for game entities.
 ILayerMouseHandler
com.pblabs.rendering2D Implemented by layers which do their own entities-under-point logic.
 ILogAppender
com.pblabs.engine.debug 
 IMachine
com.pblabs.components.stateMachine Base interface for a finite state machine.
 ImageResource
com.pblabs.engine.resource This is a Resource subclass for image data.
 ImageScreen
com.pblabs.screens Simple screen to display an image.
 IMobileSpatialObject2D
com.pblabs.rendering2D Interface that provides mobile spatial information.
 InputKey
com.pblabs.engine.core Enumeration class that maps friendly key names to their key code equivalent.
 InputManager
com.pblabs.engine.core The input manager wraps the default input events produced by Flash to make them more game friendly.
 InputMap
com.pblabs.engine.core This class wraps the InputManager to allow for better control over input events.
 Interpolated2DMoverComponent
com.pblabs.rendering2D A simple spatial component which moves towards a goal point and heading.
 IPBObject
com.pblabs.engine.core Interface for a named object that can exist in a group or set.
 IPrioritizable
com.pblabs.engine.core Minimal interface required by SimplePriorityQueue.
 IPropertyBag
com.pblabs.engine.entity Minimal interface for accessing properties on some object.
 IQueuedObject
com.pblabs.engine.core An object which will be called back at a specific time.
 IResourceProvider
com.pblabs.engine.resource.provider This interface should be implemented by objects that can provide resources to the resourceManager
 IScene2D
com.pblabs.rendering2D Base interface for a 2d scene.
 IScreen
com.pblabs.screens Interface for a screen which can be managed by the ScreenManager.
 ISerializable
com.pblabs.engine.serialization Provides an interface for objects to override the default serialization behavior.
 ISoundHandle
com.pblabs.sound A reference to an actively playing sound.
 ISoundManager
com.pblabs.sound Interface for sound managers.
 ISpatialManager2D
com.pblabs.rendering2D Basic interface for 2D spatial database.
 ISpatialObject2D
com.pblabs.rendering2D Object with extents and ability to be ray-casted.
 ISpriteSheetDivider
com.pblabs.rendering2D.spritesheet Base interface for descriptions about how frames are laid out in a sprite sheet.
 IState
com.pblabs.components.stateMachine A state in a state machine.
 IThinkingState
com.pblabs.components.stateMachine 
 ITickedObject
com.pblabs.engine.core This interface should be implemented by objects that need to perform actions every tick, such as moving, or processing collision.
 ITransition
com.pblabs.components.stateMachine Transition interface used by BasicState.
 IUITarget
com.pblabs.rendering2D.ui Interface a UI element must implement to work with the DisplayObjectScene or its subclasses.
 JavascriptLogListener
com.pblabs.engine.debug Simple listener to dump log events out to javascript.
 JSON
com.adobe.serialization.json This class provides encoding and decoding of the JSON format.
 JSONDecoder
com.adobe.serialization.json 
 JSONEncoder
com.adobe.serialization.json 
 JSONParseError
com.adobe.serialization.json 
 JSONToken
com.adobe.serialization.json 
 JSONTokenizer
com.adobe.serialization.json 
 JSONTokenType
com.adobe.serialization.json Class containing constant values for the different types of tokens in a JSON encoded string.
 LazyBulkLoader
br.com.stimuli.loading.lazyloaders A serialized version of af BulkLoader instance.
 LazyJSONLoader
br.com.stimuli.loading.lazyloaders 
 LazyXMLLoader
br.com.stimuli.loading.lazyloaders 
 LevelEvent
com.pblabs.engine.core The LevelEvent is used by the LevelManager to dispatch information about the loaded status of levels.
 LevelFileReference
com.pblabs.engine.mxml The LevelFileReference class is meant to be used as an MXML tag to associate level files with level numbers in the LevelManager.
 LevelManager
com.pblabs.engine.core The LevelManager allows level files and groups to be added to a specific level so they can be automatically managed when that level is loaded or unloaded.
 LoadingItem
br.com.stimuli.loading.loadingtypes An class used in BulkLoader instances..
 LogColor
com.pblabs.engine.debug 
 LogEntry
com.pblabs.engine.debug Log entries are automatically created by the various methods on the Logger class to store information related to an entry in the log.
 LogEvent
com.pblabs.engine.debug A LogEvent is an event used by the Logger to dispatch log related information.
 Logger
com.pblabs.engine.debug The Logger class provides mechanisms to print and listen for errors, warnings, and general messages.
 LogViewer
com.pblabs.engine.debug Console UI, which shows console log activity in-game, and also accepts input from the user.
 Machine
com.pblabs.components.stateMachine Implementation of IMachine; probably any custom FSM would be based on this.
 MachineDescription
com.pblabs.components.stateMachine 
 Modifier
com.pblabs.rendering2D.modifier 
 MovieClipRenderer
com.pblabs.rendering2D Renderer which is for displaying MovieClips/SWFs and playing their animation correctly.
 MP3Resource
com.pblabs.engine.resource Load Sounds from MP3s using Flash Player's built in MP3 loading code.
 MultiSpriteSheetHelper
com.pblabs.rendering2D.spritesheet Helper to manage many similar sprite sheets (for instance, multiple sheets for the same character).
 NameManager
com.pblabs.engine.core The name manager stores references to PBObjects that have been given names.
 ObjectType
com.pblabs.engine.core An ObjectType is an abstraction of a bitmask that can be used to associate objects with type names.
 ObjectTypeManager
com.pblabs.engine.core The ObjectTypeManager, together with the ObjectType class, is essentially an abstraction of a bitmask to allow objects to be identified with friendly names, rather than complicated numbers.
 OrderedArray
com.pblabs.engine.core An ordered associative array with a working length property.
 PBButton
com.pblabs.rendering2D.ui Simple button for use in creating simple UIs.
 PBE
com.pblabs.engine Utility class to simplify working with PushButton Engine.
 PBGroup
com.pblabs.engine.core A group which owns the objects contained it.
 PBLabel
com.pblabs.rendering2D.ui Simple label for simple UIs.
 PBObject
com.pblabs.engine.core Base implementation of a named object that can exist in PBSets or PBGroups.
 PBScrollBar
com.pblabs.rendering2D.ui Simple Scroll Bar for use in creating simple UIs.
 PBSet
com.pblabs.engine.core Set of PBObjects.
 PBUtil
com.pblabs.engine Contains math related utility methods.
 PlaceholderScreen
com.pblabs.screens Simple placeholder screen which has a background fill and a caption in the top left.
 PointAnimator
com.pblabs.animation Animator subclass for animating the flash.geom.Point class.
 PolygonCollisionShape
com.pblabs.box2D 
 ProcessManager
com.pblabs.engine.core The process manager manages all time related functionality in the engine.
 Profiler
com.pblabs.engine.debug Simple, static hierarchical block profiler.
 PropertyReference
com.pblabs.engine.entity A property reference stores the information necessary to lookup a property on an entity.
 PropertyTransition
com.pblabs.components.stateMachine Check that a component container property evaluates to some value before changing state.
 PulsatingGlowModifier
com.pblabs.rendering2D.modifier.animating 
 RayHitInfo
com.pblabs.rendering2D Information about the results of a ray cast.
 ReflectionModifier
com.pblabs.rendering2D.modifier 
 RenderCacheKeyManager
com.pblabs.rendering2D Helper class to manage RenderCacheKey values; basically just a global int that we can increment to get new values to trigger cache invalidation.
 Resource
com.pblabs.engine.resource A resource contains data for a specific type of game asset.
 ResourceBinding
com.pblabs.engine.mxml The ResourceBinding class is meant to be used as an MXML tag to embed resources in the project's resulting .swf file.
 ResourceBundle
com.pblabs.engine.resource The resource bundle handles automatic loading and registering of embedded resources.
 ResourceEvent
com.pblabs.engine.resource A ResourceEvent is an Event used by a Resource to dispatch load status information.
 ResourceManager
com.pblabs.engine.resource The resource manager handles all tasks related to using asset files (images, xml, etc) in a project.
 ResourceProviderBase
com.pblabs.engine.resource.provider The ResourceProviderBase class can be extended to create a ResourceProvider that will auto register with the ResourceManager
 SceneAlignment
com.pblabs.rendering2D Helper class for controlling alignment of scene relative to its position.
 SceneView
com.pblabs.rendering2D.ui This class can be set as the SceneView on the BaseSceneComponent class and is used as the canvas to draw the objects that make up the scene.
 SchemaGenerator
com.pblabs.engine.core This class generates a schema file for the application so it can be edited by the PBEditor.
 ScreenManager
com.pblabs.screens A simple system for managing a game's UI.
 Serializer
com.pblabs.engine.serialization Singleton class for serializing and deserializing objects.
 SimplePriorityQueue
com.pblabs.engine.core A priority queue to manage prioritized data.
 SimpleShapeRenderer
com.pblabs.rendering2D Draw a simple shape, a box or a circle, with color.
 SimpleSpatialComponent
com.pblabs.rendering2D Very basic spatial component that exists at a position.
 SizeModifier
com.pblabs.rendering2D.modifier 
 SmartURL
br.com.stimuli.loading.utils 
 SoundCategory
com.pblabs.sound State pertaining to a whole category of sounds.
 SoundManager
com.pblabs.sound This class implements the ISoundManager interface.
 SoundResource
com.pblabs.engine.resource Parent class for any resources which provide Sound objects.
 SplashScreen
com.pblabs.screens Simple screen to display an image, and advance to another screen when the user clicks.
 SpriteContainerComponent
com.pblabs.rendering2D.spritesheet An abstract class to allow access to a set of sprites.
 SpriteRenderer
com.pblabs.rendering2D Render Component that will load and render a ImageResource as a Sprite
 SpriteSheetComponent
com.pblabs.rendering2D.spritesheet Handles loading and retrieving data about a sprite sheet to use for rendering.
 SpriteSheetRenderer
com.pblabs.rendering2D 
 Stats
com.pblabs.engine.debug 
 SWFResource
com.pblabs.engine.resource This is a Resource subclass for SWF files.
 SWFSpriteSheetComponent
com.pblabs.rendering2D.spritesheet A class that is similar to the SpriteSheetComponent except the frames are loaded by rasterizing frames from a MovieClip rather than splitting a single image.
 TemplateEvent
com.pblabs.engine.core The TemplateEvent is used by the TemplateManager to dispatch information about the loaded status of groups.
 TemplateManager
com.pblabs.engine.core The template manager loads and unloads level files and stores information about their contents.
 TestForMetadata
com.pblabs.engine.serialization Helper class to make sure metadata is being included.
 ThinkingComponent
com.pblabs.engine.components Base class for components which want to use think notifications.
 ThinkingMachineInstance
com.pblabs.components.stateMachine A state machine which shares its description with other machines.
 TickedComponent
com.pblabs.engine.components Base class for components that need to perform actions every tick.
 TraceAppender
com.pblabs.engine.debug Simply dump log activity via trace().
 Transition
com.pblabs.components.stateMachine Basic, always-on transition.
 TransitionEvent
com.pblabs.components.stateMachine Machine fires this event whenever it changes state.
 TweakerMapEntry
com.pblabs.tweaker Map a cell (specified in standard spreadsheet notation, ie E4) to a PropertyReference.
 TweakerMapGroup
com.pblabs.tweaker 
 Tween
com.pblabs.animation The Tween Class can be used to tween values of an object or to tween a value of a PropertyReference It support things like; looping tweens, pingpong tweens, play count , play time and starting delay.
 TweenComponent
com.pblabs.animation The TweenComponent can be used to start tweens in an entity.
 TweenController
com.pblabs.animation 
 TypeReference
com.pblabs.engine.mxml The TypeReference class is meant to be used as an MXML tag to force inclusion of specific types in a project.
 TypeUtility
com.pblabs.engine.serialization TypeUtility is a static class containing methods that aid in type introspection and reflection.
 UIAppender
com.pblabs.engine.debug LogAppender for displaying log messages in a LogViewer.
 VersionDetails
com.pblabs.engine.version Utility class to store version information.
 VersionType
com.pblabs.engine.version Enumeration of different runtime types.
 VersionUtil
com.pblabs.engine.version Utility class to determine the version of the Flex SDK we are compiled against, and what runtime we are on.
 XMLResource
com.pblabs.engine.resource This is a Resource subclass for XML data.