Reflection Functions

Functions to get/set properties from (both Hardcoded and Lua) Objects and call their methods.

getProperty

getProperty(variable:String, ?allowMaps:Bool = false):Dynamic

Returns the value of a property or variable inside PlayState, a variable saved through "setVar" or a Lua Sprite/Text.

variable - Variable or Property.
allowMaps (Optional) - Allows for Map access in properties, disabled by default for optimization.

Examples:

getProperty('dad.scale.x') - Can return "1.0", for example.
getProperty('singAnimations[0]') - Normally returns "singLEFT".
getProperty('boyfriend.animOffsets.idle', true) - Can return a table of "{0, 0}", for example.

getPropertyFromGroup

getPropertyFromGroup(variable:String, index:Int, property:Dynamic, ?allowMaps:Bool = false):Dynamic

Returns the value of a property of a member inside a FlxTypedGroup/FlxSpriteGroup.

variable - Group variable.
index - Index of a member of the group you put in the previous argument.
property - Property of the selected member of the group.
allowMaps (Optional) - Allows for Map access in properties, disabled by default for optimization.

Examples:

getPropertyFromGroup('playerStrums', 1, 'animation.curAnim.name') - Will return the current animation name of the Player's Down Note.
getPropertyFromGroup('unspawnNotes', 0, 'extraData.testVar', true) - Lua equivalent of unspawnNotes[0].extraData.get('testVar').

getPropertyFromClass

getPropertyFromClass(classVar:String, variable:String, ?allowMaps:Bool = false):Dynamic

Returns the value of a property inside a class.

classVar - Class variable based on the source folder structure.
variable - Variable or Property.
allowMaps (Optional) - Allows for Map access in properties, disabled by default for optimization.

Examples:

getPropertyFromClass('backend.ClientPrefs', 'data.downScroll') - Will return the current Downscroll option value, either "true" or "false".
getPropertyFromClass('states.PlayState', 'SONG.player1') - Will return the Player character's name from the Chart, which is a string.

setProperty

setProperty(variable:String, value:Dynamic, ?allowMaps:Bool = false, ?allowInstances:Bool = false):Dynamic

Sets the value of a property or variable inside PlayState, a variable saved through "setVar" or a Lua Sprite/Text.
Returns "value".

variable - Variable or Property.
value - Value to set.
allowMaps (Optional) - Allows for Map access in properties, disabled by default for optimization.
allowInstances (Optional) - Allows usage of "instanceArg" for properties, disabled by default for optimization.

Examples:

setProperty('boyfriend.stunned', true) - Stuns player.
setProperty('singAnimations[3]', 'singLEFT') - Will force Right sing animation to be "singLEFT".
setProperty('boyfriend.animOffsets.idle', {-200, 100}, true) - Changes Player's Idle offsets to X -200, Y 100.

setPropertyFromGroup

setPropertyFromGroup(variable:String, index:Int, property:Dynamic, value:Dynamic, ?allowMaps:Bool = false, ?allowInstances:Bool = false):Dynamic

Sets the value of a property of a member inside a FlxTypedGroup/FlxSpriteGroup.
Returns "value".

variable - Group variable.
index - Index of a member of the group you put in the previous argument.
property - Property of the selected member of the group.
value - Value to set.
allowMaps (Optional) - Allows for Map access in properties, disabled by default for optimization.
allowInstances (Optional) - Allows usage of "instanceArg" for properties, disabled by default for optimization.

Examples:

setPropertyFromGroup('playerStrums', 2, 'visible', false) - Hides Player's Up note.
setPropertyFromGroup('unspawnNotes', 0, 'extraData.testVar', true, true) - Lua equivalent of unspawnNotes[0].extraData.set('testVar', true).

setPropertyFromClass

setPropertyFromClass(classVar:String, variable:String, value:Dynamic, ?allowMaps:Bool = false, ?allowInstances:Bool = false):Dynamic

Sets the value of a property inside a class.
Returns "value".

classVar - Class variable based on the source folder structure.
variable - Variable or Property.
value - Value to set.
allowMaps (Optional) - Allows for Map access in properties, disabled by default for optimization.
allowInstances (Optional) - Allows usage of "instanceArg" for properties, disabled by default for optimization.

Examples:

setPropertyFromClass('states.PlayState', 'SONG.player1', 'pico-playable') - Force set Player character to "pico-playable".

callMethod

callMethod(funcToRun:String, ?args:Array<Dynamic> = null):Dynamic

Calls a function and returns its value.

funcToRun - Name of the function you want to run.
args (Optional) - Optional table of arguments.

Examples:

callMethod('KillNotes') - Clear all notes.
callMethod('boyfriend.isAnimationNull') - Returns "true" or "false" about if the Player's Animation is null.
callMethod('iconP1.changeIcon', {'bf-old'}) - Change Player's icon to "bf-old".

callMethodFromClass

callMethodFromClass(classVar:String, funcToRun:String, ?args:Array<Dynamic> = null):Dynamic

