D2BS
Public Member Functions | Public Attributes

Box Class Reference

A Box screen hook. More...

List of all members.

Public Member Functions

 Box (int x=0, int y=0, int x2=0, int y2=0, int color=0, int opacity=0, int align=0, bool automap=false, ClickHandler click=null, HoverHandler hover=null)
 Create a Box hook with the given parameters.
void remove ()
 Remove the Box from the screen and destroy the corresponding object.

Public Attributes

int x
 The x coordinate (left) of the Box.
int y
 The y coordinate (top) of the Box.
int xsize
 The xsize (width) of the Box.
int ysize
 The ysize (height) of the Box.
bool visible
 Whether or not the Box is visible.
int align
 The horizontal alignment.
int zorder
 The z-order of the Box (what it covers up and is covered by).
ClickHandler click
 The click handler that gets called when the Box is clicked.
HoverHandler hover
 The hover handler that gets called when the Box gets hovered over.
int color
 The color of the Box.
int opacity
 How much of the controls underneath the Box should show through.

Detailed Description

A Box screen hook.

Todo:

Explain (and understand) this better.

Verify all the documentation in this class.


Constructor & Destructor Documentation

Box::Box ( int  x = 0,
int  y = 0,
int  x2 = 0,
int  y2 = 0,
int  color = 0,
int  opacity = 0,
int  align = 0,
bool  automap = false,
ClickHandler  click = null,
HoverHandler  hover = null 
)

Create a Box hook with the given parameters.

Parameters:
xThe x coordinate (left) of the Box.
yThe y coordinate (top) of the Box.
x2The xsize (width) of the Box.
y2The ysize (height) of the Box.
colorSee The colors of screen hooks.

See: http://forums.d2botnet.org/viewtopic.php?f=18&t=1000

Parameters:
opacitySee Explanation of opacity parameter.
alignThe horizontal alignment.

0 - Left

1 - Right

2 - Center

Parameters:
automapWhether the Box is in automap coordinate space (true) or screen coordinate space (false).
clickThe click handler that gets called when the Box is clicked.
hoverThe hover handler that gets called when the Box gets hovered over.

Member Data Documentation

The horizontal alignment.

0 - Left

1 - Right

2 - Center