Difference between revisions of "love.physics.getMeter"

(Some corrections.)
(Undo revision 29406 by Rober vicioso (talk))
(Tag: Undo)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{newin|[[0.8.0]]|type=function}}
+
{{newin|[[0.8.0]]|080|type=function}}
 
Returns the meter scale factor.
 
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.
+
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 beacuse Box2D is tuned to work well with shape sizes from 0.1 to 10 meters.
+
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 ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 18: Line 18:
 
* [[love.physics.setMeter]]
 
* [[love.physics.setMeter]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Returns the scaling factor.}}
+
{{#set:Description=Returns the meter scale factor.}}
 
{{#set:Since=080}}
 
{{#set:Since=080}}
 
== Other Languages ==
 
== Other Languages ==
{{i18n|World:getMeter}}
+
{{i18n|love.physics.getMeter}}

Latest revision as of 15:09, 17 December 2024

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 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

scale = love.physics.getMeter( )

Arguments

None.

Returns

number scale
The scale factor as an integer.

See Also


Other Languages