Packagevegas.ioc.io
Classpublic class SoundResource
InheritanceSoundResource Inheritance ObjectResource Inheritance SimpleValueObject Inheritance Object

This resource contains all information about an external sound to load in the application.



Public Properties
 PropertyDefined By
 Inheritedcache : Boolean
The cache flag of this resource (default is true).
ObjectResource
 Inheriteddata : *
The data object of this resource.
ObjectResource
  DEFAULT_PATH : String
[static] The root path of all sound resources.
SoundResource
  definition : Object
Indicates the definition object to complete and override the default ObjectDefinition of the current sound.
SoundResource
 Inheritedenabled : Boolean
A enabled flag of this resource.
ObjectResource
 Inheritedid : *
Indicates the id of this ValueObject.
SimpleValueObject
 Inheritedowner : *
The owner reference of this resource.
ObjectResource
  path : String
The optional path of the external Shader file to load.
SoundResource
 Inheritedresource : String
The resource value.
ObjectResource
  singleton : Boolean = true
Indicates if the object definition of this resource must be a singleton.
SoundResource
  sound : *
The CoreSound reference or id (in the factory) used to load the resource.
SoundResource
 Inheritedtype : String
The type of the resource.
ObjectResource
 Inheritedverbose : Boolean
Indicates the verbose mode of the resource.
ObjectResource
Public Methods
 MethodDefined By
  
SoundResource(init:Object = null)
Creates a new SoundResource instance.
SoundResource
  
[override] Creates a new loader object with the resource.
SoundResource
 Inherited
equals(o:*):Boolean
Compares the specified object with this object for equality.
SimpleValueObject
 Inherited
formatToString(className:String = null, ... args):String
A utility function for implementing the toString() method.
SimpleValueObject
 Inherited
initialize(... args):void
The optional method invoked when the resource is loading.
ObjectResource
  
register(type:String = sound):void
[static] Registers the resource in the ObjectResourceBuilder.
SoundResource
 Inherited
toObject():Object
Returns the Object representation of this object.
SimpleValueObject
 Inherited
toSource(indent:int = 0):String
Returns the source code string representation of the object.
SimpleValueObject
 Inherited
toString():String
[override] Returns the String representation of this object.
ObjectResource
Property Detail
DEFAULT_PATHproperty
public static var DEFAULT_PATH:String

The root path of all sound resources.

definitionproperty 
public var definition:Object

Indicates the definition object to complete and override the default ObjectDefinition of the current sound.

pathproperty 
public var path:String

The optional path of the external Shader file to load.

singletonproperty 
public var singleton:Boolean = true

Indicates if the object definition of this resource must be a singleton.

soundproperty 
public var sound:*

The CoreSound reference or id (in the factory) used to load the resource.

Constructor Detail
SoundResource()Constructor
public function SoundResource(init:Object = null)

Creates a new SoundResource instance.

Parameters
init:Object (default = null) — A generic object containing properties with which to populate the newly instance. If this argument is null, it is ignored.
Method Detail
create()method
override public function create():CoreActionLoader

Creates a new loader object with the resource.

Returns
CoreActionLoader
register()method 
public static function register(type:String = sound):void

Registers the resource in the ObjectResourceBuilder.

Parameters

type:String (default = sound)