Nodes
Action
An action is something people can interact with in the world.
Anchor
An anchor can be used to attach players to them, eg for seating or vehicles.
App
Global app variable in Hyperfy v2.
[Attachment]/ref/attachment
docs pending
Audio
Represents a single audio clip that can be played in the world.
Avatar
Renders a VRM avatar
Collider
A collider connects to its parent rigidbody to simulate under physics.
Group
A regular old node with no other behavior. Useful for grouping things together underone parent.
LOD
A LOD can hold multiple child nodes and automatically activate/deactivate them based on their distance from the camera.
Material
A material on a Mesh node.
Mesh
Represents a mesh to be rendered.
Node
The base class for all other nodes.
Num
Global num method, to generate random numbers replace Math.random()
Props
Apps can expose a list of custom UI fields allowing non-technical people to configure or change the way your apps work.
Player
Represents a player. An instance of Player can be retrived from events or via World.getPlayer
RigidBody
A rigidbody that has colliders as children will act under physics.
UI
Displays a UI plane in-world
UIText
Represents text inside a UI.
UIView
Represents a single view inside a UI, similar to a div.
[UIImage]/ref/ui-image
Adding images to UI node.
docs pending
World
The global world variable is always available within the app scripting runtime.