Mounting¶
Mounting lets you stick an entity to another. The child follows the parent at a given CFrame offset each frame.
The basics¶
To mount an entity, tell it who the parent is and the relative offset.
This putsfollower 5 studs to the right of carrier. Every frame, Chrono computes follower's position as carrier.cframe * offset.
To detach:
Dynamic offsets¶
Call SetMount with a new offset to animate an attachment. You don't need to clear it first.
RunService.Heartbeat:Connect(function(dt)
t += dt
local offset = CFrame.new(math.cos(t) * 5, 0, math.sin(t) * 5)
Entity.SetMount(follower, carrier, offset)
end)
Chaining¶
Mounts nest - mount an arm to a body, a hand to the arm, a weapon to the hand, etc.
Chrono resolves the chain and caches the result each frame.Player entities as parents¶
A player entity can be the parent. Chrono reads the player's position without changing their CFrame.
local plrEntity = Holder.GetEntityFromPlayer(player)
Entity.SetMount(attachedThing, plrEntity, CFrame.new(0, 3, 0))
Listening for mount changes¶
Events.EntityMountChanged fires whenever an entity's mount parent changes (including when cleared).
Events.EntityMountChanged:Connect(function(entity, mountParentId)
if mountParentId then
print(entity.id, "mounted to", mountParentId)
else
print(entity.id, "unmounted")
end
end)
Things to note¶
- Server-only.
SetMountandClearMountmust be called from the server. Mount state is replicated to clients automatically. Entity.SetMount(child, nil)does the same asEntity.ClearMount(child).- Parents must be registered entities before mounting.
- Mounting continuously zeros the child's linear and angular velocity to keep it locked to the parent.
- Mounting does not affect collision - a child can phase through geometry if the parent moves into a wall.
Entity.GetMountRoot(child)returns the top of the chain and the child's offset from it.