| Package | org.wak.scene.events |
| Class | public class SceneEvent |
| Inheritance | SceneEvent  flash.events.Event |
| Property | Defined by | ||
|---|---|---|---|
| altKey : Boolean [read-only]
Indicates whether the Alt key is active (true) or inactive (false).
| SceneEvent | ||
| ctrlKey : Boolean [read-only]
On Windows, indicates whether the Ctrl key is active (true) or inactive (false).
| SceneEvent | ||
| interactable : ISceneInteractable
[read-only]
The ISceneInteractable target of the event
| SceneEvent | ||
| localX : Number [read-only]
The horizontal coordinate at which the event occurred relative to the containing sprite.
| SceneEvent | ||
| localY : Number [read-only]
The vertical coordinate at which the event occurred relative to the containing sprite.
| SceneEvent | ||
| sceneId : String [read-only]
The Scene id where the event came from.
| SceneEvent | ||
| sceneMouseX : Number [read-only]
The horizontal coordinate on the scene at which the event occurred relative to the containing sprite.
| SceneEvent | ||
| sceneMouseY : Number [read-only]
The vertical coordinate on the scene at which the event occurred relative to the containing sprite.
| SceneEvent | ||
| shiftKey : Boolean [read-only]
Indicates whether the Shift key is active (true) or inactive (false).
| SceneEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
SceneEvent(type:String, pTarget:Object, pSceneId:String, bubbles:Boolean = true, cancelable:Boolean = false, localX:Number, localY:Number, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, pMouseSceneX:Number, pMouseSceneY:Number)
| SceneEvent | ||
|
toString():String
| SceneEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| ENTER_SCENE : String = "enter_scene" [static]
Dispatched when the player's character enters to the scene.
| SceneEvent | ||
| EXIT_SCENE : String = "exit_scene" [static]
Dispatched when the player's character exits the scene.
| SceneEvent | ||
| SCENEITEM_CLICK : String = "sceneitem_click" [static]
Dispatched when an ISceneInteractable item is clicked on the scene.
| SceneEvent | ||
| SCENEITEM_MOUSEOUT : String = "sceneitem_mouseout" [static]
Dispatched when a mouse out was made over an ISceneInteractable
| SceneEvent | ||
| SCENEITEM_MOUSEOVER : String = "sceneitem_mouseover" [static]
Dispatched when a mouse over was made over an ISceneInteractable
| SceneEvent | ||
| SCENE_SPACE_CLICK : String = "scene_space_click" [static]
Dispatched when a void space on the scene was clicked
| SceneEvent | ||
| altKey | property |
altKey:Boolean [read-only]Indicates whether the Alt key is active (true) or inactive (false). Supported for Windows operating systems only.
Implementation public function get altKey():Boolean
| ctrlKey | property |
ctrlKey:Boolean [read-only]On Windows, indicates whether the Ctrl key is active (true) or inactive (false). On Macintosh, indicates whether either the Ctrl key or the Command key is activated.
Implementation public function get ctrlKey():Boolean
| interactable | property |
interactable:ISceneInteractable [read-only]The ISceneInteractable target of the event
Implementation public function get interactable():ISceneInteractable
| localX | property |
localX:Number [read-only]The horizontal coordinate at which the event occurred relative to the containing sprite.
Implementation public function get localX():Number
| localY | property |
localY:Number [read-only]The vertical coordinate at which the event occurred relative to the containing sprite.
Implementation public function get localY():Number
| sceneId | property |
sceneId:String [read-only]The Scene id where the event came from.
Implementation public function get sceneId():String
| sceneMouseX | property |
sceneMouseX:Number [read-only]The horizontal coordinate on the scene at which the event occurred relative to the containing sprite.
Implementation public function get sceneMouseX():Number
| sceneMouseY | property |
sceneMouseY:Number [read-only]The vertical coordinate on the scene at which the event occurred relative to the containing sprite.
Implementation public function get sceneMouseY():Number
| shiftKey | property |
shiftKey:Boolean [read-only]Indicates whether the Shift key is active (true) or inactive (false).
Implementation public function get shiftKey():Boolean
| SceneEvent | () | constructor |
public function SceneEvent(type:String, pTarget:Object, pSceneId:String, bubbles:Boolean = true, cancelable:Boolean = false, localX:Number, localY:Number, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, pMouseSceneX:Number, pMouseSceneY:Number)Parameters
type:String |
|
pTarget:Object |
|
pSceneId:String |
|
bubbles:Boolean (default = true) |
|
cancelable:Boolean (default = false) |
|
localX:Number |
|
localY:Number |
|
ctrlKey:Boolean (default = false) |
|
altKey:Boolean (default = false) |
|
shiftKey:Boolean (default = false) |
|
pMouseSceneX:Number |
|
pMouseSceneY:Number |
| toString | () | method |
public override function toString():String
Returns
String |
| ENTER_SCENE | constant |
public static const ENTER_SCENE:String = "enter_scene"Dispatched when the player's character enters to the scene.
| EXIT_SCENE | constant |
public static const EXIT_SCENE:String = "exit_scene"Dispatched when the player's character exits the scene.
| SCENEITEM_CLICK | constant |
public static const SCENEITEM_CLICK:String = "sceneitem_click"Dispatched when an ISceneInteractable item is clicked on the scene.
| SCENEITEM_MOUSEOUT | constant |
public static const SCENEITEM_MOUSEOUT:String = "sceneitem_mouseout"Dispatched when a mouse out was made over an ISceneInteractable
| SCENEITEM_MOUSEOVER | constant |
public static const SCENEITEM_MOUSEOVER:String = "sceneitem_mouseover"Dispatched when a mouse over was made over an ISceneInteractable
| SCENE_SPACE_CLICK | constant |
public static const SCENE_SPACE_CLICK:String = "scene_space_click"Dispatched when a void space on the scene was clicked