Kinemium Docs

World2D

A first-class 2D world with an independent camera, renderer, and Box2D simulation.

Properties

PropertyTypeDefault
Namestring"World2D"
Enabledbooleantrue
GravityVector2Vector2.new(0, 981)
TimeScalenumber1
Pausedbooleanfalse
PositionUDim2UDim2.new(0, 0, 0, 0)
SizeUDim2UDim2.new(0, 400, 0, 400)
RenderOffsetVector2Vector2.new(0, 0)
OverrideScreenSizebooleanfalse
CurrentCameraanynil
BackgroundColorColor3Color3.new(0, 0, 0)
BackgroundTransparencynumber1
FixedDeltaTimeany1 / 60
ElapsedTimenumber0
Accumulatornumber0
contactHertznumber60
contactDampingRationumber1
maximumLinearSpeednumber4000
maximumAngularSpeednumber4000
restitutionThresholdnumber1
hitEventThresholdnumber0
maxContactPushSpeednumber3
enableSleepbooleantrue
enableContinuousbooleantrue
workerCountnumber0
MotionLockstable{ LinearX = false, LinearY = false, AngularZ = false }
Bodiestable{}
Constraintstable{}
CollisionLayerstable{}
UseBoundsbooleanfalse
MinBoundsVector2Vector2.new(-math.huge, -math.huge)
MaxBoundsVector2Vector2.new(math.huge, math.huge)
VelocityIterationsnumber8
PositionIterationsnumber3
AllowSleepbooleantrue
DebugDrawbooleanfalse
DebugColorColor3Color3.new(0, 1, 0)

Functions


color

Arguments

color3, transparency

Returns

This function returns nothing.

rotate

Arguments

point, degrees

Returns

This function returns nothing.

firstCamera

Arguments

world, workspace

Returns

This function returns nothing.

viewportSize

Arguments

This function takes no arguments.

Returns

This function returns nothing.

worldToScreen

Arguments

point, camera, parallax, viewport

Returns

This function returns nothing.

drawPart

Arguments

object, camera, viewport, canvas

Returns

This function returns nothing.

tileTexture

Arguments

source

Returns

This function returns nothing.

tileSourceRect

Arguments

definition

Returns

This function returns nothing.

drawLayer

Arguments

tilemap, layer, camera, viewport, canvas

Returns

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

On this page