EntUICanvas

UI Canvas
Canvas where UI entities can be placed under

ID: EntUICanvas
Required By: GameOverScreen, YouDiedScreen
Base Type: Entity Component

Values

Name

Type

Description

On User

Entity Component Variable

The User this Canvas is on if this is on a player Screen / Tool - - ReadOnly

On Player Avatar

Entity Component Variable

The Avatar this Canvas is on if this is on a player Screen / Tool. Will update to the User's current avatar if on a User - - ReadOnly

Screen Overlay

Bool Variable

Canvas will overlay over the screen for all users. Will not show in VR/AR headset (Create a Prefab and set that as the HUD in Creation Settings for that)

Canvas Size

Vector2 Variable

Show Border

Bool Variable

Defaults to True

Show Background

Bool Variable

Defaults to True

Interactable

Bool Variable

Allows users to interact with UI when in the world - Defaults to True

Background Color

Color Variable

Test With Avatar In World

Bool Variable

Set this Canvas's PlayerAvatar to the first PlayerAvatar thats in the world as if this Cavnas was it's UI HUD

Properties

Name

Type

Description

On UI Screen Canvas

UI Screen Canvas

The UI Screen canvas this canvas this is on if part of a UI Screen

Canvas Mode

UI Canvas Mode

The current state of the canvas - if it's in the World / In a Menu / Screen

Attributes:
ModboxMain.MBTypeComponentNoIngameAddingAttribute