Skip to main content

Feature scripting cheatsheet

All features properties and methods in one page

Table of content​

Audio​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String.; Links must be https:// and must finish with an audio extension such as .mp3

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://www.myurl.com/file.mp3"})
default​

""

sprite​

Boolean.

get()​
feature.get('sprite')
// returns: false
set()​
feature.set({'sprite': true})
default​

false

streaming​

Boolean.

get()​
feature.get('streaming')
// returns: false
set()​
feature.set({'streaming': true})
default​

false

autoplay​

Boolean.

get()​
feature.get('autoplay')
// returns: false
set()​
feature.set({'autoplay': true})
default​

false

loop​

Boolean.

get()​
feature.get('loop')
// returns: false
set()​
feature.set({'loop': true})
default​

false

rolloffFactor​

double; Value ranging from 0 to 5

get()​
feature.get('rolloffFactor')
// returns: 1.6
set()​
feature.set({'rolloffFactor': 1.6})
default​

1.6

volume​

double; Value ranging from 0 to 1

get()​
feature.get('volume')
// returns: 0.5
set()​
feature.set({'volume': 0.5})
default​

0.5

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'audio'

Scripting Methods​

Scripting Methods {.tabset}​

play()​

feature.play()

plays the audio

pause()​

feature.pause()

pauses the audio

Button​

Scripting Properties​

Scripting Properties {.tabset}​

color​

String.; Options are 'white', 'red', 'green', and 'blue'.

get()​
feature.get('color')
// returns: "red"
set()​
feature.set({'color':"blue"})
default​

"red"

soundId​

Integer; can be an integer in the range of 0 - 14.

'-1' - None '0' - ding dong '1' - pong '2' - pshlick - sounds like a hydraulic trigger '3' - breet - sounds like a PC attempting to connect to internet '4' - claclack - sounds like a someone spamming a keyboard '5' - tpow Cling - sounds like a ball hitting a racket and then a metal pole '6' - traarz - sounds like a printer '7' - wuwuwuwu - sounds like a UFO '8' - flickfli - sounds like someone going through a paper tray '9' - pshing dong - sounds like a cymbal and a ding dong '10' - bzing - sounds like a quick zing (honestly) '11' - tadaw - sounds like a clown noise '12' - shplow - sounds like a PVC pipe being hit '13' - tshlshlsh - sounds like a notes counter '14' - miaaaaaa - sounds like a cat being harassed '15' - miaoowww - sounds like a hungry cat

get()​
feature.get('soundId')
// returns: "0"
set()​
feature.set({'soundId':"-1"})
//Remember the soundId has to be a String
default​

"0"

type​

String;

get()​
feature.get('type')
/* or */
feature.type
// returns: "button"

How to use​

Using the scripting field, you can listen to clicks with

feature.on('click',e=>{
Your action when click here
})

You can also know who clicked the button by doing:

feature.on('click',e=>{
console.log(e.player)
})

Image​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String; Links must be https:// and must finish with an extension such as .jpg/.gif/.png.

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://www.myurl.com/file.png"})
default​

""

String; Links must be https://.

get()​
feature.get('link')
// returns: "https://..."
set()​
feature.set({'link':"https://www.myurl.com/"})
default​

""

blendMode​

String

get()​
feature.get('blendMode')
// returns: 'Combine'
set()​
feature.set({'blendMode': 'Combine'})
default​

"Multiply"

updateDaily​

Boolean.

get()​
feature.get('updateDaily')
// returns: false
set()​
feature.set({'updateDaily': true})
default​

false

transparent​

Boolean.

get()​
feature.get('transparent')
// returns: false
set()​
feature.set({'transparent': true})
default​

false

stretched​

Boolean.

get()​
feature.get('stretched')
// returns: false
set()​
feature.set({'stretched': true})
default​

false

uScale​

Integer

get()​
feature.get('uScale')
// returns: 1
set()​
feature.set({'uScale': 1})
default​

1

vScale​

Integer

get()​
feature.get('vScale')
// returns: 1
set()​
feature.set({'vScale': 1})
default​

1

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'image'

Megavox​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String; Links must be https:// and must finish with a vox extension .vox Has to link to a 126x126x126 vox model.

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://www.myurl.com/file.vox"})
default​

""

String; Links must be https://.

get()​
feature.get('link')
// returns: "https://..."
set()​
feature.set({'link':"https://www.myurl.com/"})
default​

""

collidable​

Boolean

get()​
feature.get('collidable')
// returns: false
set()​
feature.set({'collidable': true})
default​

false

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'megavox'

Particles​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String; Links must be https:// and must finish with an extension such as .jpg/.gif/.png.

info

If you set an URL, the custom colors color1 and color2 will be ignored.

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://www.myurl.com/file.png"})
default​

""

emitRate​

Double; Must be a number between 0 and 100.

get()​
feature.get('emitRate')
// returns: 50.0
set()​
feature.set({'emitRate':52})
default​

50

minSize​

Double; Must be a number between 0 and 1.

get()​
feature.get('minSize')
// returns: 0.5
set()​
feature.set({'minSize':0.5})
default​

0.5

