Packagecom.worlize.api.event
Classpublic class LoosePropEvent
InheritanceLoosePropEvent Inheritance flash.events.Event

Product Version : Worlize APIv.2

Represents a change to one or more loose props in the room.



Public Properties
 PropertyDefined By
  delta : int
The difference between the new and previous positions in the stacking order.
LoosePropEvent
  looseProp : LooseProp
The loose prop that is being affected.
LoosePropEvent
  newIndex : int
The loose prop's new position in the stacking order.
LoosePropEvent
  oldIndex : int
The loose prop's previous position in the stacking order.
LoosePropEvent
Public Methods
 MethodDefined By
  
LoosePropEvent(type:String, cancelable:Boolean = false)
Constructor.
LoosePropEvent
Public Constants
 ConstantDefined By
  PROP_ADDED : String = propAdded
[static] The LoosePropEvent.PROP_ADDED constant defines the value of the type property of the event object for a propAdded event.
LoosePropEvent
  PROP_LAYER_CHANGED : String = propLayerChanged
[static] The LoosePropEvent.PROP_LAYER_CHANGED constant defines the value of the type property of the event object for a propLayerChanged event.
LoosePropEvent
  PROP_MOVED : String = propMoved
[static] The LoosePropEvent.PROP_MOVED constant defines the value of the type property of the event object for a propMoved event.
LoosePropEvent
  PROP_REMOVED : String = propRemoved
[static] The LoosePropEvent.PROP_REMOVED constant defines the value of the type property of the event object for a propRemoved event.
LoosePropEvent
  PROPS_CLEARED : String = propsCleared
[static] The LoosePropEvent.PROPS_CLEARED constant defines the value of the type property of the event object for a propsCleared event.
LoosePropEvent
Property Detail
deltaproperty
public var delta:int

Product Version : Worlize APIv.2

The difference between the new and previous positions in the stacking order.

loosePropproperty 
public var looseProp:LooseProp

The loose prop that is being affected.

newIndexproperty 
public var newIndex:int

Product Version : Worlize APIv.2

The loose prop's new position in the stacking order.

oldIndexproperty 
public var oldIndex:int

Product Version : Worlize APIv.2

The loose prop's previous position in the stacking order.

Constructor Detail
LoosePropEvent()Constructor
public function LoosePropEvent(type:String, cancelable:Boolean = false)

Product Version : Worlize APIv.2

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
cancelable:Boolean (default = false) — Whether or not the default behavior can be prevented.
Constant Detail
PROP_ADDEDConstant
public static const PROP_ADDED:String = propAdded

Product Version : Worlize APIv.2

The LoosePropEvent.PROP_ADDED constant defines the value of the type property of the event object for a propAdded event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
loosePropA LooseProp instance representing the new loose prop that was added.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

PROP_LAYER_CHANGEDConstant 
public static const PROP_LAYER_CHANGED:String = propLayerChanged

Product Version : Worlize APIv.2

The LoosePropEvent.PROP_LAYER_CHANGED constant defines the value of the type property of the event object for a propLayerChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
loosePropA LooseProp instance representing the loose prop that was moved in the stacking order.
oldIndexThe LooseProp's previous position in the stacking order.
newIndexThe LooseProp's new position in the stacking order.
deltaThe change between the LooseProp's old and new position in the stacking order. Will be a positive integer when the prop is brought forward and a negative integer when sent backward.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

PROP_MOVEDConstant 
public static const PROP_MOVED:String = propMoved

Product Version : Worlize APIv.2

The LoosePropEvent.PROP_MOVED constant defines the value of the type property of the event object for a propMoved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
loosePropA LooseProp instance representing the loose prop that was moved.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

PROP_REMOVEDConstant 
public static const PROP_REMOVED:String = propRemoved

Product Version : Worlize APIv.2

The LoosePropEvent.PROP_REMOVED constant defines the value of the type property of the event object for a propRemoved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
loosePropA LooseProp instance representing the loose prop that was removed.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

PROPS_CLEAREDConstant 
public static const PROPS_CLEARED:String = propsCleared

Product Version : Worlize APIv.2

The LoosePropEvent.PROPS_CLEARED constant defines the value of the type property of the event object for a propsCleared event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
loosePropA LooseProp instance representing the loose prop that was moved.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also