Switch Devices

Use this switch on devices players can turn on or off, or for other interactions.

There are two ways you can use a Switch.

  • As a physical switch that players can interact with, used with other devices so that players can open and close doors or turn lights off and on.

  • As a method for filtering interactions with other devices. For example, if the state of the Switch is On, it will transmit on one channel, and if the Switch is Off, it will transmit on another channel.

Finding and Placing the Device

Click image to enlarge.

  1. From Build mode, press the Tab key to open the Creative inventory screen.

  2. Click the Devices tab. You can scroll to select the device, use the Search box to look up the device by name, or the Categories in the panel on the left.

  3. Click PLACE NOW to place immediately, or put the device in the QUICK BAR to place later.

  4. Press Esc to return to your island in Build mode. Use your phone to position the device, then click to place it. Press Esc to detach the device from your phone.

  5. Point at the device with your phone. If the Customize popup doesn't open immediately, move closer until it does, then press E to open the Customize panel.

If you're using multiple copies of a device on an island, it can be helpful to rename them. You can choose names that relate to each device's purpose, so it's easier to remember what each one does.

Device Options

This device has some basic functionality, like setting switch visibility, and choosing what text the player sees when they interact with the switch. Additionally, there are some advanced options that you can use if the switch is able to save its state.

You can configure this device with the following options.

Default values are bold.

Basic Options

Option

Value

Description

Enabled at Game Start

Yes, No

Determines whether the device is enabled when the game starts. Disabled devices ignore all events except Enable.

Initial State

Off, On

This is the default starting state of the switch when there is no player-sourced state to override it.

Visible During Game

Yes, No

Determines whether the device is visible to players during the game.

Turn On Text

Enter text into field

Sets the interact text for turning the Switch to the on position.

Turn Off Text

Enter text into field

Sets the interact text for turning the Switch to the off position.

Device Model

Default, Antique Lever, Toggle Switch, Defaul (Unlit), Antique Lever (Unlit)

This is the visual model used for the switch.

Sound

Enabled, Disabled

Determines whether the switch makes a sound when it changes state (from Off to On, from On to Off).

Interact Time

Do Not Interact, Instant, Pick an amount of seconds

Determines how long the player interaction must be to activate the device.

All Options (Additional)

Option

Value

Description

Times Can Change

Infinite, Pick a number

Determines the number of times the device can change its state before it is disabled.

Interaction Cooldown

Instant, Infinite, Pick a time

Determines the cooldown time between interactions with the device.

Allowed Class

No Class, Any, Pick a class

Determines which class can activate the device.

Allowed Team

Any, Pick a team

Determines which team can activate the device.

Interaction Radius

0, Pick a radius distance

Allows players to interact by looking at any point within a radius of the specified size, rather than having to look directly at the button. Use in conjunction with the Visibility setting to make it appear as though players are interacting with other props.

Auto-Save State

No, Yes

Determines whether the device's state is saved automatically when the state changes.

Auto-Load State

Off, Game Start

Determines whether the device's saved state is loaded automatically at the start of the game, or if the saved state must be loaded by receiving a signal.

Store State Per Player

No, Yes

If you choose No, the saved state for a switch is the same for all players already in the game. If you choose Yes, the state of the switch is saved only for the instigating player; that player sees the state they instigated and changing the state of the switch only affects them. At the start of the game, the device will sync for each player individually.

Resolve Conflicts

Majority, First Player, Prioritize On, Prioritize Off

If Store State Per Player is set to No, this determines how states are loaded for the device.

Values for this option are:

  • First Player: Uses the data from the oldest active player.

  • Majority: Will pick the most present value; if there is a tie, the device will use the default initial state.

  • Prioritize Off: Will load the Off state if at least one player has that state.

  • Prioritize On: Will load the On state if at least one player has that state.

Check State at Game Start

Enabled, Disabled

If this option is enabled and you have chosen channels for the If On When Checked Transmit On and If Off When Checked Transmit On options, the device will send a signal on the channel matching its state at the start of the game.

Check Switch State When Disabled

Yes, No

Determines whether the device will check its state at the game start, sending a signal according to the outcome.

Channels

When one device needs to "talk" to another device, it does so by transmitting a signal on a specific channel. The receiving device needs to be set up to receive the signal on the same channel.

A channel is identified by a number, and channel numbers are customized for a device under the option that uses the channel. Most devices will also pass the identity of the player who triggered the device with the signal.

This device has receivers that perform a variety of functions when receiving a signal over a channel. Also, this device can transmit signals when certain conditions are met.

Receivers

Receivers listen for a channel and perform an action when they hear any device (including themselves) send a signal on that channel.

Option

Value

Description

Enable When Receiving From

No Channel, Pick a channel

Enable the device when it receives a signal on the selected channel.

Disable When Receiving From

No Channel, Pick a channel

Disable the device when it receives a signal on the selected channel.

Turn On When Receiving From

No Channel, Pick a channel

Change the device state to On when it receives a signal on the selected channel.

Turn Off When Receiving From

No Channel, Pick a channel

Change the device to Off when it receives a signal on the selected channel.

Load State When Receiving From

No Channel, Pick a channel

Load the device's state when it receives a signal on the selected channel.

Save State When Receiving From

No Channel, Pick a channel

Save the device's state when it receives a signal on the selected channel.

Check State When Receiving From

No Channel, Pick a channel

Check the device's state when it receives a signal on the selected channel.

Clear Player Persistence Data When Receiving From

No Channel, Pick a channel

When the device receives a signal on the selected channel, it clears save data for the instigating player.

Clear All Persistence Data When Receiving From

No Channel, Pick a channel

When the device receives a signal on the selected channel, it clears save data for all players.

Transmitters

Transmitters send a signal on the selected channel when triggered.

Option

Value

Description

When Turned On Transmit On

No Channel, Pick a channel

When a player changes the Switch to On, the device transmits a signal on the selected channel.

When Turned Off Transmit On

No Channel, Pick a channel

When a player changes the Switch to Off, the device transmits a signal on the selected channel.

When State Change Transmit On

No Channel, Pick a channel

When a player changes the Switch state, the device transmits a signal on the selected channel.

If On When Checked Transmit On

No Channel, Pick a channel

If the Switch is On when the state is checked, the device transmits a signal on the selected channel.

If Off When Checked Transmit On

No Channel, Pick a channel

If the Switch is Off when the state is checked, the device transmits a signal on the selected channel.

On State Save Transmit On

No Channel, Pick a channel

When the Switch state is saved, the device transmits a signal on the selected channel.