Packageorg.ffilmation.engine.elements
Classpublic class fObject
InheritancefObject Inheritance fRenderableElement Inheritance fElement Inheritance flash.events.EventDispatcher
SubclassesfCharacter

An Object is a graphic element that is part of the the environment and is not projected in any way. The library item is attached to the scene as is. Objects cast and receive shadows.

Trees, statues and furniture are typical examples of objects.

Objects can't be moved and can't be added/removed dynamically because this allows several rendering optimizations. If you want to move something or add/remove it on the fly use the "Character" class instead

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

See also

org.ffilmation.engine.elements.fCharacter

Public Properties
 PropertyDefined by
 InheritedcastShadows : Boolean = true
Boolean value indicating if this object casts shadows.
fRenderableElement
 InheritedflashClip : MovieClip
A reference to the library movieclip that was attached to create the element, so you can acces methods inside, nested clips or whatever
fRenderableElement
  height : Number
The height in pixels of an imaginary cilinder enclosing the object.
fObject
 Inheritedid : String
The string identifier of this element.
fElement
  orientation : Number
The orientation (in degrees) of the object along the Z axis.
fObject
  radius : Number
[read-only] The radius in pixels of an imaginary cilinder enclosing the object.
fObject
 InheritedreceiveLights : Boolean = true
Boolean value indicating if this object receives lighting.
fRenderableElement
 InheritedreceiveShadows : Boolean = true
Boolean value indicating if this object receives shadows.
fRenderableElement
 Inheritedsolid : Boolean = true
Boolean value indicating if this object collides with others.
fRenderableElement
 Inheritedx : Number
X coordinate fot this element
fElement
 Inheritedy : Number
Y coordinate for this element
fElement
 Inheritedz : Number
Z coordinate for this element
fElement
Protected Properties
 PropertyDefined by
 InheritedcontainerParent : DisplayObjectContainer
fRenderableElement
Public Methods
 MethodDefined by
  
call(what:String, param:* = null):void
Calls a function of the base clip
fObject
 Inherited
distanceTo(x:Number, y:Number, z:Number):Number
Returns the distance of this element to the given coordinate
fElement
 Inherited
follow(target:fElement, elasticity:Number = 0):void
Makes element follow target element
fElement
  
gotoAndPlay(where:*):void
Passes the stardard gotoAndPLay command to the base clip
fObject
  
gotoAndStop(where:*):void
Passes the stardard gotoAndStop command to the base clip
fObject
  
hide():void
Makes element invisible
fObject
 Inherited
moveTo(x:Number, y:Number, z:Number):void
Moves the element to a given position
fElement
  
show():void
Makes element visible
fObject
 Inherited
stopFollowing(target:fElement):void
Stops element from following another element
fElement
Public Constants
 ConstantDefined by
  MAXSHADOW : * = 2
[static] Limits size of object shadow projection relative to X times the object's height (amount of stretching movieClips will suffer)
fObject
 InheritedMOVE : String = "elementmove"
[static] The fElement.MOVE constant defines the value of the type property of the event object for a elementmove event.
fElement
 InheritedNEWCELL : String = "elementnewcell"
[static] The fElement.NEWCELL constant defines the value of the type property of the event object for a elementnewcell event.
fElement
Property detail
heightproperty
height:Number  [read-write]

The height in pixels of an imaginary cilinder enclosing the object. It is used only for colision detection. You can change it anytime This is useful for example if a character has rolling or crawling movements and you want to change its collision height during those movements.

Implementation
    public function get height():Number
    public function set height(value:Number):void
orientationproperty 
orientation:Number  [read-write]

The orientation (in degrees) of the object along the Z axis. That is, if the object was a man standing anywhere on our scene, this would be where was his nose pointing. The default value of 0 indicates it is "looking" towards the positive X axis. The Axis in the Filmation Engine go like this. 

  
     positive Z
             |
             |      / positive X
             |    /
             |  /
      (0,0,0) X/
              \
                \
                  \
                    \ positive Y

Implementation
    public function get orientation():Number
    public function set orientation(value:Number):void
radiusproperty 
radius:Number  [read-only]

The radius in pixels of an imaginary cilinder enclosing the object. It is used only for colision detection.

Implementation
    public function get radius():Number
Method detail
call()method
public override function call(what:String, param:* = null):void

Calls a function of the base clip

Parameters
what:String — Name of the function to call
 
param:* (default = null) — An optional extra parameter to pass to the function
gotoAndPlay()method 
public override function gotoAndPlay(where:*):void

Passes the stardard gotoAndPLay command to the base clip

Parameters
where:* — A frame number or frame label
gotoAndStop()method 
public override function gotoAndStop(where:*):void

Passes the stardard gotoAndStop command to the base clip

Parameters
where:* — A frame number or frame label
hide()method 
public override function hide():void

Makes element invisible

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

Makes element visible

Constant detail
MAXSHADOWconstant
public static const MAXSHADOW:* = 2

Limits size of object shadow projection relative to X times the object's height (amount of stretching movieClips will suffer)