HammeriteBrushEntityArea3D
Core: entities. Inherits Area3D
The interface of HammeriteBrushEntityNode3D on an Area3D: brushwork that notices what is inside it, such as water or a trigger.
Each brush's collision shape is its convex hull. Its meshes are drawn only while the editor is up (set_editor_active()): a volume is more often invisible than not. A script writes the interface as the underscore virtuals - _set_editor_active(), _apply_entity_property(), _trigger() and the rest - and everybody calls the public method of the same name, which answers the script's override where there is one and otherwise the class's own. _set_entity(), _update_properties(), _apply_entity_property(), _get_actions() and _run_action() run after the class's own rather than instead of it, so an override does not call super(): GDScript cannot call one into a native class.
Properties
| Type | Name | Default |
|---|---|---|
HammeriteBrushEntity | entity | |
bool | monitorable | false |
bool | monitoring | false |
Methods
Signals
rebuild_requested
signal rebuild_requested()As HammeriteBrushEntityNode3D.rebuild_requested.
Property descriptions
entity
var entity: HammeriteBrushEntityAs HammeriteBrushEntityNode3D.entity.
monitorable
var monitorable: bool = falseUndocumented.
monitoring
var monitoring: bool = falseUndocumented.
Method descriptions
_apply_entity_property()
func _apply_entity_property(prop_name: StringName, value) -> voidAs HammeriteBrushEntityNode3D.apply_entity_property().
_can_simulate()
func _can_simulate() -> boolWhether the editor offers to run this entity, and whether HammeriteMap3D.start_simulation() starts it. The default does nothing when run, so offers nothing.
_can_trigger()
func _can_trigger() -> boolWhether something - the editor's Trigger, a HammeriteTrigger, the game - may trigger() it.
_draw_editor_gizmos()
func _draw_editor_gizmos(gizmos: HammeriteGizmoBuffer) -> voidDraw what the author should see of this entity - its bounds, where it points, how far it reaches - into gizmos. The editor calls it every frame it is up and the entity is visible; the default draws nothing.
_draws_editor_gizmos_only_when_picked()
func _draws_editor_gizmos_only_when_picked() -> boolAs HammeritePointEntityNode3D.draws_editor_gizmos_only_when_picked().
_get_aabb()
func _get_aabb() -> AABBThe box round its brushwork, in map space: its brush meshes', where they are drawn - so it follows a drag preview. Empty for an entity that builds no meshes (should_create_meshes()); override for one that knows its extent some other way.
_get_actions()
func _get_actions() -> Dictionary[StringName, String]The actions this entity offers in the editor's runtime panel, as id -> label. An action is a thing done TO a running entity, not a value set on it: it belongs beside the runtime properties because that is what it acts on, and it is not undoable because there is nothing authored to put back. Every entity that says it can be triggered gets Trigger for nothing. Override _get_actions() to add more: what it answers is merged over these.
_get_editor_handles()
func _get_editor_handles() -> HammeriteEditorHandle[]The points of this entity an author may take hold of in the viewport, or nothing where it offers none. Drawn and picked by the editor while the entity is selected; see HammeriteEditorHandle.
_get_runtime_properties()
func _get_runtime_properties() -> Dictionary[StringName, Variant]What the inspector shows of the RUNNING thing, beside its authored properties - which are entity's, read with HammeriteEntity.get_property().
_get_runtime_property()
func _get_runtime_property(key: StringName, default_value) -> VariantAs HammeriteBrushEntityNode3D.get_runtime_property().
_move_editor_handle()
func _move_editor_handle(handle_id: StringName, to: Vector3) -> voidOne of get_editor_handles() has been dragged to to, snapped to the grid. Read the position as whatever the value it stands for actually is.
_reset_runtime_properties()
func _reset_runtime_properties() -> voidAs HammeriteBrushEntityNode3D.reset_runtime_properties().
_reset_simulation()
func _reset_simulation() -> voidPut the running thing back the way the map built it.
_run_action()
func _run_action(action_id: StringName) -> voidDo one of get_actions(). Override alongside it.
_set_editor_active()
func _set_editor_active(active: bool) -> voidAs HammeriteBrushEntityNode3D.set_editor_active(), and shows the brushes only while active. Override _set_editor_active() for a volume that is seen in the game too or that has more of its own to show - it replaces this, so show the meshes yourself where they should be (_mesh_instances).
_set_entity()
func _set_entity(entity: HammeriteBrushEntity) -> voidAs HammeriteBrushEntityNode3D.set_entity(), except that each brush's collision shape is its convex hull rather than a trimesh, so a body wholly inside the brushwork still counts as inside.
_set_runtime_property()
func _set_runtime_property(key: StringName, value) -> voidAs HammeriteBrushEntityNode3D.set_runtime_property().
_should_create_colliders()
func _should_create_colliders() -> boolWhether set_entity() builds a collision shape for each brush.
_should_create_meshes()
func _should_create_meshes() -> boolWhether set_entity() builds a mesh for each brush. Override to build none - a volume that is never drawn.
_start_simulation()
func _start_simulation() -> voidAs HammeriteBrushEntityNode3D.start_simulation().
_stop_simulation()
func _stop_simulation() -> voidAs HammeriteBrushEntityNode3D.stop_simulation().
_trigger()
func _trigger(impulse) -> voidDo whatever this entity does when triggered. impulse is whatever the one triggering it handed over - null from the editor's Trigger, a HammeriteTrigger's target_impulse - and what it means is the entity's to say: a light might read a bool as on or off and toggle on null, a lift a floor number.
_update_properties()
func _update_properties() -> voidEvery property the entity's type declares, as the entity holds it or as the type defaults it: a map saved before a property existed has no key for it, and its entities read the type's default.
apply_entity_property()
func apply_entity_property(prop_name: StringName, value) -> voidAs HammeriteBrushEntityNode3D.apply_entity_property().
can_simulate()
func can_simulate() -> boolWhether the editor offers to run this entity, and whether HammeriteMap3D.start_simulation() starts it. The default does nothing when run, so offers nothing.
can_trigger()
func can_trigger() -> boolWhether something - the editor's Trigger, a HammeriteTrigger, the game - may trigger() it.
draw_editor_gizmos()
func draw_editor_gizmos(gizmos: HammeriteGizmoBuffer) -> voidDraw what the author should see of this entity - its bounds, where it points, how far it reaches - into gizmos. The editor calls it every frame it is up and the entity is visible; the default draws nothing.
draws_editor_gizmos_only_when_picked()
func draws_editor_gizmos_only_when_picked() -> boolAs HammeritePointEntityNode3D.draws_editor_gizmos_only_when_picked().
get_aabb()
func get_aabb() -> AABBThe box round its brushwork, in map space: its brush meshes', where they are drawn - so it follows a drag preview. Empty for an entity that builds no meshes (should_create_meshes()); override for one that knows its extent some other way.
get_actions()
func get_actions() -> Dictionary[StringName, String]The actions this entity offers in the editor's runtime panel, as id -> label. An action is a thing done TO a running entity, not a value set on it: it belongs beside the runtime properties because that is what it acts on, and it is not undoable because there is nothing authored to put back. Every entity that says it can be triggered gets Trigger for nothing. Override _get_actions() to add more: what it answers is merged over these.
get_brush_meshes()
func get_brush_meshes() -> Dictionary[int, MeshInstance3D]The mesh drawn for each of the entity's brushes, by brush id: a copy of the node's own record.
get_brush_shapes()
func get_brush_shapes() -> Dictionary[int, CollisionShape3D]The collision shape built for each of the entity's brushes, by brush id: a copy of the node's own record.
get_editor_handles()
func get_editor_handles() -> HammeriteEditorHandle[]The points of this entity an author may take hold of in the viewport, or nothing where it offers none. Drawn and picked by the editor while the entity is selected; see HammeriteEditorHandle.
get_lighting()
func get_lighting() -> HammeriteBrushEntityLightingWhat hands this brushwork over from its lightmap to the light probes when it moves, and back: made the first time it is asked for, and driving itself from then on.
get_runtime_properties()
func get_runtime_properties() -> Dictionary[StringName, Variant]What the inspector shows of the RUNNING thing, beside its authored properties - which are entity's, read with HammeriteEntity.get_property().
get_runtime_property()
func get_runtime_property(key: StringName, default_value = null) -> VariantAs HammeriteBrushEntityNode3D.get_runtime_property().
hand_back_to_lightmap()
func hand_back_to_lightmap() -> voidLight it from its lightmap again, for brushwork that returns flush to where it was baked.
hand_over_to_probes()
func hand_over_to_probes() -> voidLight this brushwork from the probes from now on: call it as the movement starts, so the blend (HammeriteBrushEntityLighting.blend_seconds()) happens under the motion.
move_editor_handle()
func move_editor_handle(handle_id: StringName, to: Vector3) -> voidOne of get_editor_handles() has been dragged to to, snapped to the grid. Read the position as whatever the value it stands for actually is.
request_rebuild()
func request_rebuild() -> voidAs HammeriteBrushEntityNode3D.request_rebuild().
reset_runtime_properties()
func reset_runtime_properties() -> voidAs HammeriteBrushEntityNode3D.reset_runtime_properties().
reset_simulation()
func reset_simulation() -> voidPut the running thing back the way the map built it.
run_action()
func run_action(action_id: StringName) -> voidDo one of get_actions(). Override alongside it.
set_editor_active()
func set_editor_active(active: bool) -> voidAs HammeriteBrushEntityNode3D.set_editor_active(), and shows the brushes only while active. Override _set_editor_active() for a volume that is seen in the game too or that has more of its own to show - it replaces this, so show the meshes yourself where they should be (_mesh_instances).
set_runtime_property()
func set_runtime_property(key: StringName, value) -> voidAs HammeriteBrushEntityNode3D.set_runtime_property().
should_create_colliders()
func should_create_colliders() -> boolWhether set_entity() builds a collision shape for each brush.
should_create_meshes()
func should_create_meshes() -> boolWhether set_entity() builds a mesh for each brush. Override to build none - a volume that is never drawn.
start_simulation()
func start_simulation() -> voidAs HammeriteBrushEntityNode3D.start_simulation().
stop_simulation()
func stop_simulation() -> voidAs HammeriteBrushEntityNode3D.stop_simulation().
trigger()
func trigger(impulse = null) -> voidDo whatever this entity does when triggered. impulse is whatever the one triggering it handed over - null from the editor's Trigger, a HammeriteTrigger's target_impulse - and what it means is the entity's to say: a light might read a bool as on or off and toggle on null, a lift a floor number.
update_properties()
func update_properties() -> voidEvery property the entity's type declares, as the entity holds it or as the type defaults it: a map saved before a property existed has no key for it, and its entities read the type's default.