Kinemium Docs

World2D

A 2D physics world container.

Properties

PropertyTypeDefault
GravityVector2Vector2.new(0, 981)
TimeScalenumber1
Pausedbooleanfalse
ResetOnSpawnbooleantrue
PositionUDim2UDim2.new(0, 0, 0, 0)
SizeUDim2UDim2.new(0, 400, 0, 400)
RenderOffsetVector2Vector2.new(0, 0)
OverrideScreenSizebooleanfalse
FixedDeltaTimeany1 / 60
ElapsedTimenumber0
Accumulatornumber0
contactHertznumber60
contactDampingRationumber1
maximumLinearSpeednumber4000
maximumAngularSpeednumber4000
restitutionThresholdnumber1.0
hitEventThresholdnumber0.0
maxContactPushSpeednumber3.0
enableSleepbooleantrue
enableContinuousbooleantrue
workerCountnumber0
Bodiestable{}
Constraintstable{}
CollisionLayerstable{}
UseBoundsbooleanfalse
MinBoundsVector2Vector2.new(-math.huge, -math.huge)
MaxBoundsVector2Vector2.new(math.huge, math.huge)
VelocityIterationsnumber8
PositionIterationsnumber3
AllowSleepbooleantrue
DebugDrawbooleanfalse
DebugColoranynil

Functions


update

Arguments

This function takes no arguments.

Returns

This function returns nothing.

AddBody

Arguments

self, body

Returns

This function returns nothing.

RemoveBody

Arguments

self, body

Returns

This function returns nothing.

AddConstraint

Arguments

self, constraint

Returns

This function returns nothing.

RemoveConstraint

Arguments

self, constraint

Returns

This function returns nothing.

Clear

Arguments

self

Returns

This function returns nothing.

Step

Arguments

self, dt

Returns

This function returns nothing.

API

instance:update()
instance:AddBody(self, body)
instance:RemoveBody(self, body)
instance:AddConstraint(self, constraint)
instance:RemoveConstraint(self, constraint)
instance:Clear(self)
instance:Step(self, dt)

On this page