HammeriteEditorHandle
Core: entities. Inherits RefCounted
One point in the world an author can take hold of and drag.
A vector property - which way a current runs, where a light is aimed, how far a door travels - is a direction and a distance, and typing six numbers at it is not how anybody knows whether it is right. A handle is the same value with something to grab. Offered by whatever owns the value, through the two optional hooks on the entity interface (get_editor_handles and move_editor_handle); the editor does the picking, the dragging and the snapping, and hands back a world position. What that position MEANS is the owner's - it is the one that knows the value is a direction rather than a point.
Properties
| Type | Name | Default |
|---|---|---|
Color | color | |
StringName | id | |
Vector3 | position |
Methods
| Returns | Method |
|---|---|
HammeriteEditorHandle | create(handle_id: StringName, at: Vector3, tint: Color = Color(1, 1, 1, 1)) static |
Property descriptions
color
var color: Color
What colour it is drawn in. The editor lightens it while the cursor is on it.
id
var id: StringName
Which handle this is, to the thing that offered it. Unique within one object; the editor only hands it back to move_editor_handle, and never interprets it.
position
var position: Vector3
Where it is now, in world space.
Method descriptions
create()
static func create(handle_id: StringName, at: Vector3, tint: Color = Color(1, 1, 1, 1)) -> HammeriteEditorHandle
A new one, from what new() took before it was native: a native class is made with no arguments.