Calls a function inside a Class and returns its value.

classVar - Class variable based on the source folder structure.
funcToRun - Name of the function you want to run.
args (Optional) - Optional table of arguments.

Examples:

callMethodFromClass('backend.CoolUtil', 'browserLoad', {'https://ko-fi.com/shadowmario'}) - Opens my Ko-Fi page in browser, give me money.

instanceArg

instanceArg(instanceName:String, ?classVar:String = null):String

Meant to be used with "callMethod", "callMethodFromClass", "createInstance", "setProperty", "setPropertyFromGroup", "setPropertyFromClass" and "setVar".
Formats a String in a specific way to tell the previously mentioned functions that the string is meant to be an instance.

instanceName - Self explanatory.
classVar (Optional) - Class variable based on the source folder structure.

Examples:

callMethod('spawnNoteSplashOnNote', {instanceArg('notes.members[0]')}) - Will spawn a Note splash in the first note on screen.
setVar('leftStrum', instanceArg('playerStrums.members[0]')) - Creates a shortcut to Player's Left Note.

createInstance

createInstance(variableToSave:String, classVar:String, ?args:Array<Dynamic> = null):Bool

Creates an instance of a Class and saves it to a lua variable nametag that allows you to use setProperty and other functions on it.
Returns "true" or "false" for if it was created successfully.

variableToSave - Variable name to save the created instance to.
classVar - Class variable based on the source folder structure.
args (Optional) - Optional table of arguments.

Examples:

createInstance('testIcon', 'objects.HealthIcon', {'gf'}) - Creates a GF Health Icon.

Note: In most cases you still have to add the created instance with "addInstance".

addInstance

addInstance(objectName:String, ?inFront:Bool = false):Void

Adds the instance to the scene.

objectName - Variable name of the instance.
inFront (Optional) - If true, the instance is added at the top of everything in its camera, if false, it will be added behind all characters.

Examples:

addInstance('testIcon', true) - Adds an instance with the tag "testIcon" at the top of everything.

Note: As of 1.0, this function is redundant as it does nearly the same thing as "addLuaSprite"

getObjectOrder

getObjectOrder(tag:String, ?group:String = null):Int

Returns the object layer in the Scene or inside a group.
Throws an error and returns -1 if the object or group couldn't be found.

tag - Variable name of the instance or Lua Object nametag.
group (Optional) - Variable name of the FlxTypedGroup/FlxSpriteGroup/Array.

Examples:

getObjectOrder('boyfriendGroup') - Returns the object layer of the Player's Character Group.
getObjectOrder('scoreTxt', 'uiGroup') - Returns the object layer of the Score Text in its group.

setObjectOrder

setObjectOrder(tag:String, position:Int, ?group:String = null):Void

Sets the object layer in the Scene or inside a group.

tag - Variable name of the instance or Lua Object nametag.
position - New position in the Scene/group.
group (Optional) - Variable name of the FlxTypedGroup/FlxSpriteGroup/Array.

Examples:

setObjectOrder('boyfriendGroup', getObjectOrder('gfGroup')) - Sets the Player's Character Group to be a layer behind Girlfriend.
setObjectOrder('iconP1', 0, 'uiGroup') - Makes Player Icon a layer behind everything else.

addToGroup

addToGroup(group:String, tag:String, ?index:Int = -1):Void

Adds an object to a group.

group - Variable name of the FlxTypedGroup/FlxSpriteGroup/Array.
tag - Variable name of the instance or Lua Object nametag.
index (Optional) - Position in the group, -1 is top, defaults to -1.

Examples:

addToGroup('uiGroup', 'mySprite') - Adds Lua Object "mySprite" to the top of UI Group.
addToGroup('uiGroup', 'mySprite', 0) - Adds Lua Object "mySprite" to the bottom of UI Group.

removeFromGroup

removeFromGroup(group:String, ?index:Int = -1, ?tag:String = null, ?destroy:Bool = true):Void

Removes an object from a group.

group - Variable name of the FlxTypedGroup/FlxSpriteGroup/Array.
index (Optional) - Position in the group, ignored if "tag" is not null, defaults to -1.
tag (Optional) - Variable name of the instance or Lua Object nametag.
destroy (Optional) - If enabled, clears the object from memory once removed, do not disable unless you know what you're doing.

Examples:

removeFromGroup('groupName', _, 'mySprite') - Removes Object named "mySprite" from the UI Group.
removeFromGroup('groupName', 0) - Removes the object at the bottom of the UI Group.

setObjectCamera

setObjectCamera(tag:String, ?camera:String = 'game'):Bool

Changes the Object's Draw Camera.
Returns whether the operation was successful.

tag - Variable name of the instance or Lua Object nametag.
camera (Optional) - Can be "game", "hud" or "other", defaults to "game".

Examples:

setObjectCamera('mySprite', 'hud') - Moves Object named "mySprite" to HUD Camera.

setScrollFactor

