spriteManager

Methods
5
Fields
None

Getting one

spriteManager

Methods

MethodReturnsDescription
getSprite(number, number)BufferedImage?Frame file of sprite archive (a SpriteID), as an image of its stored size, or nil while the client cannot read it (before the login…
getSpriteAsync(number, number, (BufferedImage) -> ())()(SpriteManager, number, number, (BufferedImage) -> ()) -> (): Call user with frame file of sprite archive: at once when the sprite…
getSpriteAsync(number, number, InfoBox)()
addSpriteOverrides({any})()Replace game sprites with the plugin's images. add is an array of objects with getSpriteId() and getFileName() methods (such as an ov…
removeSpriteOverrides({any})()At the next client tick, remove each override's getSpriteId() from client:getSpriteOverrides(), so the client draws its own sprite agai…
addSpriteTo(JButton, number, number)()(SpriteManager, JButton, number, number) -> (): Show frame file of sprite archive on c: getSpriteAsync(archive, file, ...), then…
addSpriteTo(JLabel, number, number)()

Method details

getSprite

getSprite: (SpriteManager, number, number) -> BufferedImage?

Frame file of sprite archive (a SpriteID), as an image of its stored size, or nil while the client cannot read it (before the login screen, or a group it has not loaded). A file the group does not hold is an error (ArrayIndexOutOfBoundsException). The same sprite is the same image while it is cached (128 are kept). Frames past the first read nil on a client whose table does not place them.

getSpriteAsync

getSpriteAsync: ((SpriteManager, number, number, (BufferedImage) -> ()) -> ()) & ((SpriteManager, number, number, InfoBox) -> ())

(SpriteManager, number, number, (BufferedImage) -> ()) -> (): Call user with frame file of sprite archive: at once when the sprite is cached or the client can read it now (an error in user is this call's), else on the client thread at the first client tick it can.

(SpriteManager, number, number, InfoBox) -> (): As the user overload, but the sprite is set on infoBox (setImage), then infoBoxManager:updateInfoBoxImage(infoBox).

addSpriteOverrides

addSpriteOverrides: (SpriteManager, {any}) -> ()

Replace game sprites with the plugin's images. add is an array of objects with getSpriteId() and getFileName() methods (such as an override enum). Nothing for an empty array; else, at the next client tick (clientThread:invokeLater), each override's getFileName() is loaded from the plugin's resources (ImageUtil.loadImageResource), made a sprite (ImageUtil.getImageSpritePixels) and put in client:getSpriteOverrides() under its getSpriteId(), so the client draws it wherever it loads that sprite.

removeSpriteOverrides

removeSpriteOverrides: (SpriteManager, {any}) -> ()

At the next client tick, remove each override's getSpriteId() from client:getSpriteOverrides(), so the client draws its own sprite again.

addSpriteTo

addSpriteTo: ((SpriteManager, JButton, number, number) -> ()) & ((SpriteManager, JLabel, number, number) -> ())

(SpriteManager, JButton, number, number) -> (): Show frame file of sprite archive on c: getSpriteAsync(archive, file, ...), then from Swing's queue (SwingUtilities.invokeLater) c:setIcon(ImageIcon.new(sprite)), so the icon is set after this call, once the client can read the sprite.

(SpriteManager, JLabel, number, number) -> (): Show frame file of sprite archive on c: getSpriteAsync(archive, file, ...), then from Swing's queue (SwingUtilities.invokeLater) c:setIcon(ImageIcon.new(sprite)), so the icon is set after this call, once the client can read the sprite.