Packages
 Input
 Module
 User
 DB
 Interface

Objects
 bitmapwidget
 databasenode
 dragdata
 textwidget
 tokeninstance
 widget
 widgetcontainer

Elements
 buttoncontrol
 categoryselectioncontrol
 chatentry
 chatwindow
 databasecontrol
 diecontrol
 diefield
 genericcontrol
 imagecontrol
 numbercontrol
 numberfield
 portraitselectioncontrol
 script
 scrollercontrol
 stringcontrol
 stringfield
 subwindow
 textbasecontrol
 tokenbag
 tokencontrol
 tokenfield
 windowclass
 windowcontrol
 windowinstance
 windowlist
 windowreferencecontrol
 windowreferencefield

Components
 categoryselectionsettings
 customdie
 die
 font
 framedef
 desktopframe
 hotkeybar
 icon
 imageupdatefolder
 importinfo
 includefile
 panel
 portraitset
 template
 tokenroot
 tooltip
getBitmap
getBitmapName
setBitmap
setColor



Inherits widget
Context widgetcontainer

A bitmap widget is a specialized version of widget.

Bitmap widgets contain a single bitmap. The bitmap can be modulated with a color value, affecting its hue and transparency.



Interface

getBitmap

function getBitmap( )

Returns a reference to the bitmap object representing the bitmap contained in the widget.

Return values

(bitmap)
A reference to the bitmap object

getBitmapName

function getBitmapName( )

Retrieves the resource name of the bitmap contained in the widget.

Return values

(string)
The name of the bitmap

setBitmap

function setBitmap( name )

Sets the bitmap contained in the widget.

Parameters

name   (string)   
The name of the bitmap resource to be displayed in the widget

setColor

function setColor( color )

Set the color the image is modulated with. The modulation operation scales the color components of the pixels in the bitmap from zero to the value in the original bitmap, thus adjusting the hue of the image. The image color values can't be scaled up using this functionality.

Parameters

color   (string)   
The color specified as a HTML compatible string representing an RGB color with an alpha (transparency) value. The format of the string is 'aarrggbb', and each component is presented as a hexadecimal value from 00 to FF.


'Fantasy Grounds' is a trademark of SmiteWorks Ltd.
'd20 System' and the d20 System logo are trademarks of Wizards of the Coast, Inc. in the United States and other countries and are used with permission.
© 2004-2008 SmiteWorks Ltd. ALL RIGHTS RESERVED.
Privacy policy