World2D
A first-class 2D world with an independent camera, renderer, and Box2D simulation.
Properties
| Property | Type | Default |
|---|---|---|
Name | string | "World2D" |
Enabled | boolean | true |
Gravity | Vector2 | Vector2.new(0, 981) |
TimeScale | number | 1 |
Paused | boolean | false |
Position | UDim2 | UDim2.new(0, 0, 0, 0) |
Size | UDim2 | UDim2.new(0, 400, 0, 400) |
RenderOffset | Vector2 | Vector2.new(0, 0) |
OverrideScreenSize | boolean | false |
CurrentCamera | any | nil |
BackgroundColor | Color3 | Color3.new(0, 0, 0) |
BackgroundTransparency | number | 1 |
FixedDeltaTime | any | 1 / 60 |
ElapsedTime | number | 0 |
Accumulator | number | 0 |
contactHertz | number | 60 |
contactDampingRatio | number | 1 |
maximumLinearSpeed | number | 4000 |
maximumAngularSpeed | number | 4000 |
restitutionThreshold | number | 1 |
hitEventThreshold | number | 0 |
maxContactPushSpeed | number | 3 |
enableSleep | boolean | true |
enableContinuous | boolean | true |
workerCount | number | 0 |
MotionLocks | table | { LinearX = false, LinearY = false, AngularZ = false } |
Bodies | table | {} |
Constraints | table | {} |
CollisionLayers | table | {} |
UseBounds | boolean | false |
MinBounds | Vector2 | Vector2.new(-math.huge, -math.huge) |
MaxBounds | Vector2 | Vector2.new(math.huge, math.huge) |
VelocityIterations | number | 8 |
PositionIterations | number | 3 |
AllowSleep | boolean | true |
DebugDraw | boolean | false |
DebugColor | Color3 | Color3.new(0, 1, 0) |
Functions
`color`
`rotate`
`firstCamera`
`viewportSize`
`worldToScreen`
`drawPart`
`tileTexture`
`tileSourceRect`
`drawLayer`
`render`
color
Arguments
color3, transparencyReturns
This function returns nothing.
rotate
Arguments
point, degreesReturns
This function returns nothing.
firstCamera
Arguments
world, workspaceReturns
This function returns nothing.
viewportSize
Arguments
This function takes no arguments.
Returns
This function returns nothing.
worldToScreen
Arguments
point, camera, parallax, viewportReturns
This function returns nothing.
drawPart
Arguments
object, camera, viewport, canvasReturns
This function returns nothing.
tileTexture
Arguments
sourceReturns
This function returns nothing.
tileSourceRect
Arguments
definitionReturns
This function returns nothing.
drawLayer
Arguments
tilemap, layer, camera, viewport, canvasReturns
This function returns nothing.
render
Arguments
This function takes no arguments.
Returns
This function returns nothing.
API
instance:color(color3, transparency)
instance:rotate(point, degrees)
instance:firstCamera(world, workspace)
instance:viewportSize()
instance:worldToScreen(point, camera, parallax, viewport)
instance:drawPart(object, camera, viewport, canvas)
instance:tileTexture(source)
instance:tileSourceRect(definition)
instance:drawLayer(tilemap, layer, camera, viewport, canvas)
instance:render()