self:set_platform_on_leave

Client

Sets the platform-leave velocity behavior of the character body


Syntax

local status = self:set_platform_on_leave(
    mode
)

Parameters

TypeNameDescription
intmodePlatform-on-leave enum value — refer to physics.character.platform_on_leave

Returns

TypeNameDescription
boolstatustrue on successful execution, false otherwise

Examples

Set platform on leave for a character body
local entity = physics.character.create()

entity:set_platform_on_leave(physics.character.platform_on_leave.ADD_VELOCITY)

On this page