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
 BumpMap
org.ffilmation.utils BumpMap class From Ralph Hauwert's at UnitZeroOne (ralph
 fAiContainer
org.ffilmation.engine.core

This object provides access to the AI methods of the engine.

 fCamera
org.ffilmation.engine.core

The fCamera defines which part of the scene is shown.

 fCharacter
org.ffilmation.engine.elements

A Character is a dynamic object in the scene.

 fCollideEvent
org.ffilmation.engine.events

The fCollideEvent event class stores information about a collision event.

This event is dispatched when a character in the engine collides whith another solid element in the scene

 fElement
org.ffilmation.engine.core

The fElement class defines the basic structure of anything in a filmation Scene

All elements ( walls, floors, lights, cameras, etc ) inherit from fElement.

The fElement provides basic position and movement functionality

YOU CAN'T CREATE INSTANCES OF THIS OBJECT

 fEngine
org.ffilmation.engine.core

The fEngine class is the main class in the game engine.

Use the fEngine class to create and attach game scenes to your game.

You can also use it to load external swfs containing media you want to add to you scenes.

Once the scenes are created you can go from one to another using the methods in the fEngine class.

 fEngineElementController
org.ffilmation.engine.interfaces This interface defines methods that any class that is to be used as an element controller must implement.
 fEngineGenerator
org.ffilmation.engine.interfaces This interface defines methods that any class that is to be used as a generator must implement.
 fEngineMaterial
org.ffilmation.engine.interfaces This interface defines methods that any class that is to be used as a material in the engine must implement
 fEngineSceneController
org.ffilmation.engine.interfaces This interface defines methods that any class that is to be used as an scene controller must implement.
 fEngineSceneRetriever
org.ffilmation.engine.interfaces This interface defines methods that any class that is to be used to retrieve an scene XML must implement.
 fEventIn
org.ffilmation.engine.events

The fEventIn event class stores information about an IN event.

This event is dispatched whenever a character in the engine moves into a cell where an XML even was defined

 fEventOut
org.ffilmation.engine.events

The fEventIn event class stores information about an OUT event.

This event is dispatched whenever a character in the engine moves outside a cell where an XML event was defined

 fFloor
org.ffilmation.engine.elements

Arbitrary-sized tiles that form each floor in your scene

YOU CAN'T CREATE INSTANCES OF THIS OBJECT.
Floors are created when the scene is processed

 fGlobalLight
org.ffilmation.engine.core

The fGlobalLight class contains information about the global light of a scene.

 fLight
org.ffilmation.engine.core

The fLight is an abstract definition of a light that contains generic information such as intensity, size, decay and color.

 fMaterial
org.ffilmation.engine.core

Every Plane (walls and floors) in the scene is assigned a Material.

 fMoveEvent
org.ffilmation.engine.events

The fMoveEvent event class stores information about a move event.

This event is dispatched whenever an element in the engine changes position.

 fNoise
org.ffilmation.engine.core This object stores a perlin noise definition that was loaded from a definition file.
 fObject
org.ffilmation.engine.elements

An Object is a graphic element that is part of the the environment and is not projected in any way.

 fOmniLight
org.ffilmation.engine.elements

Spot light definition.

 fPlane
org.ffilmation.engine.core

fPlanes are the 2d surfaces that provide the main structure for any scene.

 fProcessEvent
org.ffilmation.engine.events

The fProcessEvent event class stores information about a process event.

Several processes in the filmation engine involve more than one subprocess, and this class stores info about the overall task that is being monitored as well as the status of the current subtask.

This allows to have progress bars that go something like:

Loading media file A.
 fRenderableElement
org.ffilmation.engine.core

The fRenderableElement class defines the basic interface for visible elements in your scene.

Lights are NOT considered visible elements, therefore don't inherit from fRenderableElement

YOU CAN'T CREATE INSTANCES OF THIS OBJECT

 fScatterGenerator
org.ffilmation.engine.generators The scatter generator is used to randomly fill an area with objects.
 fScene
org.ffilmation.engine.core

The fScene class provides control over a scene in your application.

 fSceneLoader
org.ffilmation.engine.scenes This is the simplest scene retriever class.
 fWalkoverEvent
org.ffilmation.engine.events

The fWalkoverEvent event class stores information about a Walkover event.

This event is dispatched when a character in the engine walks over a non-solid object in the scene.

 fWall
org.ffilmation.engine.elements

Walls are created when the scene is processed

YOU CAN'T CREATE INSTANCES OF THIS OBJECT.

 line
org.ffilmation.utils A line definition, 2 points
 mathUtils
org.ffilmation.utils This class provides various useful math methods
 movieClipUtils
org.ffilmation.utils This class provides various useful methods regarding movieClips
 polygonProjection
org.ffilmation.utils The result of projecting a polygon to an axis
 polygonUtils
org.ffilmation.utils This class provides several polygon algorythms
 Vector
org.ffilmation.utils A 2d Vector class
 vport
org.ffilmation.utils A rectangular viewport, used to clip polygons