Component:LocomotionPermissions

From Resonite Wiki
Revision as of 16:54, 14 February 2024 by 989onan (talk | contribs) (fix categories)

Introduction

The LocomotionPermissions component allows you to control what locomotions users can use in your world.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
LocomotionListMode ListFilterMode Whether to blacklist or whitelist the Locomotions.
Locomotions list List of Locomotions to blacklist/whitelist.
Scaling PermissionState Whether self scale is Disallowed, Allowed, or Edit Mode Only.
MinScale float Minimum scale
MaxScale float Maximum scale
JumpToUser PermissionState Whether jumping to users is Disallowed, Allowed, or Edit Mode Only.

Usage

Find Roles slot

You will need to first find the Roles slot, typically it is directly under the world's Root. Under the Roles slot there is a list of the roles you can select from.

Find/attach the permission component

You will need to find the LocomotionPermissions component on the selected role slot, if the component is not there you can attach one with the component browser from the Permissions component folder.

Configuration

A locomotion blacklist

The LocomotionPermissions component can be switched between Blacklisting and Whitelisting the locomotions supplied in the Locomotions list. Valid LocomotionTypes you can enter are:

  • FrooxEngine.NoclipLocomotion
  • FrooxEngine.PhysicalLocomotion
  • FrooxEngine.TeleportLocomotion
  • FrooxEngine.GrabWorldLocomotion
  • FrooxEngine.SlideLocomotion

Next you will need to select what roles the component effects.