maxSize​

Double; Must be a number between 0 and 1.

get()​
feature.get('maxSize')
// returns: 0.5
set()​
feature.set({'maxSize':0.5})
default​

0.5

color1​

String- hexadecimal;

get()​
feature.get('color1')
// returns: "#4cb844"
set()​
feature.set({'color1':"#4cb844"})
default​

#000000

color2​

String- hexadecimal;

get()​
feature.get('color2')
// returns: "#4cb888"
set()​
feature.set({'color2':"#4cb844"})
default​

"#000000"

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'particles'

PolyText​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String;

get()​
feature.get('text')
// returns: "My new text"
set()​
feature.set({'text':"My new text"})
default​

""

edges​

Boolean

get()​
feature.get('edges')
// returns: false
set()​
feature.set({'edges': true})
default​

false

type​

String;

get()​
feature.get('type')
/* or */
feature.type
// returns: "polytext"

Text input​

Scripting Properties​

Scripting Properties {.tabset}​

text​

String;

get()​
feature.get('text')
// returns: "my text"
set()​
feature.set({'text':"my text"})
default​

""

placeholder​

String;

get()​
feature.get('placeholder')
// returns: "my text"
set()​
feature.set({'placeholder':"my text"})
default​

"placeholder"

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'text-input'

YouTube / Twitch​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String; Links must be https:// and must either be a youtube, twitch, soundcloud, spotify.

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://www.youtube.com/?v=..."})
default​

""

previewUrl​

String; Links must be https:// and must either be a .png,.gif,jpg.

get()​
feature.get('previewUrl')
// returns: "https://..."
set()​
feature.set({'previewUrl':"https://..."})
default​

""

screenRatio​

String; Links must be https:// and must either be a .png,.gif,jpg.

get()​
feature.get('screenRatio')
// returns: "43"
set()​
feature.set({'screenRatio':"169"})
default​

"169"

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'youtube'

Scripting methods​

Scripting methods {.tabset}​

play()​

feature.play()

plays the video

feature.pause()​

feature.pause()

pauses the video

Boombox​

Scripting Properties​

Scripting Properties {.tabset}​

rollOffFactor​

Double; Value ranging from 0 to 5

get()​
feature.get('rolloffFactor')
// returns: 1.6
set()​
feature.set({'rolloffFactor':1.6})
default​

1

Nft image​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String; Links must be https://.

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://www.opensea.io/"})
default​

""

stretch​

Boolean;

get()​
feature.get('stretch')
// returns: "https://..."
set()​
feature.set({'stretch':true})
default​

false

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'nft-image'

Richtext​

Scripting Properties​

Scripting Properties {.tabset}​

text​

String;

get()​
feature.get('text')
// returns: "https://..."
set()​
feature.set({'text':"my paragraph"})
default​

""

blendMode​

String

get()​
feature.get('blendMode')
// returns: 'Combine'
set()​
feature.set({'blendMode': 'Combine'})
default​

"Multiply"

inverted​

Boolean;

get()​
feature.get('inverted')
// returns: false
set()​
feature.set({'inverted': true})
default​

false

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'richtext'

Sign​

Scripting Properties​

Scripting Properties {.tabset}​

text​

String;

get()​
feature.get('text')
// returns: "my line of text"
set()​
feature.set({'text':"my line of text"})
default​

""

String;

get()​
feature.get('link')
// returns: "https://..."
set()​
feature.set({'link':"https://..."})
default​

""

fontSize​

Integer;

get()​
feature.get('fontSize')
// returns: 25
set()​
feature.set({'fontSize':25})
default​

25

color​

String-hexadecimal;

get()​
feature.get('color')
// returns: "#00000"
set()​
feature.set({'color':"#fcba03"})
default​

"#00000"

background​

String-hexadecimal;

get()​
feature.get('background')
// returns: "#00000"
set()​
feature.set({'background':"#fcba03"})
default​

"#fffff"

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'sign'

Video​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String; Has to start with https:// and has to end with a video extension such as .mp4.

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://..."})
default​

""

previewUrl​

String; Links must be https:// and must either be a .png,.gif,.jpg.

get()​
feature.get('previewUrl')
// returns: "https://..."
set()​
feature.set({'previewUrl':"https://..."})
default​

""

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'video'

Scripting methods​

Scripting methods {.tabset}​

play()​

feature.play()

plays the video

pause()​

feature.pause()

pauses the video

.VOX​

Scripting Properties​

Scripting Properties {.tabset}​

url​

String; Links must be https:// and must finish with a vox extension .vox Has to link to a 32x32x32 vox model or smaller.

get()​
feature.get('url')
// returns: "https://..."
set()​
feature.set({'url':"https://www.myurl.com/file.vox"})
default​

""

String; Links must be https://.

get()​
feature.get('link')
// returns: "https://..."
set()​
feature.set({'link':"https://www.myurl.com/"})
default​

""

collidable​

Boolean

get()​
feature.get('collidable')
// returns: false
set()​
feature.set({'collidable': true})
default​

false

type​

String;

get()​
feature.get('type')
/* or */
feature.type

// returns: 'vox-model'