Marker

Something drawn in the world for chosen players, a decal, cylinder, sphere, chevron, cube or plane, which can also report players walking in and out. The server stores each marker and tells each player's game when to show, change or remove it.

marker.place()

Marker.place(material, position, options, dimension)

Places a marker and returns it.

marker.list()

Marker.list(prefix)

The game's decal materials.

marker.all()

Marker.all(dimension)

All markers, or those in one dimension.

marker.getById()

Marker.getById(id)

The marker with this network id, or null.

marker.removeAll()

Marker.removeAll(dimension)

Removes all markers, or those in one dimension, and returns how many.

marker.exists

exists

False once removed.

marker.material

material

The decal material it was placed with.

marker.group

group

The family its material belongs to.

marker.shape

shape

'decal', 'cylinder', 'sphere', 'chevron', 'cube' or 'plane'.

marker.size

size

Its width in metres, 0.25 to 64. You can assign to it.

marker.height

height

Its height in metres, 0.25 to 64. You can assign to it.

marker.spin

spin

Its turning speed in degrees per second, -720 to 720. You can assign to it.

marker.bob

bob

How far it moves up and down, 0 to 4. You can assign to it.

marker.color

color

Its colour as 0xRRGGBBAA. You can assign to it.

marker.trigger

trigger

Whether it fires markerEnter and markerExit. The volume is an upright cylinder as wide as the marker, from 1 m below it to its height, or to 2 m for a decal or plane. You can assign to it.

marker.position

position

Its location. Assigning moves it.

marker.rotation

rotation

Its rotation. You can assign to it.

marker.dimension

dimension

Its dimension. Change it with setDimension.

marker.setDimension()

setDimension(world)

Moves the marker to another dimension.

marker.showOnlyTo()

showOnlyTo(target)

Limits who sees it, to a player or list of players. null shows it to everyone again.

marker.remove()

remove()

Removes the marker, firing markerRemove first.

marker.destroy()

destroy()

Removes the marker, firing markerRemove. Players inside get no markerExit.

marker.id

id: number

The network id.