Player Local UI component

A component for creating UI that can display content specific to each player.

This component can be created by right-clicking in the Hierarchy view and selecting UI/PlayerLocalUI - cluster. PlayerLocalUI has Render Mode settings that can be used for rendering in either screen space or world space. This can be determined by the Render Mode value on the Canvas component. However, if the RenderMode value is ScreenSpaceCamera, it will be forced to ScreenSpaceOverlay.

Properties

Property	Function
Sorting Order Type	Specifies the drawing order of UI. For either value, the Canvas component’s Sorting Order property accepts values from -100 to 100.
- Default	When selected, UI is drawn in the background.
- Interactable	When selected, UI is drawn in front of some system UI elements, enabling interaction with interaction components.

On Desktop and Mobile environments, for Canvas with Screen Space Overlay Render Mode, the UI drawing order is dynamically adjusted in the application based on Sorting Order Type. In other cases, the Sorting Order Type value is ignored.

For more details about interaction components, please refer to the Unity manual:

Unity Manual | Interaction Components

ScreenSpaceOverlay

In this rendering mode, UI elements are rendered over the scene and placed on screen, always visible. Using this component allows creation of UI that’s always visible and adapted to each device. On 2D devices, it appears as a fixed-position overlay, while on VR devices it appears as a player-following floating UI. UI elements in this rendering mode can be interacted with under the following conditions:

Desktop and Mobile
- All operations on interaction components are possible
- The Sorting Order Type property value must be set to Interactable
VR
- All operations on interaction components are possible
- UI elements requiring interaction must have a Collider attached
- UI elements requiring interaction must have their Layer set to UI

WorldSpace

In this rendering mode, PlayerLocalUI is placed within the space. On both 2D and VR devices, UI elements are displayed in front of or behind other objects in the scene based on 3D positioning. UI elements in this rendering mode can be interacted with under the following conditions:

Desktop and Mobile
- Only Button component and Toggle component operations are possible among interaction components
  - Operations like dragging or slider manipulation are not possible
- UI elements requiring interaction must have a Collider attached
VR
- All operations on interaction components are possible
- UI elements requiring interaction must have a Collider attached
- UI elements requiring interaction must have their Layer set to UI

Items containing this component cannot be generated using Create Item Gimmick or ClusterScript.createItem in Scriptable Item.

When Render Mode is ScreenSpaceOverlay, UI can be displayed in device-appropriate positions by placing it as a child of an object with the Safe Area component. When Render Mode is WorldSpace, UI does not need to be placed as a child of an object with the Safe Area component.

To interact with UI elements of this component, a Graphics Raycaster component must be attached.

Navigation operations for UI in child elements of objects with this component are disabled.

Safe Area component >

When this component is added, Canvas, Canvas Scaler, and Safe Area are automatically added and configured.

Since the hierarchy of GameObjects with this component will be modified, object hierarchy order is not guaranteed.