| Welcome to Epee Engine. We hope you enjoy your visit. You're currently viewing our forum as a guest. This means you are limited to certain areas of the board and there are some features you can't use. If you join our community, you'll be able to access member-only sections, and use many member-only features such as customizing your profile, sending personal messages, and voting in polls. Registration is simple, fast, and completely free. Join our community! If you're already a member please log in to your account to access all of our features: |
| Epee Engine; Documentation on the Epee Engine | |
|---|---|
| Topic Started: Mar 8 2007, 11:43 AM (1,502 Views) | |
| Alan | May 10 2007, 09:48 AM Post #31 |
|
Administrator
  ![]](http://209.85.48.16/static/1/pip_r.png)
|
Button * FindButton ( std::string _name ) Public function of the Epee Engine Class Description: returns a pointer to a Button with name _name from the current rendable list Arguments: Required: std::string _name Name of the Button Return Value: returns a pointer to a Button with the name _name if the Button does not exist a NULL pointer is returned |
 |
 
|
| Alan | May 10 2007, 09:50 AM Post #32 |
|
Administrator
|
ButtonTB * FindButtonTB ( std::string _name ) Public function of the Epee Engine Class Description: returns a pointer to a ButtonTB with name _name from the current rendable list Arguments: Required: std::string _name Name of the ButtonTB Return Value: returns a pointer to a ButtonTB with the name _name if the ButtonTB does not exist a NULL pointer is returned |
|
|
|
| Alan | May 10 2007, 09:51 AM Post #33 |
|
Administrator
|
image * FindImage ( std::string _name ) Public function of the Epee Engine Class Description: returns a pointer to an Image with name _name from the current rendable list Arguments: Required: std::string _name Name of the Image Return Value: returns a pointer to an Image with the name _name if the Image does not exist a NULL pointer is returned |
|
|
|
| Alan | May 10 2007, 09:52 AM Post #34 |
|
Administrator
|
Animation * FindAnimation ( std::string _name ) Public function of the Epee Engine Class Description: returns a pointer to an Animation with name _name from the current rendable list Arguments: Required: std::string _name Name of the Animation Return Value: returns a pointer to an Animation with the name _name if the Animation does not exist a NULL pointer is returned |
|
|
|
| Alan | May 14 2007, 11:25 PM Post #35 |
|
Administrator
|
Sprockets * FindSprockets( std::string _name, std::string _renderlist ) Public function of the Epee Engine Class Description: returns a pointer to a sprocket from the _renderlist. if the sprocket does not exist in _renderlist then a NULL pointer is returned Arguments: Required: std::string _name Name of the Sprocket to find Optional std::string _renderlist Render list to search for the sprocket in defaults to "Current" NOTE: Ever renderlist caches the last sprocket found so,sequential calls to find the same sprocket do NOT cause a performance loss Return Value: returns a pointer to the sprocket if it is found in the render list otherwise it returns a NULL pointer |
|
|
|
| Alan | May 15 2007, 10:46 AM Post #36 |
|
Administrator
|
bool ChangeSprocketZ ( Sprockets * _SprocketToChange, int _newZ, RenderList * _list ) Public function of the Epee Engine Class Description: Changes the z value (depth) of a sprocket zero is at the camera. negative values are behind the camera and positive are in front of the camera Arguments: Required: Sprockets * _SprocketToChange A pointer to the sprocket you want to change the z value of. int _newZ The Z value you want to change the sprocket to Optional RenderList * _list A pointer to the render list where the sprocket exist defaults to NULL and thus uses the Current renderlist NOTE: there is no check to make sure the sprocket does exist in the the render list. This will change in the next version. Return Value: returns true if the value is changes successfully. returns false on error |
|
|
|
| Alan | May 18 2007, 10:40 AM Post #37 |
|
Administrator
|
int GetFps() Public function of the Epee Engine Class Description: returns the frames per secound that the Epee Engine is rendering at Arguments: NONE Return Value: returns the frames per secound that the Epee Engine is rendering at |
|
|
|
| Alan | May 18 2007, 10:45 AM Post #38 |
|
Administrator
|
bool SetFps ( int _fps ) Public function of the Epee Engine Class Description: Sets the frames per second that the Epee Engine is rendering at NOTE:There is a small pause in event handling when the new frame rate is significantly different from old Arguments: int _fps new frames per second the Epee Engine should render at Return Value: Returns true if the new frame rate is set |
|
|
|
| Alan | May 21 2007, 11:00 AM Post #39 |
|
Administrator
|
bool IsFoucsOnTextBox() Public function of the Epee Engine Class Description: returns true if any editable Textbox on the screen has been click and is in a state to be that the text can now be edited. Note: next version the function will return a pointer to the textBox and return Null other wise Arguments: NONE Return Value: returns true if any editable Textbox on the screen has been click and is in a state to be that the text can now be edited. Returns false if no textBox has been clicked to be edited |
|
|
|
| Alan | May 23 2007, 11:13 AM Post #40 |
|
Administrator
|
std::string GetCurrentRenderList() Public function of the Epee Engine Class Description: returns the name of the current render list Arguments: NONE Return Value: returns a string that contains the name of the current render list |
|
|
|
| Alan | May 23 2007, 11:16 AM Post #41 |
|
Administrator
|
RenderList * GetCurrentRenderListptr(); Public function of the Epee Engine Class Description: returns a pointer to the instance of the current render list Arguments: NONE Return Value: returns a pointer to the instance of the current render list returns NULL if there is no current render list |
|
|
|
| Alan | May 23 2007, 11:21 AM Post #42 |
|
Administrator
|
bool SetCurrentRentderList ( std::string _ListToChangeTo ) Public function of the Epee Engine Class Description: Set the render list that should be drawn. That list replaces the current render list Note: when the Epee Engine is initialized it creates a render list for you called Default. New render list can be created with the CreateRenderlist call. Once they are created this function can be used to switch out render list. Arguments: _ListToChangeTo name of the render list do be drawn. Return Value: returns true if _ListToChangeTo on success returns false otherwise |
|
|
|
| « Previous Topic · Documentation · Next Topic » |
