class SymbolParameters

package flxanimate.animate

implements IFilterable

@:directlyUsed

SymbolParameters defines and separates from what a FlxElement considered as a Shape and a FlxElement considered as a Symbol.

It adds metadata information on the symbol's behaviour, such as: - Type, this can be considered as:

 - Type of `Symbol`.
 - Type of `Looping`.

Constructor

@:value({ loop : Loop, type : Graphic, instance : "", name : null })new(?name:String, instance:String = "", type:SymbolT = Graphic, loop:Loop = Loop)

Creates a new SymbolParameters instance.

Parameters:

name

The name referencing an existing symbol.

instance

The name of this instance.

type

The Type of Symbol it will behave like.

loop

The type of looping it will use. WARNING: This can be ignored if type isn't set to Graphic!

Variables

@:value(NORMAL)blendMode:BlendMode = NORMAL

cacheAsBitmap:Bool

cacheAsBitmapMatrix:FlxMatrix

colorEffect:FlxColorEffect

filters:Array<BitmapFilter>

@:value(0)firstFrame:Int = 0

An Int that references the frame of the referenced symbol.

instance:String

The FlxElement's own name identifier. WARNING: do NOT confuse with name!

loop:Loop

The type of loop that the symbol is been set to. There are three types (excluding the reversed options): - Loop - Play Once - Single Frame. WARNING: if type is NOT set to Graphic, this option will not let you modify it.

name:String

The referenced symbol's name. WARNING: do NOT confuse with instance!

reverse:Bool

Whether the looping animation is reversed or not. It is ignored when loop is set to SingleFrame.

transformationPoint:FlxPoint

type:SymbolT

The type of the symbol, this may vary in three categories: - Graphic - MovieClip - Button.

See also:

Methods

destroy():Void

reset():Void