Scaleform Studio Lua API Reference: scaleform.MouseEvent table reference

scaleform.MouseEvent table reference
Data Members
expand all | collapse all

Description

The event parameters for MouseDown, MouseUp, MouseMove, MouseWheel, MouseOut, MouseOver, MouseUpOutside, Click, DoubleClick,RollOut and RollOver events.

Data Members

buttonId : integer
Button Id.
buttonsMask : integer
Mouse buttons (Left = 0x1, Right = 0x2, Middle = 0x4).
keyMods : integer
Key modifier flags (Shift = 0x01, Ctrl = 0x02, Alt = 0x04, Caps = 0x08, Num = 0x10, Scroll = 0x20, Right shift, alt or ctrl = 0x40).
localX : number
Mouse local x-position.
localY : number
Mouse local y-position.
mouseIndex : integer
Mouse index.
relatedActor : scaleform.Actor
Actor related to mouse event.
rollOverCount : integer
Roll over count.
stageX : number
Mouse x-position on stage.
stageY : number
Mouse y-position on stage.
wheelDelta : number
Mouse wheel rotation.
 scaleform.Event

{ currentTarget : scaleform.Actor?, eventId : scaleform.EventTypes, phase : string, target : scaleform.Actor?, }  scaleform.EventTypes.Click
The mouse click event, scaleform.MouseEvent.  scaleform.EventTypes.DoubleClick
The mouse doubleclick event, scaleform.MouseEvent.  scaleform.EventTypes.MouseDown
The mouse down event, scaleform.MouseEvent.  scaleform.EventTypes.MouseMove
The mouse down event, scaleform.MouseEvent.  scaleform.EventTypes.MouseOut
The mouse out event, scaleform.MouseEvent.  scaleform.EventTypes.MouseOver
The mouse over event, scaleform.MouseEvent.  scaleform.EventTypes.MouseUp
The mouse down event, scaleform.MouseEvent.  scaleform.EventTypes.MouseUpOutside
The mouse release outside event, scaleform.MouseEvent.  scaleform.EventTypes.MouseWheel
The mouse wheel event, scaleform.MouseEvent.  scaleform.EventTypes.RollOut
The mouse roll out event, scaleform.MouseEvent.  scaleform.EventTypes.RollOver
The mouse roll over event, scaleform.MouseEvent.  scaleform.MouseEvent.buttonId : integer
Button Id. A strictly integral numeric value, with no decimal component.  scaleform.MouseEvent.buttonsMask : integer
Mouse buttons (Left = 0x1, Right = 0x2, Middle = 0x4).  scaleform.MouseEvent.keyMods : integer
Key modifier flags (Shift = 0x01, Ctrl = 0x02, Alt = 0x04, Caps = 0x08, Num = 0x10, Scroll = 0x20, Right shift, alt or ctrl = 0x40).  scaleform.MouseEvent.localX : number
Mouse local x-position. A numeric value.  scaleform.MouseEvent.localY : number
Mouse local y-position.  scaleform.MouseEvent.mouseIndex : integer
Mouse index.  scaleform.MouseEvent.relatedActor : scaleform.Actor
Actor related to mouse event.  scaleform.Actor
Generic objects located in a scene.  scaleform.MouseEvent.rollOverCount : integer
Roll over count.  scaleform.MouseEvent.stageX : number
Mouse x-position on stage.  scaleform.MouseEvent.stageY : number
Mouse y-position on stage.  scaleform.MouseEvent.wheelDelta : number
Mouse wheel rotation.  scaleform.EventTypes
The list of events. A string of characters.  scaleform.MouseEvent
The event parameters for MouseDown, MouseUp, MouseMove, MouseWheel, MouseOut, MouseOver, MouseUpOutside, Click, DoubleClick,RollOut and RollOver events.
{ buttonId : integer, buttonsMask : integer, keyMods : integer, localX : number, localY : number, mouseIndex : integer, relatedActor : scaleform.Actor, rollOverCount : integer, stageX : number, stageY : number, wheelDelta : number, }Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.
Please send us your comment about this page