Difference between revisions of "love.physics.getMeter"

m
(Some corrections.)
Line 1: Line 1:
{{newin|[[0.8.0]]|type=methods|plural=y}}
+
{{newin|[[0.8.0]]|type=function}}
Get the scale of the world.
+
Returns the meter scale factor.
  
The world scale is the number of pixels per meter. Try to keep your shape sizes less than 10 times this scale.
+
All coordinates in the physics module are divided by this number, creating a convenient way to draw the objects directly to the screen without the need of graphics transformations.
 
 
This is important because the physics in Box2D is tuned to work well for objects of size 0.1m up to 10m. All physics coordinates are divided by this number for the physics calculations.
 
  
 +
It is recommended to create shapes no larger than 10 times the scale. This is important beacuse Box2D is tuned to work well with shape sizes from 0.1 to 10 meters.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 14: Line 13:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|number|scale|The size of 1 meter in pixels.}}
+
{{param|number|scale|The scale factor as an integer.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.physics]]
 
* [[parent::love.physics]]
 
* [[love.physics.setMeter]]
 
* [[love.physics.setMeter]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Get the scale of the world.}}
+
{{#set:Description=Returns the scaling factor.}}
{{#set:Since=000}}
+
{{#set:Since=080}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|World:getMeter}}
 
{{i18n|World:getMeter}}

Revision as of 20:36, 9 April 2012

Available since LÖVE 0.8.0
This function is not supported in earlier versions.

Returns the meter scale factor.

All coordinates in the physics module are divided by this number, creating a convenient way to draw the objects directly to the screen without the need of graphics transformations.

It is recommended to create shapes no larger than 10 times the scale. This is important beacuse Box2D is tuned to work well with shape sizes from 0.1 to 10 meters.

Function

Synopsis

scale = love.physics.getMeter( )

Arguments

None.

Returns

number scale
The scale factor as an integer.

See Also


Other Languages