Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commit61a33237e0

README.md

lamp_post (bundle)

A lamp post: a slim post, a lit head sitting on top of it, and the point light it casts. Four entities under one root — post, head and glow — built from builtin meshes and materials, so the bundle carries no geometry of its own.

Its foot sits at y = 0 and it stands 2.53 units tall, so placing it at a position on the ground puts it on the ground.

asset.resolve("@builtin::bundles.lamp_post", "bundle"):instantiate(nil, {
    position = { 4, 0, 2 },
    rotation = { 0, 30, 0 },
    scale = 1.2,
})

What it is for

It is the prop a starting scene places to show what placing an asset does: one call brings a whole hierarchy in as the scene's own entities, and the Light riding along shows that a bundle carries behaviour and not only shape.

Reach for it whenever a scene needs a light source that reads as an object rather than as a floating value.