EditorHintRegistry class abstract base

The hints an editor builds its inspectors from: the slot a plugin hands its ComponentHints, EntityKindHints and MaterialHints to, host.maybeRegistry<EditorHintRegistry>().

Only an editor has one. A game's engine hands its host no such registry, so a plugin asks with maybeRegistry and skips the hints when the answer is null; an editor's EditorPieces brings one along.

Namespaced as every registration is (PluginManifest.namespace): through a plugin's view a component id and a lit model's name are <namespace>.<name>, given whole or given bare and prefixed for it, and a lit model may be <namespace>_<name>, the stage name a shader has; a name in another namespace is refused. An entity type is the level format's word and is not.

Extended by the editor, called by plugins: base, so a member added in a minor arrives with a default.

Inheritance

Constructors

EditorHintRegistry()
const

Properties

companions → Iterable<PluginRegistry>
The registries that come with this one, found by PluginHost.registry as if each had been handed to the host itself.
no setterinherited
components → List<ComponentHints>
Every component's hints, in order: the application's, then each plugin's by install order.
no setter
entityKinds → List<EntityKindHints>
Every entity kind's hints, in the same order.
no setter
hashCode → int
The hash code for this object.
no setterinherited
materials → List<MaterialHints>
Every lit model's hints, in the same order.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addComponent(ComponentHints hints) → Registration
Shows hints in the inspector of every entity they belong on. Throws an ArgumentError for an id another owner already hinted, naming it.
addEntityKind(EntityKindHints hints) → Registration
Shows hints in the inspector of every entity of its type, and offers the type in the palette. Throws an ArgumentError for a type another owner already hinted, naming it.
addMaterial(MaterialHints hints) → Registration
Shows hints in the material panel of every material whose lighting model is MaterialHints.model. Throws an ArgumentError for a model another owner already hinted, naming it.
forPlugin(PluginScope scope) → EditorHintRegistry
This registry as scope's plugin sees it: everything registered through the result is tracked by scope, ranked by it, and checked against its manifest. Must return the same type the registry is looked up by.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited