| 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,508 Views) | |
| Alan | Mar 19 2007, 08:08 AM Post #16 |
|
Administrator
  ![]](http://209.85.48.16/static/1/pip_r.png)
|
bool IsSoundPlaying(Sound *_pSound) Public function of the Epee Engine Class Description: Checks to see if the sound _pSound is playing Arguments: Required: Sound * _pSound Sound object to check Return Value: returns true if the channel associated with _pSound is playing. returns false otherwise |
 |
 
|
| Alan | Mar 19 2007, 08:11 AM Post #17 |
|
Administrator
|
bool IsBackGoundMusicPlaying(); Public function of the Epee Engine Class Description: Checks to see if the Back Ground music created by SetAndPlayBackGroundMusic is playing or not Arguments: NONE Return Value: returns true if the back ground music is playing. returns false otherwise. |
|
|
|
| Alan | Mar 22 2007, 08:26 AM Post #18 |
|
Administrator
|
bool LoadConfigurationFile(std::string _FileName) Public function of the Epee Engine Class Description: loads a Sprocket Configuration File. you can define image, textboxes ,animations, and other sprockets in a text file and then create them all with one function call see Sprocket Configuration File in the documentation section of the fourm Arguments: Required: td::string _FileName Name of file to load Return Value: returns true on successfully loading and parsing of file, returns false otherwise |
|
|
|
| Alan | Mar 22 2007, 08:28 AM Post #19 |
|
Administrator
|
float GetTimeSinceSetup(); Public function of the Epee Engine Class Description: gets the number of milliseconds since setup was called Arguments: NONE Return Value: returns the number of milliseconds since setup was called |
|
|
|
| Alan | Mar 22 2007, 08:31 AM Post #20 |
|
Administrator
|
void SleepDelay(Uint32 _millisecounds) Public function of the Epee Engine Class Description: makes the program sleep for _millisecounds milliseconds Arguments: Required: Uint32 _millisecounds number of milliseconds to sleep Return Value: None |
|
|
|
| Alan | Mar 24 2007, 12:57 PM Post #21 |
|
Administrator
|
textBox * CreateTextBox( std::string _Name, int _x, int _y, int _z, std::string _TextBoxMessage, std::string _AddtoCurrentRenderlist, unsigned int _height, unsigned int _width, std::string _Font, int _FontPoint, unsigned int _red, unsigned int _blue, unsigned int _green, std::string _FontPath ) Public function of the Epee Engine Class Description: Creates a textbox and adds it to the rendable list _AddtoCurrentRenderlist Arguments: Required: std::string _Name Name of textbox int _x x location of the text box int _y y location of the text box int _z z location of the text box Optional: std::string _TextBoxMessage text to display in the text box defaults to " " std::string _AddtoCurrentRenderlist render list to add the textbox to defaults to "Current" the current active render list unsigned int _height the clipping height of the textbox defaults to -1 the height is set to the height of _TextBoxMessage unsigned int _width the clipping width of the textbox defaults to -1 the width is set to the width of _TextBoxMessage std::string _Font file name of the true type font defaults to True_Type_Font_Defalut True_Type_Font_Defalut: Windows "ARIAL.TTF" Macintosh "Chalkboard.ttf" Linux currently not defined. This will change once I get my Linux box up int _FontPoint font size for _Font defaults to 18 unsigned int _red foreground red color defaults to 255 unsigned int _blue foreground blue color defaults to 255 unsigned int _green foreground green color defaults to 255 std::string _FontPath location of _Font defaults to True_Type_Font_Location True_Type_Font_Location: windows: "C:\\WINDOWS\\Fonts\\" Macintosh: "/Library/Fonts/" Linux: currently not defined. This will change once I get my Linux box up Return Value: if successful returns a pointer to the newly created textbox, otherwise returns a NULL pointer |
|
|
|
| Alan | Mar 26 2007, 10:12 AM Post #22 |
|
Administrator
|
image * CreateImage( std::string _fileName, std::string _Name, int _x, int _y, int _z, std::string _AddtoCurrentRenderlist, bool _Transparency, ) Public function of the Epee Engine Class Description: Creates an image and adds it to the rendable list _AddtoCurrentRenderlist Arguments: Required: std::string _fileName Name of file to load std::string _Name Name of image int _x x location of the image int _y y location of the image int _z z location of the image Optional: std::string _AddtoCurrentRenderlist render list to add the image to defaults to "Current" the current active render list bool _Transparency does not draw pixel that matches the color of the top left pixle defaults to false Return Value: if successful returns a pointer to the newly created image, otherwise returns a NULL pointer |
|
|
|
| Alan | Mar 27 2007, 07:48 AM Post #23 |
|
Administrator
|
Animation * CreateAnimation( std::string _fileName , std::string _Name, int _x, int _y, int _z, int _NumberOfFrames, int _fps, int _StartFrame, int _Loop, int _NumberOfRowsOfFrames, bool _Transparency, bool _StartNow, std::string _AddtoCurrentRenderlist ) Public function of the Epee Engine Class Description: Creates ananimation and adds it to the rendable list _AddtoCurrentRenderlist Arguments: Required: std::string _fileName Name of file to load std::string _Name Name of animation int _x x location of the animation int _y y location of the animation int _z z location of the animation int _NumberOfFrames Number of frames per a row int _fps Frames per second to play the animation at Optional: int _StartFrame Frame to start the animation at Defaults to 0 int _Loop Number of times to play the animation passing in zero makes the animation loop forever Defaults to 1 int _NumberOfRowsOfFrames number of rows of frames the animation is Defaults to 1 bool _Transparency does not draw pixel that matches the color of the top left pixle defaults to false bool _StartNow if this is true the animation starts playing after being created defaults to true std::string _AddtoCurrentRenderlist render list to add the animation to defaults to "Current" the current active render list Return Value: if successful returns a pointer to the newly created animation, otherwise returns a NULL pointer |
|
|
|
| Alan | Mar 28 2007, 10:05 AM Post #24 |
|
Administrator
|
AnimationScript * CreateAnimationScript( std::string _Name, Sprockets * _AnimationSprocket, PlayScrtipFuntionPointer* _ScrtipFuntionPointer, int _z, int _TotalNumberOfFrames, int _fps, int _StartFrame, int _Loop, bool _StartNow, std::string _AddtoCurrentRenderlist ); Public function of the Epee Engine Class Description: Creates an AnimationScript and adds it to the rendable list _AddtoCurrentRenderlist Arguments: Required: std::string _Name Name of AnimationScript Sprockets * _AnimationSprocket Pointer to the sprocket that the script will effect PlayScrtipFuntionPointer* _ScrtipFuntionPointer Pointer to the function that will be called each frame pass in NULL to use animation script function Script insted int _z location in the render list should be less that the z value of _AnimationSprocket int _TotalNumberOfFrames Number of frame to complete the script pass in -1 to run the script until the animation function return true Optional: int _fps Frames per second to run the script at defaults to 30 int _StartFrame Frame to start the script at if _TotalNumberOfFrames is -1 then this is ignored Defaults to 0 int _Loop Number of times to play the script passing in zero makes the script loop forever Defaults to 1 bool _StartNow if this is true the script starts playing after being created defaults to true std::string _AddtoCurrentRenderlist render list to add the animation script to defaults to "Current" the current active render list Return Value: if successful returns a pointer to the newly created animation script, otherwise returns a NULL pointer |
|
|
|
| Alan | Mar 29 2007, 08:56 AM Post #25 |
|
Administrator
|
ButtonTB * CreateButtonTB( std::string _ButtonName, int _Buttonx, int _Buttony, int _Buttonz, std::string _ButtonText , bool _SButtonactive, std::string _AddtoCurrentRenderlist unsigned int _ButtonTB_height, unsigned int _ButtonTB_width, std::string _ButtonTB_Font, int _ButtonTB_FontPoint, unsigned int _ButtonTB_red, unsigned int _ButtonTB_blue , unsigned int _ButtonTB_green, std::string _ButtonFontPath ) Public function of the Epee Engine Class Description: Creates a textbox that is a button and adds it to the rendable list _AddtoCurrentRenderlist Arguments: Required: std::string _ButtonName Name of ButtonTB int _Buttonx x location of the ButtonTB int _Buttony y location of the ButtonTB int _Buttonz z location of the ButtonTB std::string _ButtonText text to display in the ButtonTB Optional: bool _SButtonactive if true the user can click the button if false the button can not be clicked defaults to true std::string _AddtoCurrentRenderlist render list to add the ButtonTB to defaults to "Current" the current active render list unsigned int _ButtonTB_height the clipping height of the ButtonTB if -1 is passed the height is set to the height of _ButtonText defaults to 30 unsigned int _ButtonTB_width the clipping width of the ButtonTB if -1 is passed the width is set to the width of _ButtonText defaults to 100 std::string _ButtonTB_Font file name of the true type font defaults to True_Type_Font_Defalut True_Type_Font_Defalut: Windows "ARIAL.TTF" Macintosh "Chalkboard.ttf" Linux currently not defined. This will change once I get my Linux box up int _ButtonTB_FontPoint font size for _Font defaults to 18 unsigned int _ButtonTB_red foreground red color defaults to 255 unsigned int _ButtonTB_blue foreground blue color defaults to 255 unsigned int _ButtonTB_green foreground green color defaults to 255 std::string _ButtonFontPath location of _Font defaults to True_Type_Font_Location True_Type_Font_Location: windows: "C:\\WINDOWS\\Fonts\\" Macintosh: "/Library/Fonts/" Linux: currently not defined. This will change once I get my Linux box up Return Value: if successful returns a pointer to the newly created ButtonTB, otherwise returns a NULL pointer |
|
|
|
| Alan | Apr 4 2007, 11:55 AM Post #26 |
|
Administrator
|
bool SetUp( unsigned int Screen_Width, unsigned int Screen_Heigth, bool FullSreenMod, std::string _WindowName, bool _Resize, int _fps, unsigned int _BitDepthOfScreen, bool Anyformat ); Public function of the Epee Engine Class Description: initialize the epee engine and opens a new window Arguments: Required: unsigned int Screen_Width The width of the new window unsigned int Screen_Heigth The heigth of the new window Optional: bool FullSreenMod if true the new window is full screen if false a window with a border is opened defaults to false std::string _WindowName The text to appear in the top right of the new window's title bar does not appear in full screen mode Defaults to "Your App Name Here" bool _Resize if true allows the user to resize the window THIS CURRENTLY DOES NOT WORK this is always set to false Defaults to false int _fps Frames Per Second the render engine tries to render at. This give you a constance render speed no mater how fast the processor is. On faster processors the render engine will sleep, if the processor is to slow to render at _fps then the render engine will not sleep. defaults to 60 unsigned int _BitDepthOfScreen Sets the bit depth of the screen. This should be set to bit depth of the biggest image that you are drawing defaults to 16 bool Anyformat allows any bit depth to be drawn to the screen other wise the engine will try to convent the image to _BitDepthOfScreen see SDL_ANYFORMAT for more information defaults to false Return Value: returns true if successful false otherwise |
|
|
|
| Alan | May 8 2007, 10:45 AM Post #27 |
|
Administrator
|
Button * CreateButton (std::string _localfileName , std::string _localName, int _localx, int _localy, int _localz, bool _Transparency, bool _localactive, std::string _AddtoCurrentRenderlist ) Public function of the Epee Engine Class Description: Creates a button that is attached to an image. the button is added to the rendable list _AddtoCurrentRenderlist. Buttons shift two pixel down and to the right to denote that they have been clicked Arguments: Required: std::string _localfileName Name of image to load for the button std::string _localName Name of the button in the render list int _localx x location of the button int _localy y location of the button int _localz z location of the button Optional: bool _Transparency does not draw pixel that matches the color of the top left pixle defaults to false bool _localactive if true the Button can be clicked by the user if false the Button can not be clicked by the user defaults to true std::string _AddtoCurrentRenderlist render list to add the Button to defaults to "Current" the current active render list Return Value: if successful returns a pointer to the newly created Button, otherwise returns a NULL pointer |
|
|
|
| Alan | May 8 2007, 10:50 AM Post #28 |
|
Administrator
|
Button * CreateButton( std::string _localName, int _localx, int _localy, int _localz, int _height, int _width, bool _Transparency, bool _localactive, std::string _AddtoCurrentRenderlist ) Public function of the Epee Engine Class Description: Creates a button that is not attached to an image an is invsable to the user. this button is added to the rendable list but is not draw on the screen Arguments: Required: std::string _localName Name of the button in the render list int _localx x location of the button int _localy y location of the button nt _localz z location of the button int _height the height in pixels of the invisible button int _width the width in pixels of the invisible button Optional: bool _Transparency does not draw pixel that matches the color of the top left pixle This is not really used when using this version of the CreateButton funtion defaults to false bool _localactive if true the Button can be clicked by the user if false the Button can not be clicked by the user defaults to true std::string _AddtoCurrentRenderlist render list to add the Button to defaults to "Current" the current active render list Return Value: if successful returns a pointer to the newly created Button, otherwise returns a NULL pointer |
|
|
|
| Alan | May 9 2007, 08:36 AM Post #29 |
|
Administrator
|
Sprockets * WasAButtonClicked ( int _x, int _y ) Public function of the Epee Engine Class Description: returns the first Sprocket in the current render list that intersects the _x and _y values. Test from closest to furthest this can also be used to test for point to box collision Arguments: Required: int _x x value to test against int _y y value to test against Return Value: returns a pointer to first Sprocket in the current render list that intersects the _x and _y If no Sprockets intersect the _x and _y values it returns NULL |
|
|
|
| Alan | May 10 2007, 09:39 AM Post #30 |
|
Administrator
|
textBox * FindTextBox ( std::string _name ) Public function of the Epee Engine Class Description: returns a pointer to a textBox with name _name from the current rendable list Arguments: Required: std::string _name Name of the textBox Return Value: returns a pointer to a textbox with the name _name if the textbox does not exist a NULL pointer is returned |
|
|
|
| Go to Next Page | |
| « Previous Topic · Documentation · Next Topic » |
