Skip to main content

Multiplayer

ChatEnabledDropdown​

ChatEnabledDropdown(width?=, [ui])

Creates a dropdown in the user interface that allows the current player to change whether or not they can see the chat controls when in-game.

  • width (Number): the width of the chat editor in em units.
  • ui (UI): the slot in the user interface to insert the dropdown element.

ChatEnabledIntent​

ChatEnabledIntent(enabled) -> intent

Returns an intent to change whether chat is enabled or disabled. Attach the intent to a button Button to trigger it.

  • enabled (Boolean): Whether to enable or disable chat.

ChatEnabledToggle​

ChatEnabledToggle([ui=]) |use ui:whenOn, use ui:whenOff| { }

Creates an element in the user interface that allows the player to toggle the chat panel on or off.

  • ui (UI): The slot in the user interface where the element will be inserted.

Subblock: The subblock will be called immediately to populate the element's content. The subblock is optional as there are defaults for both the on and off states. Use the %ui:whenOn { ... } syntax to populate one of the slots, see UI for more information.

  • ui:whenOn (UI): populate this slot with the content that should be displayed when the chat is enabled. If left empty, will display a default button that will toggle the chat to off.
  • ui:whenOff (UI): populate this slot with the content that should be displayed when the chat is disabled If left empty, will display a default button that will toggle the chat to on.

PerformanceDialogIntent​

PerformanceDialogIntent(show) -> intent

Returns an intent to change whether performance dialog is shown or hidden. This dialog allows the player to view and modify their input latency settings.

Attach the intent to a button Button to trigger it.

  • show (Boolean): Whether to show or hide the performance dialog.

PerformanceDialogToggle​

PerformanceDialogToggle([ui=]) |use ui:whenShowing, use ui:whenHidden| { }

Creates an element in the user interface that allows the player to toggle the performance dialog on or off. This dialog allows the player to view and modify their input latency settings.

  • ui (UI): The slot in the user interface where the element will be inserted.

Subblock: The subblock will be called immediately to populate the element's content. The subblock is optional and is only needed if you want to override the default toggle button styling. Use the %ui:whenShowing { ... } syntax to populate one of the slots, see UI for more information.

  • ui:whenShowing (UI): populate this slot with the content that should be displayed when the performance dialog is showing. If left empty, will display a default button that will toggle the performance dialog to hidden.
  • ui:whenHidden (UI): populate this slot with the content that should be displayed when the performance dialog is hidden. If left empty, will display a default button that will toggle the performance dialog to showing.

RoamIntent​

RoamIntent(roam) -> intent
warning

Requires the regionAffinity experimental feature to be enabled.

Returns an intent to enter or exit roaming mode. When a player is in roaming mode, they are able to play with players from all regions, instead of just their home region. Attach the intent to a button Button to trigger it.

  • roam (Boolean): true to enter roaming mode, false to exit.

RoamingDialogIntent​

RoamingDialogIntent -> intent
warning

Requires the regionAffinity experimental feature to be enabled.

Returns an intent to display the roaming dialog. This dialog lets the player choose whether to play with only players in their home region, or to play with players from all regions. Attach the intent to a button Button to trigger it.

RoamingToggle​

RoamingToggle([ui=]) |use ui:whenOn, use ui:whenOff| { }
warning

Requires the regionAffinity experimental feature to be enabled.

Creates an element in the user interface that allows the player to switch roaming mode on or off. When a player is roaming, they are able to play with players from all regions, instead of just their home region.

  • ui (UI): The slot in the user interface where the element will be inserted.

Subblock: The subblock will be called immediately to populate the element's content. It is optional as there are defaults for both fullscreen and windowed states. Use the %ui:whenOn { ... } syntax to populate one of the slots, see UI for more information.

  • ui:whenOn (UI): populate this slot with the content that should be displayed when roaming. If left empty, will display a default button that will open the roaming dialog (the same one as RoamingDialogIntent).
  • ui:whenOff (UI): populate this slot with the content that should be displayed when not roaming. If left empty, will display a default button that will open the roaming dialog.