Lua API
On this page

DecalD3DObj

Inherits from

An DecalD3DObj instance.

Fields:

Autoscale boolean

Set to true to autoscale the object. TODO: what exactly does this mean?

Color number

The primary color

Color2 number

The secondary color?

HBounce number

Horizontal bounce

PBounce number

Vertical bounce

ScaleX number

X scale modifier

ScaleY number

Y scale modifier

ScaleZ number

Z scale modifier

Visible boolean

Wether or not this d3d object is visible

Methods:

Anchor(lat: number, lng: number, z: number) : nil

Anchor this object to the specified coordinates.

Parameters:
NameTypeDefaultSummary
latnumber

The worldspace latitude to point at

lngnumber

The worldspace longitude to point at

znumber

The worldspace z (altitude) to point at

Returns:nil

Anchor(objectId: number, height: number, xOffset: number, yOffset: number, zOffset: number) : nil

Anchor this object to the specified object.

Parameters:
NameTypeDefaultSummary
objectIdnumber

The id of the object to anchor this to

heightnumber

The height to anchor at

xOffsetnumber

X offset

yOffsetnumber

Y offset

zOffsetnumber

Z offset

Returns:nil

Dispose() : nil

Destroy this d3d obj

Returns:nil

GetPropertyKeys() : string[]

Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts

Returns:string[]

OrientToCamera(verticalTilt: boolean) : nil

Orient this object to the camera

Parameters:
NameTypeDefaultSummary
verticalTiltboolean

Wether to also tilt vertically

Returns:nil

OrientToCoords(lat,lng,z,verticalTilt) lat number , lng number , z number , verticalTilt boolean

OrientToObject(objectId,fractHeight,verticalTilt) objectId number , fractHeight number , verticalTilt boolean

OrientToPlayer(verticalTilt) verticalTilt boolean

Scale(factor) factor number

SetIcon(icon) icon number

SetShape(shape) shape DecalD3DShape

SetText(text,fontName,color) text string , fontName string , color number

SetText(text,fontName) text string , fontName string

SetText(text) text string

SetText(type,text,fontName,color) type DecalD3DTextType , text string , fontName string , color number

ToString()