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
  • addSprite(name: String, path: String, frames: Int, originX: Float, originY: Float)
  • getSprite(name: String)
  1. Lua API
  2. Assets

Sprites

these are similar to psych engine lua sprites! (in a way)

addSprite(name: String, path: String, frames: Int, originX: Float, originY: Float)

add a sprite for use in scripts path will start from the mod's folder

EXAMPLE:

function onCreatePost()
    addSprite("mybackground","assets/awesomebackground.png",1,0,0) -- sprite origin here is top left
    
    --[[
        COOL TIP BECAUSE I DONT FEEL LIKE MAKING AN ACTUAL EDITOR FOR THIS
        
        if you wanna make it easier to set origin points then place a red pixel in
        an art software of your choice and see what the x and y position is
        if you put that into originX and Y it should be centered around that point
        
        i use paint.net but anything should work as long as you can see the position
    ]]-
end

getSprite(name: String)

gets a sprite you added

EXAMPLE:

function onCreatePost()
    -- sprite adding stuff goes here
    
    obj_backgroundp1.sprite_index = getSprite("mybackground")
end
PreviousAssetsNextSounds

Last updated 9 months ago