Sprocket Configuration File

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:

Sprocket Configuration File; Documentation on Configuration Files
Topic Started: Mar 13 2007, 10:27 AM (354 Views)
Alan	Mar 13 2007, 10:27 AM Post #1
Administrator Posts: 129 Group: Admin Member #1 Joined: March 8, 2007	<Sprockets> <Image > <Animation> <button> <buttontb> <textbox> <--! --> Note: correction quotes are NOT required around true or false



Alan	May 10 2007, 10:56 AM Post #2
Administrator Posts: 129 Group: Admin Member #1 Joined: March 8, 2007	<Sprockets> this tag denotes that the following tags are going to be classes derived the sprocket class a file currently can only have one sprocket tag set in it example <?xml version="1.0"> <Sprockets> <Image name="temp" x=20 y=20 filename="testfile.bmp"></Image> </Sprockets>



Alan	May 10 2007, 11:20 AM Post #3
Administrator Posts: 129 Group: Admin Member #1 Joined: March 8, 2007	<Image> This denote the engine should create a new Image with the following attributes Attributes Required name name of the Image in the render list quotes are required around the name example name="image1" filename name of the file to load quotes are required around the file name example filename="test.bmp" x x location of the image example x=20 y y location of the image example y=30 z z location of the image -z is behind the viewer +z is in front of the viewer example z=3 Optional renderlist name of the renderlist to put the sprocket into. quotes are required around the name of the render list. The renderlist must exist in code first before loading of the config file. defaults to Current renderlist example renderlist="Default" transparency enables or disables Key Color transparency for the image defaults to false example transparency=true example of Image tag <Image name="image1" filename="test.bmp" x=20 y=30 z=3 renderlist="Default" transparency=true></Image>



Alan	May 17 2007, 09:32 AM Post #4
Administrator Posts: 129 Group: Admin Member #1 Joined: March 8, 2007	<Animation> This denote the engine should create a new Animation with the following attributes Attributes Required name name of the Animation in the render list quotes are required around the name example name="animation1" filename name of the file to load quotes are required around the file name example filename="test2.bmp" x x location of the Animation example x=20 y y location of the Animation example y=30 z z location of the Animation -z is behind the viewer +z is in front of the viewer example z=3 numberofframes This is the number of columns of frames the animation has example numberofframes=5 rowsofframes This is the number of rows of frames the animation has example rowsofframes=1 fps Frames per Second the animation should play at example fps=30 Optional renderlist name of the renderlist to put the sprocket into. quotes are required around the name of the render list. The renderlist must exist in code first before loading of the config file. defaults to Current renderlist example renderlist="Default" transparency enables or disables Key Color transparency for the image defaults to false example transparency=true startingframe The frame to start playing the animation from. The first frame of all Animations is zero. defaults to 0 example startingframe=1 numberofloops Number of times to play the animation. Setting this to zero makes the animation loop forever defaults to 1 example numberofloops=5 playnow If this is set to true the animation will start playing after it is loaded defaults to true example playnow=false example of Animation tag <Animation name="animation1" filename="test2.bmp" x=20 y=30 z=3 renderlist="Default" transparency=true fps=30 numberofframes=5 rowsofframes=1 startingframe=1 numberofloops=5 playnow=false></Animation>



Alan	May 21 2007, 11:22 AM Post #5
Administrator Posts: 129 Group: Admin Member #1 Joined: March 8, 2007	<Button> This denote the engine should create a new button with the following attributes Attributes Required name name of the Image in the render list quotes are required around the name example name="button" x x location of the image example x=20 y y location of the image example y=30 z z location of the image -z is behind the viewer +z is in front of the viewer example z=3 Note: If no filename is specified the height and width attributes are required If a filename is specified then the height and width attributes are ignored, and the height and width of the file are used instead filename name of the file to load quotes are required around the file name example filename="test.bmp" height the height of the inviable clickable area example height=100 width the height of the inviable clickable area example width=100 Optional renderlist name of the renderlist to put the sprocket into. quotes are required around the name of the render list. The renderlist must exist in code first before loading of the config file. defaults to Current renderlist example renderlist="Default" active defines whether or not the button can be clicked defaults to true example active=false transparency enables or disables Key Color transparency defaults to false example transparency=true example of button tag with file name <button name="button" x=20 y=30 z=3 filename="test.bmp" renderlist="Default" active=false transparency=true><button> with out file name <button name="button" x=20 y=30 z=3 renderlist="Default" height=100 width=100 active=false><button>


« Previous Topic · Documentation · Next Topic »