scala-native-gdextension
API
Generated with
scala-native-gdextension/gdext/gdext.annotations

gdext.annotations

package gdext.annotations

Members list

Type members

Classlikes

final class exportAnimation(comp: String) extends StaticAnnotation

Dropdown of the animations of the referenced AnimationPlayer/AnimationMixer comp.

Dropdown of the animations of the referenced AnimationPlayer/AnimationMixer comp.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportAnimationProperty(comp: String) extends StaticAnnotation

Dropdown of the parameters/... paths of the referenced AnimationTree comp.

Dropdown of the parameters/... paths of the referenced AnimationTree comp.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportAnimationStateName(comp: String) extends StaticAnnotation

Dropdown of the state names of the referenced AnimationTree comp's root state machine (the names AnimationNodeStateMachinePlayback.travel accepts).

Dropdown of the state names of the referenced AnimationTree comp's root state machine (the names AnimationNodeStateMachinePlayback.travel accepts).

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportAnimationStateNode(comp: String, state: String) extends StaticAnnotation

Dropdown of the sub-node names inside one state's AnimationNodeBlendTree (e.g. a OneShot node to fire via parameters/<state>/<node>/request). state selects the state exactly as in exportAnimationStateProperty.

Dropdown of the sub-node names inside one state's AnimationNodeBlendTree (e.g. a OneShot node to fire via parameters/<state>/<node>/request). state selects the state exactly as in exportAnimationStateProperty.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportAnimationStateProperty(comp: String, state: String) extends StaticAnnotation

Dropdown of the parameter names under one state of the referenced AnimationTree comp — the <param> in parameters/<state>/<param>. state names a sibling String field (typically an exportAnimationStateName one) whose CURRENT value selects the state, so the options follow it.

Dropdown of the parameter names under one state of the referenced AnimationTree comp — the <param> in parameters/<state>/<param>. state names a sibling String field (typically an exportAnimationStateName one) whose CURRENT value selects the state, so the options follow it.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportBoneName(comp: String) extends StaticAnnotation

Dropdown of the bones of the referenced Skeleton3D comp.

Dropdown of the bones of the referenced Skeleton3D comp.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportCategory(name: String) extends StaticAnnotation

Starts an inspector category (@export_category) at the annotated property.

Starts an inspector category (@export_category) at the annotated property.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportGroup(name: String, prefix: String = ...) extends StaticAnnotation

Starts an inspector group (gdext / GDScript @export_group) at the annotated property; following exported properties stay in the group until the next section marker. prefix, if given, is stripped from member display names.

Starts an inspector group (gdext / GDScript @export_group) at the annotated property; following exported properties stay in the group until the next section marker. prefix, if given, is stripped from member display names.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportSpriteAnimation(comp: String) extends StaticAnnotation

Dropdown of the animation names of the referenced SpriteFrames comp.

Dropdown of the animation names of the referenced SpriteFrames comp.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class exportSubgroup(name: String, prefix: String = ...) extends StaticAnnotation

Starts an inspector subgroup (@export_subgroup) at the annotated property.

Starts an inspector subgroup (@export_subgroup) at the annotated property.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class func extends StaticAnnotation

Marks a method as callable from Godot/GDScript (gdext #[func]).

Marks a method as callable from Godot/GDScript (gdext #[func]).

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class gdexport(hint: ExportHint = ...) extends StaticAnnotation

Marks a var as an editor-exposed property (gdext #[export]). The macro registers it using a get_<name>/set_<name> accessor pair derived from the field. (Named gdexport because export is a Scala keyword.)

Marks a var as an editor-exposed property (gdext #[export]). The macro registers it using a get_<name>/set_<name> accessor pair derived from the field. (Named gdexport because export is a Scala keyword.)

An optional ExportHint customises the inspector widget, mirroring GDScript's @export_range / @export_file / @export_multiline / … :

 @gdexport(ExportHint.range(0, 100)) var hp: Int = 50

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any
final class signal extends StaticAnnotation

Declares a (currently no-argument) signal on the class (gdext #[signal]). Apply to a def <name>(): Unit member; only the name is used.

Declares a (currently no-argument) signal on the class (gdext #[signal]). Apply to a def <name>(): Unit member; only the name is used.

Attributes

Supertypes
trait StaticAnnotation
class Annotation
class Object
trait Matchable
class Any

Value members

Concrete methods

def nameOf(field: Any): String

Compile-time field-name reference for the annotation arguments above: @exportAnimationStateName(nameOf(animationTree)) means "animationTree" but follows the field through renames. Only usable on CLASS-BODY fields — an annotation argument on a constructor param is typed outside the class scope and cannot see sibling params, so ctor-param dropdowns must keep string arguments. Only meaningful inside these annotations (the registration macro reads the referenced field's name from the tree); calling it at runtime throws.

Compile-time field-name reference for the annotation arguments above: @exportAnimationStateName(nameOf(animationTree)) means "animationTree" but follows the field through renames. Only usable on CLASS-BODY fields — an annotation argument on a constructor param is typed outside the class scope and cannot see sibling params, so ctor-param dropdowns must keep string arguments. Only meaningful inside these annotations (the registration macro reads the referenced field's name from the tree); calling it at runtime throws.

Attributes

Generated with