Skip to main content

WorldProperties

info
  • This static class is only available on LocalScripts and LocalAvatarScripts

The WorldProperties class allows LocalScripts to read/modify properties of the current World's restrictions, as visible in the World component, that is focused.

note

You must get the current WorldProperties from World.Properties

Instance Properties

Property NameProperty TypeDescription
AllowRespawnboolAllows a player to use the respawn button in their menu
GravityfloatThe y-axis value of gravity in a world
JumpHeightfloatThe player's jump height
WalkSpeedfloatThe player's walking speed
RunSpeedfloatThe player's running speed
AllowRunningboolAllows a player to run
AllowScalingboolAllows a player to scale their character
LockAvatarSwitchingboolAllows a player to switch their avatar