springroll.easeljs.CutsceneTask Class

Extends springroll.Task
Defined in: springroll.easeljs.CutsceneTask:12
Module: EaselJS Cutscene

Loads and instantiates a 'springroll.easeljs.Cutscene'.

Constructor

springroll.easeljs.CutsceneTask

(
  • asset
)
private

Defined in springroll.easeljs.CutsceneTask:12

Parameters:

  • asset Object

    The data properties

    • anim String | Object

      The path the animation

    • animClass String

      The name of the animation class

    • width Int

      The width of the animation

    • height Int

      The height of the animation

    • [audio] Array optional

      The collection of audio files

    • [images] Array optional

      The map of the images to load

    • [fps] String optional

      The animation framerate, defaults to Application framerate

    • [cache=false] Boolean optional

      If we should cache the result

    • [id] String optional

      Id of asset

    • [complete] Function optional

      The event to call when done

    • [libItem='lib'] String optional

      The global window object for symbols

    • [imagesName='images'] String optional

      The global window object for images

destroy

()

Inherited from springroll.Task but overwritten in destroy:193

Destroy

filter

(
  • url
)
protected

Inherited from springroll.Task: filter:151

Add the sizing to each filter

Parameters:

  • url String
    The url to filter

load

(
  • source
  • [options]
)
protected

Inherited from springroll.Task: load:176

Pass-through to the Application load method

Parameters:

simpleLoad

(
  • url
  • complete
  • [progress]
  • [data]
)
protected

Inherited from springroll.Task: simpleLoad:188

Pass-through to the Application Loader.load

Parameters:

  • url String
    Path to file to load
  • complete Function
    The callback
  • [progress] Function optional
    The load progress
  • [data] Object optional
    Additiona data

start

(
  • callback
)

Inherited from springroll.Task but overwritten in start:120

Start the task

Parameters:

  • callback Function

    Callback when finished

test

(
  • asset
)
Boolean
static

Defined in test:107

Test if we should run this task

Parameters:

  • asset Object

    The asset to check

Returns:

Boolean:

If the asset is compatible with this asset

anim

String | Object

Defined in anim:39

The path to the flash asset

animClass

String

Defined in animClass:51

The name of the animation class

audio

Array

Defined in audio:69

The collection of objects with alias, start and sync property

cache

Boolean

Inherited from springroll.Task: cache:46

If we should cache the load and use later

Default: false

complete

Function

Inherited from springroll.Task: complete:37

The user call to fire when completed, returns the arguments result, original, and additionalAssets

Default: null

display

springroll.AbstractDisplay

Defined in display:95

The display to use, defaults to main App's main display

fps

Int

Defined in fps:45

The framerate, defaults to Application framerate

height

Int

Defined in height:63

The designed height of the animation

id

String

Inherited from springroll.Task: id:54

The task id

images

Object

Defined in images:75

The collection of images to preload, will be cached

imagesName

String

Defined in imagesName:88

The name of the window object images hang on

Default: 'images'

libName

String

Defined in libName:81

The name of the window object library items hang on

Default: 'lib'

original

Object

Inherited from springroll.Task: original:66

Reference to the original asset data

status

Int

Inherited from springroll.Task: status:30

The current status of the task (waiting, running, etc)

Default: 0

type

String

Inherited from springroll.Task: type:60

The task type for display filter

width

Int

Defined in width:57

The designed width of the animation