Difference between revisions of "cock.setMouseFactor"

m
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Sets horizontal and vertical mouse factor. Mouse readings will be multiplied by provided values. This is essentially a mouse sensevity. You can access these values directly, see [[Common Organization of Controls Kit Fields|etc.mouse.*]] fields.
+
Sets horizontal and vertical mouse factor. You can access these values directly, see [[Common Organization of Controls Kit Fields|etc.mouse.*]] fields.
== Synopsis ==
+
== Function ==
=== Function ===
+
=== Synopsis ===
 
<source lang="Lua">cock.setMouseFactor ( self, x, y )</source>
 
<source lang="Lua">cock.setMouseFactor ( self, x, y )</source>
 
=== Arguments ===
 
=== Arguments ===
Line 7: Line 7:
 
{{param|number|x|Optional. Scaling factor by X axis. Will use old value if not provided.}}
 
{{param|number|x|Optional. Scaling factor by X axis. Will use old value if not provided.}}
 
{{param|number|y|Optional. Scaling factor by Y axis. Will use old value if not provided.}}
 
{{param|number|y|Optional. Scaling factor by Y axis. Will use old value if not provided.}}
 +
== Remarks ==
 +
Mouse readings will be multiplied by provided values. This is essentially a mouse sensevity.
 
==See also==
 
==See also==
 
*[[cock.setMouseOffset]]
 
*[[cock.setMouseOffset]]
Line 15: Line 17:
 
*[[Common Organization of Controls Kit]]
 
*[[Common Organization of Controls Kit]]
  
{{#set:Description=Sets mouse offset.}}
+
{{#set:Description=Sets mouse factor.}}

Latest revision as of 15:14, 2 September 2013

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

Function

Synopsis

cock.setMouseFactor ( self, x, y )

Arguments

table self
An object to use.
number x
Optional. Scaling factor by X axis. Will use old value if not provided.
number y
Optional. Scaling factor by Y axis. Will use old value if not provided.

Remarks

Mouse readings will be multiplied by provided values. This is essentially a mouse sensevity.

See also