SchemaField class

Annotates a Dart field to describe the corresponding Lua table field.

When omitted, the generator infers the Lua type from the Dart type and treats the field as optional.

Constructors

SchemaField({String? type, required String description, bool required = false, Object? defaultValue, String? group, String? dependsOn, num? min, num? max, num? step, List<String>? choices, bool deprecated = false, String scope = 'public'})
const

Properties

choices → List<String>?
Restricted set of allowed values.
final
defaultValue → Object?
Default value shown in documentation.
final
dependsOn → String?
Another field key that must be truthy for this one to apply.
final
deprecated → bool
Whether this field is deprecated.
final
description → String
Human-readable description.
final
group → String?
UI group/category for organising fields.
final
hashCode → int
The hash code for this object.
no setterinherited
max → num?
Maximum allowed value.
final
min → num?
Minimum allowed value (for numeric fields).
final
required → bool
Whether the field must always be present in the Lua table.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope → String
Access scope for this field.
final
step → num?
Increment step.
final
type → String?
Override the Lua type string (e.g. "string[]", "integer").
final

Methods

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