Kinemium Docs

BillboardGui

Renders GUI Children in a 3D Environment.

Properties

PropertyTypeDefault
Namestring"BillboardGui"
Enabledbooleantrue
Cameraanynil
SizeUDim2UDim2.new(0, 200, 0, 100)
RenderOffsetVector2Vector2.new(0, 0)
Adorneeanynil
StudsOffsetVector3Vector3.new(0, 0, 0)
StudsOffsetWorldSpaceVector3Vector3.new(0, 0, 0)
PixelsPerStudnumber50
MaxDistancenumber0
AlwaysOnTopbooleantrue

Functions


getReferenceSize

Arguments

This function takes no arguments.

Returns

This function returns nothing.

getSizePixels

Arguments

instance

Returns

This function returns nothing.

getAdornee

Arguments

instance

Returns

This function returns nothing.

getWorldPosition

Arguments

adornee, offsetLocal, offsetWorld

Returns

This function returns nothing.

resetRenderTexture

Arguments

width, height

Returns

This function returns nothing.

API

instance:getReferenceSize()
instance:getSizePixels(instance)
instance:getAdornee(instance)
instance:getWorldPosition(adornee, offsetLocal, offsetWorld)
instance:resetRenderTexture(width, height)

On this page