axmol/cocos/scripting/lua-bindings/auto/api/EventMouse.lua

138 lines
4.7 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module EventMouse
-- @extend Event
-- @parent_module cc
--------------------------------
-- Returns the previous touch location in screen coordinates.<br>
-- return The previous touch location in screen coordinates.<br>
-- js NA
-- @function [parent=#EventMouse] getPreviousLocationInView
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Returns the current touch location in OpenGL coordinates.<br>
-- return The current touch location in OpenGL coordinates.
-- @function [parent=#EventMouse] getLocation
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get mouse button.<br>
-- return The mouse button.<br>
-- js getButton
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] getMouseButton
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- Returns the previous touch location in OpenGL coordinates.<br>
-- return The previous touch location in OpenGL coordinates.<br>
-- js NA
-- @function [parent=#EventMouse] getPreviousLocation
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Returns the delta of 2 current touches locations in screen coordinates.<br>
-- return The delta of 2 current touches locations in screen coordinates.
-- @function [parent=#EventMouse] getDelta
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set mouse scroll data.<br>
-- param scrollX The scroll data of x axis.<br>
-- param scrollY The scroll data of y axis.
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] setScrollData
-- @param self
-- @param #float scrollX
-- @param #float scrollY
-- @return EventMouse#EventMouse self (return value: cc.EventMouse)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns the start touch location in screen coordinates.<br>
-- return The start touch location in screen coordinates.<br>
-- js NA
-- @function [parent=#EventMouse] getStartLocationInView
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Returns the start touch location in OpenGL coordinates.<br>
-- return The start touch location in OpenGL coordinates.<br>
-- js NA
-- @function [parent=#EventMouse] getStartLocation
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set mouse button.<br>
-- param button a given mouse button.<br>
-- js setButton
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] setMouseButton
-- @param self
-- @param #int button
-- @return EventMouse#EventMouse self (return value: cc.EventMouse)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns the current touch location in screen coordinates.<br>
-- return The current touch location in screen coordinates.
-- @function [parent=#EventMouse] getLocationInView
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get mouse scroll data of y axis.<br>
-- return The scroll data of y axis.
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] getScrollY
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Get mouse scroll data of x axis.<br>
-- return The scroll data of x axis.
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] getScrollX
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Get the cursor position of x axis.<br>
-- return The x coordinate of cursor position.<br>
-- js getLocationX
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] getCursorX
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Get the cursor position of y axis.<br>
-- return The y coordinate of cursor position.<br>
-- js getLocationY
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] getCursorY
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Set the cursor position.<br>
-- param x The x coordinate of cursor position.<br>
-- param y The y coordinate of cursor position.<br>
-- js setLocation
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] setCursorPosition
-- @param self
-- @param #float x
-- @param #float y
-- @return EventMouse#EventMouse self (return value: cc.EventMouse)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Constructor.<br>
-- param mouseEventCode A given mouse event type.<br>
-- js ctor
2014-03-10 14:04:58 +08:00
-- @function [parent=#EventMouse] EventMouse
-- @param self
-- @param #int mouseEventCode
-- @return EventMouse#EventMouse self (return value: cc.EventMouse)
2014-03-10 14:04:58 +08:00
return nil