Difference between revisions of "cock.getMouseOffset"

(Created page with "Gets horizontal and vertical mouse offset. You can access these values directly, see etc.mouse.* fields. == Synopsis == === Functio...")
 
m
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Gets horizontal and vertical mouse offset. You can access these values directly, see [[Common Organization of Controls Kit Fields|etc.mouse.*]] fields.
 
Gets horizontal and vertical mouse offset. You can access these values directly, see [[Common Organization of Controls Kit Fields|etc.mouse.*]] fields.
== Synopsis ==
+
== Function ==
=== Function ===
+
=== Synopsis ===
 
<source lang="Lua">x, y = cock.getMouseOffset ( self )</source>
 
<source lang="Lua">x, y = cock.getMouseOffset ( self )</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|table|self|An object to use.}}
 
{{param|table|self|An object to use.}}
== Returns ==
+
=== Returns ===
 
{{param|number|x|X-coordinate used as center.}}
 
{{param|number|x|X-coordinate used as center.}}
 
{{param|number|y|Y-coordinate used as center.}}
 
{{param|number|y|Y-coordinate used as center.}}
Line 15: Line 15:
 
*[[Common Organization of Controls Kit]]
 
*[[Common Organization of Controls Kit]]
  
{{#set:Description=Sets mouse offset.}}
+
{{#set:Description=Gets mouse offset.}}

Latest revision as of 15:06, 2 September 2013

Gets horizontal and vertical mouse offset. You can access these values directly, see etc.mouse.* fields.

Function

Synopsis

x, y = cock.getMouseOffset ( self )

Arguments

table self
An object to use.

Returns

number x
X-coordinate used as center.
number y
Y-coordinate used as center.

See also