BUTTON_OBJ
Definition
struct BUTTON_OBJ
{
int _i_xpos;
int _i_ypos;
int _i_state;
int _i_state_up;
int _i_state_down;
int _i_state_over;
int _i_state_disabled;
int _i_state_stick;
int _i_num_rows;
int _i_num_cols;
int _i_cell_w;
int _i_cell_h;
bool _b_show;
bool _b_cap_show;
bool _b_icon_show;
bool _b_stick_event;
bool _b_stuck;
bool _b_hotspot;
bool _b_cursor_change;
string _str_tile_map;
string _str_icon;
string _str_caption;
string _str_cursor;
string _str_sfx_up;
string _str_sfx_down;
string _str_sfx_over;
string _str_sfx_disabled;
};
Properties
| _i_xpos | the X position of the button |
| _i_ypos | the Y position of the button |
| _i_state | the current state of the object (matches one of the following states) |
| _i_state_up | the cell number of the button up state |
| _i_state_down | the cell number of the button down state |
| _i_state_over | the cell number of the button over state |
| _i_state_disabled | the cell number of the button disabled state |
| _i_state_stick | the cell number of the button stick state |
| _i_num_rows | number of rows in tilemap |
| _i_num_cols | number of cols in tilemap |
| _i_cell_w | width of cells in tilemap |
| _i_cell_h | height of cells in tilemap |
| _b_show | whether the button is visible or not |
| _b_cap_show | whether to display the button caption |
| _b_icon_show | whether to display the button icon |
| _b_stick_event | whether the button can accept events while stuck |
| _b_stuck | whether the button is in a stuck state or not. Needed because _i_state_stick was too ambigous |
| _b_hotspot | whether button is a hotspot or not |
| _b_cursor_change | whether to change the cursor on a mouse over event |
| _str_tile_map | the tile map holding the button states |
| _str_icon | the button's icon ID |
| _str_caption | ID of text to appear on button |
| _str_cursor | ID of cursor to change to on mouse over |
| _str_sfx_up | sfx clip to play on button release |
| _str_sfx_down | sfx clip to play on button click |
| _str_sfx_over | sfx clip to play on mouse over |
| _str_sfx_disabled | sfx clip to play when button is clicked in disabled (or stuck) state |