Skip to main content

Local

This is a global variable that allows you to access local player related APIs.

Global Methods

Local.SetSkin(skin: string)

Sets the skin of the local player.

Local.Teleport(pos: vec3)

Teleports the local player to a specific position.

Local.UnlockAbility(ability: Ability)

Enables an ability for the local player. ability must be one of these abilities from the global Ability table.

Example of enabling the local player's ability to use the wingsuit:

Local.UnlockAbility(Ability.Wingsuit)

Local.LockAbility(ability: Ability)

Disables an ability for the local player. ability must be one of the abilities from the global Ability table.

Example of disabling the local player's ability to use the grappling hook:

Local.LockAbility(Ability.GrapplingHook)

Local.IsAbilityUnlocked(ability: Ability)

Returns true if the given ability is enabled for the local player, false if disabled. ability must be one of the abilities from the global Ability table (shown above).