Variables - SmallSquareStudios/Psych-Engine-Wiki-Extra GitHub Wiki
Debug Varaibles
luaDebugMode
- Enables debug mode, use luaDebugMode = true
to enable it. It is disabled by default.
luaDeprecatedWarnings
- Tells you if a function/variable is deprecated (shouldn't be used anymore), only works when Debug mode is on, use luaDeprecatedWarnings = false
to disable it. This is enabled by default.
inChartEditor
- Tells you if your script is running on Chart Editor's chart playtest.
Song/Week Variables
curBpm
- Current BPM of the Song, shortcut to getPropertyFromClass('Conductor', 'bpm').
bpm
- Starting BPM of the Song, shortcut to getProperty('SONG.bpm').
scrollSpeed
- Starting Scroll speed of the Song, shortcut to getProperty('SONG.speed').
crochet
- Interval between Beat hits.
stepCrochet
- Interval between Step hits.
songLength
- Song duration in milliseconds.
songName
- Returns the song's name as a string. Shortcut to getProperty('SONG.song').
isStoryMode
- Tells you if the song is being played in story mode. Shortcut to getProperty('isStoryMode').
difficulty
- Returns the difficulty ID (Easy = 0, Normal = 1, Hard = 2), Shortcut to getProperty('storyDifficulty').
weekRaw
- Returns the raw current week number.
week
- Returns the properly formatted current week file name.
Object Variables
color
- Returns the hex code color of the object as a string. Default is FFFFFF
.
scale
- Returns the size of the object as a float. Default is 1. Use scale.x
and scale.y
.
angle
- Returns the angle of the object in degrees as a float. Default is 0.
x
- Returns the x position of the object as a float.
y
- Returns the y position of the object as a float.
alpha
- Returns the alpha of the object as a float.
visible
- Returns the visibility of the sprite as a bool. Default is true.
Camera Variables
zoom
- Returns the zoom of the camera as a float. Default is 1.