Saltar al contenido principal

Roles

Roles are given to user to grant them access to certain features of your map. You can create as many roles as you want by duplicating one of the existing ones.

aviso

There should not be more than 1 role with the same name or password!

Settings​

  • RoleName : string - Internal role name, used for a couple of functions like search and sort and displayed in many places like in the keypad screen when you log in.
  • Password : string - Password that will log in the user, case sensitive, can be null.
  • ChildrenRol : KeyPadRol - If set, you will be logged in in the children role when logged into this one.
  • AttachedProduct : UdonProduct - If set, you will get logged in this role when the linked product is bought using CreatorEconomy.
  • Crown : Crown : If set, users in this role will be given a specific crown using FloatingTags
  • LoginSound : AudioClip - Sound that will be played for everyone when someone with this role joins the instance.
  • Color : Color - Associated color, does nothing by itself but used by external systems.
nota

Password fields are strings to allow for custom keypads to use alphanumeric passwords, but the default keypad only supports numbers 0-9.

Users​

Apart from using the password you can login into the role automatically using a whitelist.

  • UserList : string[] - List of usernames that will be automatically logged into this role when they join.
  • Url : VRCUrl - Url to get username list from.
aviso

VRCUrls can be intercepted and therefore changed by malicious actors, its not recommended to have important roles like admin/staff logged in from a remote list.

Objects​

The keypad main utiliy its to control the activestate of different gameobjects in your scene.

  • ShowObjects : GameObject[] - List of objects to turn ON when you login.
  • HideObjects : GameObject[] - List of objects to turn OFF when you login.
tip

If you want to create an easy restricted area, put a collider and add that collider to the HideObjects list of the role you want to have access to that area.

Listeners​

Listeners are used to send events to other UdonBehaviours on login/logout.

  • LoginListeners : [UdonBehaviour|String] - List of Behaviour and their respective event to send on login.
  • LogoutListeners : [UdonBehaviour|String] - List of Behaviour and their respective event to send on logout.