iPcBillboard Struct Reference
Billboard property class. More...
#include <propclass/billboard.h>
Public Member Functions | |
virtual bool | AreEventsEnabled () const =0 |
Return true if events are enabled. | |
virtual void | EnableEvents (bool e)=0 |
Enable or disable listening for events for this billboard. | |
virtual iBillboard * | GetBillboard ()=0 |
Get the billboard. | |
virtual const char * | GetBillboardName ()=0 |
Get the name of the billboard. | |
virtual void | SetBillboardName (const char *name)=0 |
Set the name of the billboard. |
Detailed Description
Billboard property class.This property class can send out the following messages to the behaviour (add prefix 'cel.parameter.' to get the ID for parameters):
- pcbillboard_select: billboard is selected (x,y,button)
- pcbillboard_move: billboard is moved (x,y,button)
- pcbillboard_unselect: billboard is unselected (x,y,button)
- pcbillboard_doubleclick: billboard is double clicked (x,y,button)
This property class supports the following properties (add prefix 'cel.property.' to get the ID of the property:
- name (string, read/write): name of the billboard.
- materialname (string, read/write): name of the material.
- materialnamefast (string, read/write): name of the material (faster way to set).
- clickable (bool, read/write): clickable yes or no.
- movable (bool, read/write): movable yes or no.
- visible (bool, read/write): visible yes or no.
- restack (bool, read/write): restackable on selection yes or no.
- color (color, read/write): color of this billboard.
- width (long, read/write): width of this billboard.
- height (long, read/write): height of this billboard.
- widthpct (float, read/write): width of this billboard in percentage.
- heightpct (float, read/write): height of this billboard in percentage.
- x (long, read/write): x position of this billboard.
- y (long, read/write): y position of this billboard.
- uv_topleft (vector2, read/write): topleft uv coordinate in material.
- uv_botright (vector2, read/write): botright uv coordinate in material.
- layer (string, read/write): layer name.
- text (string, read/write): optional text on billboard.
- text_offset (vector2, write): offset for text in billboard space.
- text_fg_color (color, write): foreground color.
- text_bg_color (color, write): background color.
- text_font_size (float, write): font size. Set this before setting text_font. Otherwise default is 10.
- text_font (string, write): font.
- text_default_fg_color (color, write): default foreground color (for all billboards).
- text_default_bg_color (color, write): default background color (for all billboards).
- text_default_font_size (float, write): font size. Set this before setting text_default_font. Otherwise default is 10.
- text_default_font (string, write): default font (for all billboards).
Definition at line 78 of file billboard.h.
Member Function Documentation
|
Return true if events are enabled.
|
|
Enable or disable listening for events for this billboard.
|
|
Get the billboard.
|
|
Get the name of the billboard.
|
|
Set the name of the billboard.
|
The documentation for this struct was generated from the following file:
- propclass/billboard.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.6