Packageorg.ffilmation.engine.core
Classpublic class fRenderableElement
InheritancefRenderableElement Inheritance fElement Inheritance flash.events.EventDispatcher
SubclassesfObject, fPlane

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


Public Properties
 PropertyDefined by
  castShadows : Boolean = true
Boolean value indicating if this object casts shadows.
fRenderableElement
 Inheritedcontroller : fEngineElementController
Assigns a controller to this element
fElement
  flashClip : 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
 Inheritedid : String
The string identifier of this element.
fElement
  receiveLights : Boolean = true
Boolean value indicating if this object receives lighting.
fRenderableElement
  receiveShadows : Boolean = true
Boolean value indicating if this object receives shadows.
fRenderableElement
  solid : 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
  containerParent : DisplayObjectContainer
fRenderableElement
Public Methods
 MethodDefined by
  
call(what:String, param:* = null):void
Calls a function of the base clip
fRenderableElement
 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 of this element
fRenderableElement
  
gotoAndStop(where:*):void
Passes the stardard gotoAndStop command to the base clip of this element
fRenderableElement
  
hide():void
Makes element invisible
fRenderableElement
 Inherited
moveTo(x:Number, y:Number, z:Number):void
Moves the element to a given position
fElement
  
show():void
Makes element visible
fRenderableElement
 Inherited
stopFollowing(target:fElement):void
Stops element from following another element
fElement
Public Constants
 ConstantDefined by
  HIDE : String = "renderableElementHide"
[static] The fRenderableElement.HIDE constant defines the value of the type property of the event object for a renderableElementHide event.
fRenderableElement
 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
  SHOW : String = "renderableElementShow"
[static] The fRenderableElement.SHOW constant defines the value of the type property of the event object for a renderableElementShow event.
fRenderableElement
Property detail
castShadowsproperty
public var castShadows:Boolean = true

Boolean value indicating if this object casts shadows. You can change this value dynamically Any element in your XML can be given a castShadows="false|true" attribute in its XML definition

containerParentproperty 
protected var containerParent:DisplayObjectContainer
flashClipproperty 
public var flashClip:MovieClip

A reference to the library movieclip that was attached to create the element, so you can acces methods inside, nested clips or whatever

receiveLightsproperty 
public var receiveLights:Boolean = true

Boolean value indicating if this object receives lighting. You can change this value dynamically. Any element in your XML can be given a receiveLights="false|true" attribute in its XML definition

receiveShadowsproperty 
public var receiveShadows:Boolean = true

Boolean value indicating if this object receives shadows. You can change this value dynamically Any element in your XML can be given a receiveShadows="false|true" attribute in its XML definition

solidproperty 
public var solid:Boolean = true

Boolean value indicating if this object collides with others. Any element in your XML can be given a solid="false|true" attribute in its XML definition. When a character moves to a position that overlaps another element, if will trigger either the fCollide or the fWalkover Events, depending on the solid property for that element.

See also

org.ffilmation.engine.events.fCollideEvent
org.ffilmation.engine.events.fWalkoverEvent
Method detail
call()method
public 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 function gotoAndPlay(where:*):void

Passes the stardard gotoAndPLay command to the base clip of this element

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

Passes the stardard gotoAndStop command to the base clip of this element

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

Makes element invisible

show()method 
public function show():void

Makes element visible

Constant detail
HIDEconstant
public static const HIDE:String = "renderableElementHide"

The fRenderableElement.HIDE constant defines the value of the type property of the event object for a renderableElementHide event. The event is dispatched when the character is hidden via the hide() method

SHOWconstant 
public static const SHOW:String = "renderableElementShow"

The fRenderableElement.SHOW constant defines the value of the type property of the event object for a renderableElementShow event. The event is dispatched when the character is shown via the show() method