SUICanvas is root component for UI elements.

Properties

bool IsRootCanvas {get;}

The avoidance radius for the agent.

local canvas=Space.Host.GetReference("Canvas").UICanvas
Space.Log(canvas.IsRootCanvas)

--print true.

float ReferencePixelsPerUnit {get; set;}

If a sprite has this "Pixels Per Unit" setting, then one pixel in the sprite will cover one unit in the UI.

local canvas=Space.Host.GetReference("Canvas").UICanvas
Space.Log(canvas.ScaleFactor)

--return scale factor.

float ScaleFactor {get; set;}

Scales all UI elements in the Canvas by this factor.

local canvas=Space.Host.GetReference("Canvas").UICanvas
Space.Log(canvas.ReferencePixelsPerUnit)

--return reference pixels per unit.

bool PixelPerfect {get; set;}

Should the UI be rendered without antialiasing for precision?

local canvas=Space.Host.GetReference("Canvas").UICanvas

Space.Log(canvas.PixelPerfect)

float PlaneDistance {get; set;}

The distance at which the UI plane should be placed in front of the camera.

local canvas=Space.Host.GetReference("Canvas").UICanvas
Space.Log(canvas.PlaneDistance)

--return plane distance.

int SortingOrder {get; set;}

Canvas' order within a sorting layer.

local canvas=Space.Host.GetReference("Canvas").UICanvas
Space.Log(canvas.SortingOrder)

--return sorting order.

int TargetDisplay {get; set;}

For Overlay mode, display index on which the UI canvas will appear.

local canvas=Space.Host.GetReference("Canvas").UICanvas

Space.Log(canvas.TargetDisplay)

int SortingOrder {get; set;}

Canvas' order within a sorting layer.

local canvas=Space.Host.GetReference("Canvas").UICanvas
Space.Log(canvas.SortingOrder)

--return sorting order.

float NormalizedSortingGridSize {get; set;}

The normalized grid size that the canvas will split the renderable area into.

local canvas=Space.Host.GetReference("Canvas").UICanvas
Space.Log(canvas.NormalizedSortingGridSize)

--return normalized sorting grid size.

Scripting/SUICanvas