setScrollFactor(tag:String, scrollX:Float, scrollY:Float):Void

Changes the parallax of an Object.

tag - Variable name of the instance or Lua Object nametag.
scrollX - 1 = Normal parallax.
scrollY - 1 = Normal parallax.

Examples:

setScrollFactor('mySprite', 0, 0) - Object will look like it's immobile/never gets displaced.

screenCenter

screenCenter(tag:String, ?axis:String = 'xy'):Void

Centers an Object to the Screen on the specified axis.

tag - Variable name of the instance or Lua Object nametag.
axis (Optional) - can be "X", "Y" or "XY", defaults to "XY".

Examples:

screenCenter('mySprite', 'x') - Objects gets only centered horizontally.
screenCenter('mySprite', 'y') - Objects gets only centered vertically.
screenCenter('mySprite', 'xy') - Objects gets centered on both axis.

scaleObject

scaleObject(tag:String, x:Float, y:Float, ?updateHitbox:Bool = true):Void

Scales an Object by a ratio.

tag - Variable name of the instance or Lua Object nametag.
x - Scale ratio X.
y - Scale ratio Y.
updateHitbox (Optional) - Updates Hitbox after scaling.

Examples:

scaleObject('mySprite', 1.5, 2) - Object gets stretched 1.5x larger horizontally and 2x larger vertically.

setGraphicSize

setGraphicSize(tag:String, x:Float, ?y:Float = 0, ?updateHitbox:Bool = true):Void

Scales an Object by a ratio.

tag - Variable name of the instance or Lua Object nametag.
x - Width in pixels.
y (Optional) - Height in pixels, set to 0 to keep its size constraint to the Width. Defaults to 0.
updateHitbox (Optional) - Updates Hitbox after scaling.

Examples:

setGraphicSize('mySprite', 300, 300) - Object will be 300 pixels wide and 300 pixels tall.
setGraphicSize('mySprite', 500) - Object will be 500 pixels wide, height will be scaled keeping its size constraint.

updateHitbox

updateHitbox(tag:String):Void

Updates the Width/Height hitboxes and the Offset of an Object, used after scaling operations.

tag - Variable name of the instance or Lua Object nametag.

setBlendMode

setBlendMode(tag:String, ?blend:String = ''):Bool

Changes the Blend Mode of an object, similarly to Photoshop and other image editors.
Returns whether the operation was successful.

tag - Variable name of the instance or Lua Object nametag.
blend - Blend mode name, leave empty for using the default blend mode.

Examples:

setBlendMode('mySprite', 'add') - Changes Blend Mode to "ADD".

Note: Some blend modes like "OVERLAY" just seem to not work at all, this is not my fault!

getMidpointX

getMidpointX(tag:String):Float

Returns the X of the center point of an Object.

tag - Variable name of the instance or Lua Object nametag.

getMidpointY

getMidpointY(tag:String):Float

Returns the Y of the center point of an Object.

tag - Variable name of the instance or Lua Object nametag.

getGraphicMidpointX

getGraphicMidpointX(tag:String):Float

Returns the Object's Graphic center X.

tag - Variable name of the instance or Lua Object nametag.

getGraphicMidpointY

getGraphicMidpointY(tag:String):Float

Returns the Object's Graphic center Y.

tag - Variable name of the instance or Lua Object nametag.

getScreenPositionX

getScreenPositionX(tag:String, ?camera:String = 'game'):Float

Returns the Object's On-Camera X Position.

tag - Variable name of the instance or Lua Object nametag.
camera (Optional) - Can be "game", "hud" or "other", defaults to "game".

Examples:

getScreenPositionX('mySprite') - Object position on Game Camera.
getScreenPositionX('mySprite', 'hud') - Object position on HUD Camera.

getScreenPositionY

getScreenPositionY(tag:String, ?camera:String = 'game'):Float

Returns the Object's On-Camera Y Position.

tag - Variable name of the instance or Lua Object nametag.
camera (Optional) - Can be "game", "hud" or "other", defaults to "game".

Examples:

getScreenPositionY('mySprite') - Object position on Game Camera.
getScreenPositionY('mySprite', 'hud') - Object position on HUD Camera.

getPixelColor

getPixelColor(tag:String, x:Int, y:Int):Int

Gets the color of a pixel in a Sprite's Graphic.
Returns the color's integer value, if invalid, it returns black.

tag - Variable name of the instance or Lua Object nametag.
x - Pixel X of the Graphic.
y - Pixel Y of the Graphic.

Note: Sprites will require to have their GPU Caching turned off for it to work.

objectsOverlap

objectsOverlap(obj1:String, obj2:String):Bool

Returns whether two Object hitboxes are overlapping each other, useful for collision checking.

obj1 - Variable name of the instance or Lua Object nametag of the first object.
obj2 - Variable name of the instance or Lua Object nametag of the second object.

Examples:

objectsOverlap('mySprite1', 'mySprite2') - Checks if two Lua Sprites are colliding against each other's hitboxes.