Bitmap is a class in TeaScript.vbs that allows you to read/write values of bitmaps.

Creating a Bitmap

To create a bitmap you can use the BmpCreate

call bmpcreate(index, picid, useScreenCoords, isVisible, sx, sy, sw, sh, destx, desty, stretchx, stretchy, centerx, centery, angle, color)

For more information visit the BmpCreate documentation.

Using the Bitmap Class

To read the value of Bitmap use:

Bitmap(index).name

To change the value of Bitmap use:

Bitmap(index).name = value

Where index is an unique identifier defined when creating the bitmap object.

Type	Name	Read/Write	Description
double	`destx`	-	The x position of the bitmap.
double	`desty`	-	The y position of the bitmap.
double	`scalex`	-	The horizontal stretch ration. (e.g. 1: default size, 2:double size, 0.5: half size
double	`scaley`	-	The horizontal stretch ration. (e.g. 1: default size, 2:double size, 0.5: half size
double	`rotatang`	-	Rotates the bitmap in counter-clockwise in radians.

Type	Name	Read/Write	Description
double	`attscreen`	-	Determines if the bitmap uses scene or screen coordinates (0:scene, 1: screen).
double	`scrx`	-	Determines the top left x position in the source image.
double	`scry`	-	Determines the top left y position in the source image.
double	`scrwidth`	-	Determines the width loaded in the source image.
double	`scrheight`	-	Determines the height loaded in the source image.
double	`rotatx`	-	The x position of the anchor used for scaling and rotating.
double	`rotaty`	-	The y position of the anchor used for scaling and rotating.

Type	Name	Read/Write	Description
double	`hide`	-	Determines if the bitmap is rendered (0: show, 1:hide)
double	`scrid`	-	Determines the ID of the NPC used as the texture source.
double	`zpos`	-	The priority of the bitmap. Foreground is 0 and background is 1.
double	`blendmode`	-	Determines the blendmodeof the bitmap. [NEEDS LINK TABLE HERE!]
double	`forecolor`	-	An overlay hue added to the bitmap. Setting this value to 0 makes the player invisible, setting it to -1 returns it to default. Use the `rgba(red, green, blue, alpha)` function to choose a specific hue.
double	`forecolor_r`	-	The red value of the hue described in 'forecolor'. Should be a value between 0 to 255. Use this value to read and get only the red component.
double	`forecolor_g`	-	The green value of the hue described in 'forecolor'. Should be a value between 0 to 255. Use this value to read and get only the green component.
double	`forecolor_b`	-	The blue value of the hue described in 'forecolor'. Should be a value between 0 to 255. Use this value to read and get only the blue component.
double	`forecolor_a`	-	The alpha value of the hue described in 'forecolor'. Should be a value between 0 to 255. Use this value to read and get only the alpha component.

Below is a list of certain quirks bitmaps have that does not conform to standard behavior or simply other miscellaneous behavior.