ComponentHints class final

The fields of one component type a plugin registers, as an inspector shows them under one heading.

Keyed by id, the component's codec id (boats.buoyancy), which is the plugin's namespace and the component's name in every file. An entity of one of entityTypes shows the section; empty shows it on every entity.

Constructors

ComponentHints({required String id, required String title, List<FieldHint> fields = const <FieldHint>[], Set<String> entityTypes = const <String>{}})

Hints for the component whose codec id is id, shown under title; with no fields the heading has nothing under it, and with no entityTypes it shows on every entity.

const

Properties

entityTypes → Set<String>

The entity types it belongs on; empty for all of them.

final

fields → List<FieldHint>

Its fields, in the order the inspector lists them.

final

hashCode → int

The hash code for this object.

no setter, inherited

id → String

The component's codec id.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → String

The heading the inspector shows.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

As a document writes it.

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromJson(Object? json) → ComponentHints

What json holds, as toJson writes it. Throws a DocumentFormatException for anything else.