Skip to content

6. Included Plugins

Child of the Beast edited this page Apr 14, 2023 · 7 revisions

Global Toggle

Global toggle that allows people in specific or generic roles to use.

Inspector

Manager - Plug your DisBridge Plugin Manager into here.
Targets - an array of GameObjects that the toggle affects.
Off If Not Usable - If the user cannot use the button, it will not be visible if this is set to True.
Check Staff - If this is True, it will allow All Staff to use the button.
Check Supporters - If this is True, it will allow All Supporters to use the button.
Check Roles - Allows the Specified roles to use the button.


Button - The GameObject that is used for the Button. Make sure this script isn't on or a child of this object
buttonCollider - This Collider gets turned off if Off If Not Usable is TRUE. If you using UI buttons, leave this empty.
Toggle Indicator - The GameObject used to display what state the toggle is in. This Object will be On if the toggle is On, and Off if the toggle is Off

Local Toggle

Local toggle that allows people in specific or generic roles to use.

Inspector

Manager - Plug your DisBridge Plugin Manager into here.
Targets - an array of GameObjects that the toggle affects.
Off If Not Usable - If the user cannot use the button, it will not be visible if this is set to True.
Check Staff - If this is True, it will allow All Staff to use the button.
Check Supporters - If this is True, it will allow All Supporters to use the button.
Check Roles - Allows the Specified roles to use the button.


Button - The GameObject that is used for the Button. Make sure this script isn't on or a child of this object
buttonCollider - This Collider gets turned off if Off If Not Usable is TRUE. If you using UI buttons, leave this empty.
Toggle Indicator - The GameObject used to display what state the toggle is in. This Object will be On if the toggle is On, and Off if the toggle is Off

Whitelist

Automatically turn on objects for people in specific or generic roles. Other plugins can use toggle whitelists on or off.

Inspector

Manager - Plug your DisBridge Plugin Manager into here. checkStaff - If this is True, it will allow All Staff to use the button. checkSupporters - If this is True, it will allow All Supporters to use the button. checkRoles - Adds the role specified to the unlock check. TargetsDefaultOff - These are OFF by default. When a player's name matches the list, these will TURN ON. TargetsDefaultOn - These are ON by default. When a player's name matches the list, these will TURN OFF.

Role Board

Displays all the names in a Role or group.

Inspector

Manager - Plug your DisBridge Plugin Manager into here.
Type - This defines what the Role Board lists.
    When set to 0 it uses the defined role in Role Container
    When set to 1 it lists all of the roles marked as Staff.
    When set to 2 it lists all of the roles marked as Supporter.

Role ID - The Role ID of the role you want to use. If this is blank, the below Index will be used instead. Role Container - This is the index of the role you want to be displayed.
Custom Title - If this is filled in, the title of the Role Board will be set to this.
Leave this blank if you dont want to use a custom title.

Role Title - This is the TextMeshPro text that will be used to display the role's title.
Role List - This is the TextMeshPro text that will be used to display the user list.
Separator - The separator is placed in-between the users listed in Role List

Role Tags

Displays the Role of the user above the user.

Inspector

Manager - Plug your DisBridge Plugin Manager into here.
Look At Target - This is the object the RoleTags face towards. By default, this is the local player's head.
Offset Val - The value used to offset the RoleTags's Y value.
Tint Name - The name of the gameobject or Objects that will be tinted based on the role color.
Ignored Roles - The index of a role that will be ignored.
Tags - These are the actual tags used to display the roles. You want the amount of tags to be double your player cap.
    As an example, if your player cap is 40, you want 80 tags.
    And if your player cap is 20, you want 40 tags.

Keypad

A keypad used for turning objects on or off, can be hooked into an existing whitelist.
The code can be updated through Discord

Inspector

Manager - Plug your DisBridge Plugin Manager into here.
Whitelist - Target whitelist will be unlocked if keycode is entered.
view - TextMeshPro text used for the keypad view.
placeholderView - GameObject used for the placeholder view when the keypad has nothing entered.
autoEnter - Auto enters the code if the length of the input code matches the length of the actual code.
showCode - Defines if the local user's code entry should be censored.
hideChar - Char that is used to hide the password if Show Code is false.