Difference between revisions of "love.physics.setMeter"

m
(Some more corrections.)
Line 1: Line 1:
{{newin|[[0.8.0]]|type=variants|plural=y}}
+
{{newin|[[0.8.0]]|type=function}}
 +
Sets 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 for graphics transformations.
  
Set the scale of the world.
+
It is recommended to create shapes no larger than 10 times the scale. This is important because Box2D is tuned to work well with shape sizes from 0.1 to 10 meters.
 
 
The world scale is the number of pixels per meter. Try to keep your shape sizes less than 10 times this scale.
 
 
 
The default scale for new worlds is 30 pixels per meter.
 
 
 
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.
 
 
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 16: Line 11:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|scale|The size of 1 meter in pixels.}}
+
{{param|number|scale|The scale factor as an integer.}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
Line 23: Line 18:
 
* [[love.physics.getMeter]]
 
* [[love.physics.getMeter]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Set the scale of the world.}}
+
{{#set:Description=Sets the meter scale factor.}}
 
+
{{#set:Since=080}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|World:setMeter}}
 
{{i18n|World:setMeter}}

Revision as of 20:40, 9 April 2012

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

Sets 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 for graphics transformations.

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

Function

Synopsis

love.physics.setMeter( scale )

Arguments

number scale
The scale factor as an integer.

Returns

Nothing.

See Also


Other Languages