Platform

These are the properties and functions of the Platform type.

~ note that Platform is for both Platforms and Boulders

Base Properties

Home - Doesn't Work For Boulder!

The position the platform wants to be in

x, y = Platform.GetHome() -- reutrns a Vec2

Platform.SetHome(number x, number y)

Home Rotation - Doesn't Work For Boulder!

The rotation the platform wants to be in

number Platform.GetHomeRot()

Platform.SetHomeRot(number homeRot)

Scale

The scale of the platform

number Platform.GetScale()

Platform.SetScale(number scale)

Base Scale

The scale the platform will shrink to after some time

number Platform.GetBaseScale()

Platform.SetBaseScale(number baseScale)

Max Scale

the max scale. if the scale is more then this value it gets clamped to this value

number Platform.GetMaxScale()

Platform.SetMaxScale(number MaxScale)

Min Scale

the minimum scale. if the scale is less then this value it gets clamped to this value

number Platform.GetMinScale()

Platform.SetMinScale(number MinScale)

Info Functions

Get Bopl Body

Returns the physics body BoplBody of the platform or nil if not found

BoplBody Platform.GetBoplBody()

Example:

movingBody = movingPlatform.GetBoplBody()
x, y = movingBody.GetPos()
movingBody.SetPos(x + speed, y)

Is Resizable

Returns true if the platform is resizable in both axes (slime platform, spawned platform, custon platform)

bool Platform.IsResizable()

Example:

if (platform.IsResizable()) then
    platform.Resize(10, 10, 10)
end

Is Boulder

Returns true if the platform is a boulder

bool Platform.IsBoulder()

Example:

if (!p1.IsBoulder()) then
    p1.SetHome(0, 0)
end

Is Anti Lock

Returns true if the platform has an AntiLockPlatform component (that makes it move between points)

bool Platform.IsAntiLock()

Example:

if (plat.IsAntiLock()) then
    plat.RemoveAntiLock()
end

Is Vector Field

Returns true if the platform has a VectorFieldPlatform component (that makes it orbit a point)

bool Platform.IsVectorField()

Example:

if (plat.IsVectorField()) then
    plat.RemoveVectorField()
end

Get Platform Size

Returns the platform's width, height, and radius ~ width and height are distances from edge to center - radius. to calculate them in bopl units you do 2(width + radius) for width and 2(height + radius) for height.

width, height, radius = Platform.GetPlatformSize()

Example:

width, height, radius = plat.GetPlatformSize()

Get True Width And Height

Returns the true width and height of the platform taking into account rotations.

width, height = Platform.GetTrueWidthAndHeight()

Example:

width, height = plat.GetTrueWidthAndHeight()

Active Functions

Resize Platform

Resizes the platform to a given width, height, and radius. ~ only works if Platform.IsResizable()

Platform.ResizePlatform(number width, number height, number radius)

Example:

plat.ResizePlatform(10, 5, 1)

Drop All Players

Momentarily disconnects every attached player from the platform.

Platform.DropAllPlayers(number dropForce)

Example:

icePlatform.DropAllPlayers(1)

Shake Platform

Shakes the platform for a given period of time.

Platform.ShakePlatform(number duration, number shakeAmount)

Example:

if (player.GetPlatform() == plat) then
    plat.ShakePlatform(1, 2)
end

Make Anti Lock - Doesn't Work For Boulder!

Adds an AntiLockPlaform component to the platform, that makes the platform move between points and ignore its home position. ~ OrbitPathXs and OrbitPathYs are tables with coordinates of the points the platform moves between. They can have any length, as long as their lengths aren't different from each other. DelaySeconds is a delay before the platform starts moving counted from when the map is loaded (not from when players get spawned). If the platform already has an AntiLockPlaform component or a VectorFieldPlatform component, calling this function overrides it.

Platform.MakeAntiLock(table OrbitPathXs, table OrbitPathYs, number DelaySeconds, number OrbitForce)

Example:

if (not plat.IsBoulder()) then
    plat.MakeAntiLock({0, 10, 10, 0}, {0, 0, 10, 10}, 3, 600)
end

Make Vector Field - Doesn't Work For Boulder!

Adds a VectorFieldPlaform component to the platform, that makes the platform orbit a point and ignore its home position. ~ DelaySeconds is a delay before the platform starts orbiting counted from when the map is loaded (not from when players get spawned). I do not know what expandSpeed, normalSpeedFriction, DeadZoneDist, OrbitAccelerationMulitplier, and ovalness01 are. If the platform already has a VectorFieldPlatform component or an AntiLockPlaform component, calling this function overrides it.

Platform.MakeVectorField(double centerX, double centerY, double delaySeconds, double orbitSpeed, double expandSpeed, double normalSpeedFriction, double DeadZoneDist, double OrbitAccelerationMulitplier, double targetRadius, double ovalness01)

Example:

if (not plat.IsBoulder()) then
    plat.MakeVectorField(0, 12, 3, 15, 100, 0.95, 1, 1, 20, 1)
end

Remove Anti Lock

Removes the platform's AntiLockPlatform component, causing it to stop moving between points and start moving towards its home position. ~ Can only be called if the platform has an AntiLockPlatform component. A platform with an AntiLockPlatform component keeps setting its home to its position, so the platform's home is its position when this is called.

Platform.RemoveAntiLock()

Example:

if (plat.IsAntiLock()) then
    plat.RemoveAntiLock()
end

Remove Vector Field

Removes the platform's VectorFieldPlatform component, causing it to stop orbiting a point and start moving towards its home position. ~ Can only be called if the platform has a VectorFieldPlatform component. A platform with a VectorFieldPlatform component keeps setting its home to its position, so the platform's home is its position when this is called.

Platform.RemoveVectorField()

Example:

if (plat.IsVectorField()) then
    plat.RemoveVectorField()
end