DX MODDING GUIDE
  • Welcome to the DX Modding Guide!
  • File Structure
    • Folder Structure
    • Mod File
    • Metadata
  • Lua API
    • Working with GML
    • Callbacks
    • Assets
      • Sprites
      • Sounds
      • Fonts
    • Properties
    • Modcharts
    • FNFFD Functions
  • basic tutorials
    • Custom Songs
    • Example Mods
Powered by GitBook
On this page
  • setProperty(property: String, value: Dynamic)
  • getProperty(property: String)
  • setUIProperty(uipart: String, property: String, value: Dynamic)
  • getUIProperty(uipart: String, property: String)
  • Notable Properties
  • Song Variables
  • Gameplay Variables
  • Visual Effects
  • Misc Variables
  • UI Properties
  • scoretext
  • healthbar
  • flowbar
  1. Lua API

Properties

setProperty(property: String, value: Dynamic)

quickly sets a property in obj_song

EXAMPLE:

function onCreatePost()
     -- alternative to obj_song.ntsc = true
     setProperty(“ntsc”,true) -- enables the ntsc filter from the bonus songs
end

getProperty(property: String)

returns a property from obj_song EXAMPLE:

function onCreatePost()
     show_message(getProperty(”ntsc”)) -- gets if the NTSC filter is enabled
end

setUIProperty(uipart: String, property: String, value: Dynamic)

sets a part of the ui's property EXAMPLE:

function onCreatePost()
     setUIProperty(”scoretext”,”shown”,false) -- hides the score text
end

getUIProperty(uipart: String, property: String)

sets a part of the ui's property EXAMPLE:

function onCreatePost()
     show_message(getUIProperty(”scoretext”,”xpos”)) -- would return scoretxt's xposition
end

Notable Properties

Song Variables

  • misses- current amount of misses

  • accuracy - current accuracy

  • coolscore - current score

  • skill - current health (0 is full health, 100 is no health)

  • bpm - bpm

Gameplay Variables

  • skipCountdown - skips countdown if true

  • ghosttap - enables ghost tapping if true

Visual Effects

  • ntsc - adds the filter from the bonus songs if true

  • screenborder - adds the vignette from weeknd 4 if true

Misc Variables

  • houtline - healthbar outline

  • hplayer - player hp bar colour

  • hbaddie - badguy hp bar colour

  • foutline - flowbar outline colour

  • fback - flowbar bg colour

  • ffull - flowbar fill colour

  • baddieicon and playericon - player icons (set them to a sprite and they'll change)

UI Properties

(these only work with setUIProperty and getUIProperty)

scoretext

  • xpos: Int

  • ypos: Int

  • scalex: Int (offsets scale)

  • scaley: Int (offsets scale)

  • font: Font

  • shown: Bool

healthbar

  • xpos: Int

  • ypos: Int

  • scalex: Int

  • scaley: Int

  • shown: Bool

flowbar

  • xpos: Int

  • ypos: Int

  • scalex: Int

  • scaley: Int

  • shown: Bool

PreviousFontsNextModcharts

Last updated 5 months ago