Skip to content

Search

Dokumentace

Components

Every component a node can carry: what it gives the node, the properties a scene sets, and the functions a script calls on it.

animation Plays animation clips on the node. library is the clip asset, autoplay the clip started on load, speed_scale the rate; the animation module drives…
articulation2d Solves the node's joint2d in reduced coordinates: the chain never drifts and can be solved for inverse kinematics, but cannot close a loop or break.
articulation3d Solves the node's joint3d in reduced coordinates: the chain never drifts and can be solved for inverse kinematics, but cannot close a loop or break.
bindings Reactions the node runs from a table: each row is an event, a when over the scene's [variables], an action, a target node and a value.
body2d A 2D rigid body simulated by rapier in the xy plane. kind is dynamic, static, kinematic or kinematic_velocity; add a collider2d for its shape.
body3d A 3D rigid body simulated by rapier. kind is dynamic, static, kinematic or kinematic_velocity; add a collider3d for its shape.
bone2d Makes the node a 2D bone. rest_position and rest_rotation are the pose a rig returns to; length and angle draw its gizmo.
bone3d Makes the node a 3D bone. rest_position, rest_rotation and rest_scale are the pose a rig returns to; length draws its gizmo.
boolean2d Draws the node as its 2D children combined by operation, holes and all. The children stay in the tree, hidden and editable; fill_rule and the cleanup…
boolean3d Draws the node as its children combined by operation: union, difference or intersection. The children stay in the tree, hidden and editable; color…
breakable_joint2d What snaps the node's joint2d: past either, it breaks and calls on_joint_break. An articulation never breaks, so this sits beside a joint that is not one.
breakable_joint3d What snaps the node's joint3d: past either, it breaks and calls on_joint_break. An articulation never breaks, so this sits beside a joint that is not one.
camera2d The orthographic camera a flat scene is drawn from. pixels_per_unit scales it, and the last current camera wins; the scene's environment lights it. Only…
camera3d The camera the scene is drawn from. Its node places and aims it, looking along the node's -z as a light3d shines; the lens rows say how it projects and…
character2d A 2D character controller: node.character2d.move_by slides the node along walls and steps it up ledges. Needs a collider2d; a kinematic body2d lets it…
character3d A 3D character controller: node.character3d.move_by slides the node along walls and steps it up ledges. Needs a collider3d; a kinematic body3d lets it…
collider2d The node's 2D collision shape, chosen by kind. It belongs to the node's body2d or the nearest body above it; without one it is static geometry.
collider3d The node's 3D collision shape, chosen by kind. It belongs to the node's body3d or the nearest body above it; without one it is static geometry.
convex_decomposition2d How the node's collider2d cuts its mesh into convex pieces, for a convex_decomposition.
convex_decomposition3d How the node's collider3d cuts its mesh into convex pieces, for a convex_decomposition or a fit to one.
debug_draw A wireframe over every triangle edge of the node's drawing, a point on every vertex, and whether its surface draws at all, for any drawable in either…
environment The scene's atmosphere: sky, ambient_color, fog_mode, exposure, tonemap, colour grading and how shadows fall. The last current one wins; per-view effects…
follow2d Pulls the node's body2d towards the pose of target every fixed step, with rapier's PD or PID controller. node.follow2d.reset() forgets what a PID summed.
follow3d Pulls the node's body3d towards the pose of target every fixed step, with rapier's PD or PID controller. node.follow3d.reset() forgets what a PID summed.
generic_joint2d Which axes a joint2d of kind generic locks, and which free ones it ties into one.
generic_joint3d Which axes a joint3d of kind generic locks, and which free ones it ties into one.
joint2d Joins this node's body to connected_body. kind is fixed, hinge, slider, rope, spring, groove or generic; both ends need a body2d on or above the node.…
joint3d Joins this node's body to connected_body. kind is fixed, hinge, slider, ball_socket, rope, spring or generic; both ends need a body3d on or above the…
light2d A 2D light at the node's position. kind is point, directional or spot; the first light2d in a scene drops everything else to the environment's…
light3d A 3D light placed and aimed by the node. kind is directional, point or spot; the first light3d in a scene retires the engine's default key light.
line2d A stroked line at the node through the points of a mesh or path2d asset, tinted by color and drawn with texture.
listener The point positional sounds are heard from: distance sets volume, offset across its right sets pan, and the closing speed against speed_of_sound bends…
material source is the material asset this node and everything under it draw with. A renderable's own material property overrides it for that node alone.
mesh 3D geometry from the mesh asset in source, drawn at the node. With a skin, the rig skeleton names deforms it.
mesh_collider2d How the node's collider2d turns its mesh into a shape: the shape a fit takes, the edges a polyline keeps, how a convex_polygon and a voxelized outline…
mesh_collider3d How the node's collider3d turns its mesh into a shape: how a voxelized mesh or a decomposition's grid is filled, and what a triangle_mesh tidies first.
meta Named values filed on the node, like Godot's set_meta. It has no fixed properties; every key is the author's.
modifier2d Poses 2D bones toward target after the clip runs. kind is look_at, two_bone_ik, fabrik, ccdik or jiggle.
modifier3d Poses bone3d nodes toward target after the clip runs. kind is look_at, two_bone_ik, fabrik, ccdik or jiggle.
multimesh2d Godot's MultiMeshInstance2D: the multimesh asset in source, its mesh drawn flat once per instance in one call, each instance tinted over color. The node…
multimesh3d Godot's MultiMeshInstance3D: the multimesh asset in source, its mesh drawn once per instance in one call, each instance's color tinted over the node's.…
occluder2d The outline the node blocks 2D light with. With no mesh it follows the node's collider2d, or else its circle, capsule, rect or sprite shape.
particles2d A visual-only 2D emitter at the node: rate, lifetime, speed, direction, spread_degrees and gravity. The live particles are renderer state the simulation…
particles3d A visual-only 3D emitter at the node, drawn as instances of one quad: rate, lifetime, speed, direction, spread_degrees and gravity in world space. The…
polygon A filled, textured 2D polygon from the mesh asset's points and triangles. With skin weights, the rig skeleton names deforms it.
ragdoll Drives a rig's bones from bodies, one body per bone and named after it, which the editor's Create Physical Skeleton builds. influence is how much of the…
reflection_probe A box the room around it was captured inside. A reflective surface within it mirrors that capture, aimed at the box, instead of the distant sky.
rope_joint2d How long a joint2d of kind rope may stretch. The rope_joint2d component of the Balaur game engine: its 1 property, and the functions a script calls on it.
rope_joint3d How long a joint3d of kind rope may stretch. The rope_joint3d component of the Balaur game engine: its 1 property, and the functions a script calls on it.
screen_notifier2d A box that announces screen_entered as it comes on screen and screen_exited as it leaves; offset and size place it around the node. A hidden node is off…
shape2d A 2D primitive at the node, tinted by color and drawn with texture: shape is a circle, rectangle, capsule, ellipse, star or ngon, and the dimensions that…
shape3d A 3D primitive at the node, tinted by color and drawn with texture: shape is a sphere, box, capsule, cylinder, cone, plane, torus, pyramid, prism or…
soft_circle2d The size of a softbody2d laid out as a circle: a disk of particles inside a rim.
soft_cloth_tube3d The shape of a softbody3d laid out as a cloth_tube: a sleeve of cloth wrapped around a segment.
soft_collision2d A mesh the node's softbody2d meets the world through beside its own surface, deformed with the body: its triangles in 3D, the outline of its triangles in…
soft_collision3d A mesh the node's softbody3d meets the world through beside its own surface, deformed with the body: its triangles in 3D, the outline of its triangles in…
soft_custom2d The particles and elements of a custom softbody2d, as the author lists them.
soft_custom3d The particles and elements of a custom softbody3d, as the author lists them.
soft_grid2d The size and the cells of a softbody2d laid out as a grid: a sheet of particles.
soft_grid3d The size and the cells of a softbody3d laid out as a box or a cloth: a block of particles, or a sheet of them.
soft_outline2d The corners of a softbody2d laid out as an outline: a ring of particles around an inside.
soft_polyline2d Which segments of its mesh a softbody2d laid out as a polyline joins. The soft_polyline2d component of the Balaur game engine: its 1 property, and the…
soft_rope2d Where a softbody2d laid out as a rope runs, and how many particles it is made of.
soft_rope3d Where a softbody3d laid out as a rope runs, and how many particles it is made of.
soft_skin2d The mesh a softbody2d with cells carries as its skin: a grid, a volumetric body or a custom one with cells, whose particles are not the mesh's own.
soft_skin3d The mesh a softbody3d with cells carries as its skin: a box, a volumetric body or a custom one with cells, whose particles are not the mesh's own.
soft_sphere3d The size of a softbody3d laid out as a sphere: a refined icosahedron of particles.
soft_volumetric2d How a volumetric softbody2d fills its mesh's outline with triangles. The soft_volumetric2d component of the Balaur game engine: its 2 properties, and the…
soft_volumetric3d How a volumetric softbody3d fills its mesh with tetrahedra. The soft_volumetric3d component of the Balaur game engine: its 5 properties, and the…
softbody2d A deformable 2D body: particles linked by elastic constraints, laid out by kind and made of what the material rows say. A polygon on the same node is…
softbody3d A deformable 3D body: particles linked by elastic constraints, laid out by kind and made of what the material rows say. The node is drawn from the…
sound A sound on the node: file, volume_linear, pitch_scale and loop, with its stems mixed in and its queue played after it. autoplay starts it on load…
spring_joint2d The length a joint2d of kind spring pulls back to. The spring_joint2d component of the Balaur game engine: its 1 property, and the functions a script…
spring_joint3d The length a joint3d of kind spring pulls back to. The spring_joint3d component of the Balaur game engine: its 1 property, and the functions a script…
sprite A textured 2D quad at the node, sized by pixels_per_unit. A sprite_sheet in sheet cuts it into frames frame picks.
state_machine Runs the state_machine asset in machine over the player node's clips. auto transitions fire when their conditions come on; state_machine.travel moves to…
states Named looks for the node. Every key beside current is a state holding per-component property tables; node.states.set_state(\"hover\") patches one over the…
text2d A block of text drawn in the 2D pass, pixels_per_unit font pixels per world unit.
text3d A block of text drawn in the 3D pass on a quad, pixels_per_unit font pixels per world unit; billboard turns it to the camera.
tile_collision Collision for the node's tilemap cells: every tile the tileset marks solid, one shape per behaviour, with the material keys a collider2d takes. mass…
tile_shapes How the node's tile_collision builds the tiles whose collision is polygons, the ones a tileset gives collision = [[[x, y], ...]]: what each polygon…
tilemap A grid of tiles from one tileset asset, centred on the node. cells holds rows of tile ids, or names the .cells file holding them; pixels_per_unit is tile…
timer Counts wait_time seconds down and emits timeout from the node, which bindings hear as emitted:timeout. running or autostart starts it; one_shot stops…
touch_button An on-screen button that presses an action while a finger is on it. anchor, x and y place it inside the screen's safe area, as they place a widget.
touch_stick An on-screen stick that drives action_x and action_y from -1..1 while a thumb drags it, y positive away from the player. anchor, x and y place it, as…
transform The node's position, rotation_euler, scale and skew in its parent's space. A node without one sits at its parent.
vehicle3d Makes the node's body3d a raycast vehicle chassis, driven by the wheel3d children under it. forward_axis and up_axis orient it.
wheel3d One wheel of the vehicle3d above it; the node's position on the chassis is where its ray starts. physics3d.set_engine_force, set_brake and set_steering…
widget A HUD element drawn every frame: kind picks label, button, panel and more, anchor places it in design pixels. A click on one is its node's pointer_click…
widget_box The rarer words about a box, which any kind may carry: what its size measures, what it keeps for what runs past it, and how it lays out on its own.
widget_button The rows a button or menu reads: what its face holds beside its caption, and what the pointer may do to it.
widget_check The rows a checkbox, switch or button reads: whether it is on, and what a click does to that.
widget_child What a child says to the parent it sits in, whatever its own kind: a grid's cell, a fold's header, a menu's row.
widget_code The rows a code widget reads: what it highlights and its gutter. The widget_code component of the Balaur game engine: its 6 properties, and the functions…
widget_color_picker The rows a color_picker reads: the colour it holds and what it offers.
widget_dropdown The rows a dropdown reads: what it offers, how tall its list grows and what shuts it.
widget_field The rows a text_field, text_area or code reads: what may be typed and how the editor behaves.
widget_fold The row a fold reads: whether it shows what is under its header. The widget_fold component of the Balaur game engine: its 1 property, and the functions a…
widget_grid The rows a grid reads: its tracks and its named areas. The widget_grid component of the Balaur game engine: its 6 properties, and the functions a script…
widget_image The rows an image reads: its picture, the part of it drawn and how it sits in its box.
widget_layout The rows a container reads: how it lays out what is in it. The widget_layout component of the Balaur game engine: its 9 properties, and the functions a…
widget_list The rows a list or tree reads: its card faces, and what a drag or a mark on a row does.
widget_menu The rows a menu reads: where its popup opens and what shuts it. The widget_menu component of the Balaur game engine: its 7 properties, and the functions…
widget_range The rows a slider, number_field or progress_bar reads: where it stands in its range, how it moves and how it is drawn.
widget_rows The rows a list, tree or table reads: what it holds and what is picked.
widget_scroll The rows a scroll, list, tree or table reads: its bars, where it is scrolled to and what scrolls it.
widget_separator The rows a separator reads: the room it takes and how far its line runs.
widget_shortcut The rows of a chord that clicks a widget, which any kind may carry. The widget_shortcut component of the Balaur game engine: its 3 properties, and the…
widget_table The rows a table reads: its columns and how they sort. The widget_table component of the Balaur game engine: its 8 properties, and the functions a script…
widget_tabs The row a tabs reads: which child it shows. The widget_tabs component of the Balaur game engine: its 1 property, and the functions a script calls on it.
widget_text The rows a kind drawing a caption reads: how its lines sit, break and are cut, and what the reader may do to them.
widget_window The rows a window or a dialog reads: whether it is up, its chrome, and what shuts it.

Opravdu?