import{_ as a,o as s,c as e,Q as o}from"./chunks/framework.4313453f.js";const E=JSON.parse('{"title":"Image","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"references/image.md","filePath":"references/image.md","lastUpdated":null}'),n={name:"references/image.md"},l=o(`

Image ​

The Image object is designed for adding more advanced backgrounds to your interface. It supports the loading of .nfp and .bimg images, allowing for greater customization of your interface’s appearance.

Properties ​

PropertyTypeDescription
framenumberDetermines the current frame of the bimg image
XOffsetnumberHorizontal offset of the image from its starting position
YOffsetnumberVertical offset of the image from its starting position

set ​

This method sets the image to be displayed in the Image object.

Parameters ​

  1. string The path to the image file you wish to use.
  2. string (optional) - The format of the image: nfp or bimg.

Returns ​

  1. object The object in use

Usage ​

lua
local main = basalt.createFrame()
local image = main:addImage()
image:set("dog.nfp")
local main = basalt.createFrame()
local image = main:addImage()
image:set("dog.nfp")

play ​

Plays a animated bimg image

Parameters ​

  1. boolean optional - infinite loop.

Returns ​

  1. object The object in use

Usage ​

lua
local main = basalt.createFrame()
local image = main:addImage()
image:set("dog.bimg"):play()
local main = basalt.createFrame()
local image = main:addImage()
image:set("dog.bimg"):play()
`,20),t=[l];function p(r,c,i,d,y,h){return s(),e("div",null,t)}const g=a(n,[["render",p]]);export{E as __pageData,g as default};