Skip to main content

LensStudio:Ui.ProjectSettings.Error

Class

Represents a project settings validation error with a human-readable description.

Index

Properties

Example

const Ui = await import('LensStudio:Ui');

// ProjectSettings.Error represents a critical project configuration issue.
// Create one with a description and pass to setIssues() in a ProjectSettingsPlugin.
const error = new Ui.ProjectSettings.Error('Missing required texture asset');
console.log('Error description:', error.description);

// Errors are passed alongside Warnings and NoIssues to setIssues()
const warning = new Ui.ProjectSettings.Warning('Texture resolution is low');
const noIssue = new Ui.ProjectSettings.NoIssue();
console.log('Warning description:', warning.description);
console.log('NoIssue created');

Constructors

Constructor

new Error(description): Error

Constructs a project settings error with the given description string.

Parameters

ParameterType
descriptionstring

Returns

Error

Properties

description

description: string

Human-readable message describing the project settings error.