User:Flying Jester/TurboSphere API - Revision history

Flying Jester: /* Time Functions */

2013-11-25T03:54:03Z

Time Functions

← Older revision		Revision as of 03:54, 25 November 2013
Line 38:		Line 38:

	* Delay(ms)		* Delay(ms)
	:: Idles the engine for 'ms' seconds. This cedes CPU time to other programs, and allows TurboSphere to use less than 100% of available CPU time.		:: Idles the engine for 'ms' seconds. This cedes CPU time to other programs, and allows TurboSphere to use less than 100% of available CPU time. This does not affect any threaded operations, which continue to run.

	=GraphicSDL Functions=		=GraphicSDL Functions=

Flying Jester at 00:51, 20 November 2013

2013-11-20T00:51:49Z

@@ Line 304: / Line 304: @@
 * ttffont.drawText(x, y, str)
 :: Draws 'str' using 'ttffont' at 'x', 'y'.
 =InputSDL=
@@ Line 438: / Line 441: @@
 * AreKeysLeft()
 :: Checks whether there are keys in the key buffer.
 ==Mouse==
@@ Line 517: / Line 499: @@
 * RemoveFile(filename)
 :: Deletes the file 'filename'.
 ==File Object==
@@ Line 557: / Line 542: @@
 file1.close(); //Close the second file.
 </syntaxhighlight>
 =WindowStylesSDL=

Flying Jester: /* BMPFontSDL */

2013-11-20T00:25:57Z

BMPFontSDL

← Older revision		Revision as of 00:25, 20 November 2013
Line 281:		Line 281:
	* font.getStringWidth(str)		* font.getStringWidth(str)
	:: Returns the width of 'str' as drawn by 'font'.		:: Returns the width of 'str' as drawn by 'font'.

			* font.getHeight()
			:: Returns the max height of the fonts characters.

	* font.setColorMask(color)		* font.setColorMask(color)

Flying Jester at 00:19, 20 November 2013

2013-11-20T00:19:39Z

@@ Line 120: / Line 120: @@
 * image.save(filename)
-::Saves a copy of the image as 'filename'. Currently the only supported format is BMP.
+::Saves a copy of the image as 'filename'. Currently the only supported formats are BMP and TGA (with RLE compression). Some versions (particularly on Unix-like platforms) support saving to PNG.
 * GrabImage(x, y, w, h)
@@ Line 146: / Line 146: @@
 * surface.blit(x, y)
-:: Blits the surface at 'x', 'y'. [[API:Surface|Surfaces]] are slower to blit than [[API:Image|images]].
+:: Blits the surface at 'x', 'y'. [[API:Surface|Surfaces]] are slower to blit than [[API:Image|images]]. If you plan on blitting a surface more than once, consider converting it to an image with surface.createImage().
 * surface.setAlpha(a)
@@ Line 192: / Line 177: @@
 * surface.getClippingRectangle()
 ::Returns a JS object that represents the surface's clipping rectangle, with properties 'x', 'y', 'w', and 'h'.
 * GrabSurface(x, y, w, h)
 ::Returns a new surface object containing the contents of the screen in the specified area. Contents of the screen are cleared by [[API:FlipScreen|FlipScreen]] calls, so something must have been drawn in the specified are since the last call to FlipScreen for the surface to contain anything but black.
 * surface.width
@@ Line 230: / Line 248: @@
 * Polygon(array, color)
 :: Draws a polygon described by array, filled with 'color'. The elements of 'array' must have x and y properties.
 =BMPFontSDL=
@@ Line 550: / Line 577: @@
 * Sound(filename)
-::Creates a [[API:Sound|sound object]] from the file 'filename'. In 0.3.0, all sounds are streamed, although this will not be the case in later releases.
+::Creates a [[API:Sound|sound object]] from the file 'filename'. In 0.3.0 and later, all sounds are streamed by default.
 * sound.play([loop])
@@ Line 566: / Line 593: @@
 * sound.isPlaying()
 ::Checks if the sound is currently playing.
 ===SoundEffect Object===
@@ Line 583: / Line 616: @@
 * soundeffect.isPlaying()
 ::Checks if the soundeffect is currently playing.

Flying Jester at 23:26, 27 October 2013

2013-10-27T23:26:29Z

← Older revision		Revision as of 23:26, 27 October 2013
Line 1:		Line 1:
	This page documents the TurboSphere API. Currently, it is up to date for TurboSphere version 0.3.0. It is sorted by which plugin the function is provided by, and contains lists for all the plugins included with the standard TurboSphere distribution.		This page documents the TurboSphere API. Currently, it is up to date for TurboSphere version 0.3.5a. It is sorted by which plugin the function is provided by, and contains lists for all the plugins included with the standard TurboSphere distribution.

	Note that while functions and objects are linked to by this page, all pages prefixed with 'API' refer to the Sphere versions of the objects and functions. The descriptions and examples for Sphere functions and objects are generally analogous to the TurboSphere versions, but not exactly the same.		Note that while functions and objects are linked to by this page, all pages prefixed with 'API' refer to the Sphere versions of the objects and functions. The descriptions and examples for Sphere functions and objects are generally analogous to the TurboSphere versions, but not exactly the same.
Line 7:		Line 7:

	=Engine Functions=		=Engine Functions=

			* EvaluateScript(filename)
			:: Compiles the indicated script and executes it.

	* RequireScript(filename)		* RequireScript(filename)
	:: Compiles the indicated script and executes it.		:: Compiles the indicated script and executes it if it has not been required previously.

			* RequireSystemScript(filename)
			:: Requires a script in the system/script directory.

	* GetVersion()		* GetVersion()
Line 16:		Line 22:
	* GetVersionString()		* GetVersionString()
	:: Returns a string representation of the version of TurboSphere. This number also represents the versions of all the default plugins (they all share this same version number). For example: "0.2.2a"		:: Returns a string representation of the version of TurboSphere. This number also represents the versions of all the default plugins (they all share this same version number). For example: "0.2.2a"

			* Exit()
			:: Unconditionally exits the engine.

			* Abort(message)
			:: Aborts execution and displays 'message'.

			* GarbageCollect()
			:: Attempts to trigger garbage collection of the JS environment. This function is primarily kept for compatibility. Garbage collection may or may not actually take place when it is called.

	===Time Functions===		===Time Functions===
Line 31:		Line 46:
	* FlipScreen()		* FlipScreen()
	:: Draws the framebuffer to the screen. You must call this before anything you blit or draw will be visible.		:: Draws the framebuffer to the screen. You must call this before anything you blit or draw will be visible.

	* SetTitle(title)
	~~:: Sets the title of the game window.~~

	* GetScreenHeight()		* GetScreenHeight()
Line 40:		Line 52:
	* GetScreenWidth()		* GetScreenWidth()
	:: Returns the width of the game window in pixels.		:: Returns the width of the game window in pixels.

			* SetClippingRectangle(x, y, w, h)
			:: Sets the clipping rectangle on the screen.

			* GetClippingRectangle()
			:: Returns an object with the properties x, y, w, h, that describes the current clipping rectangle of the screen.

	===Colors===		===Colors===
Line 147:		Line 165:
	* surface.setAlpha(a)		* surface.setAlpha(a)
	::Sets the alpha of the surface to 'a'.		::Sets the alpha of the surface to 'a'.

			* surface.blitSurface(surface_object, x, y)
			:: Blits surface_object onto surface at x, y.

			* surface.cloneSection(x, y, w, h)
			:: Returns a surface object that contains the section of surface at x, y, and is w by h.

	* surface.setClippingRectangle(x, y, w, h)		* surface.setClippingRectangle(x, y, w, h)
Line 156:		Line 180:
	surface.rectangle(0, 0, 16, 8, new Color(0, 0, 255, 255)); //Make the top half of the surface blue.		surface.rectangle(0, 0, 16, 8, new Color(0, 0, 255, 255)); //Make the top half of the surface blue.

	surface.~~setCLippingRectangle~~(8, 0, 8, 16); //Set the clipping rectangle of the surface to be the right half.		surface.setClippingRectangle(8, 0, 8, 16); //Set the clipping rectangle of the surface to be the right half.

	surface.rectangle(0, 0, 16, 16, new Color(0, 255, 0, 255)); //Try and fill the rectangle with green. Only the right half will be changed!		surface.rectangle(0, 0, 16, 16, new Color(0, 255, 0, 255)); //Try and fill the rectangle with green. Only the right half will be changed!
Line 166:		Line 190:
	</syntaxhighlight>		</syntaxhighlight>

	* surface.~~getCLippingRectangle~~()		* surface.getClippingRectangle()
	::Returns a JS object that represents the surface's clipping rectangle, with properties 'x', 'y', 'w', and 'h'.		::Returns a JS object that represents the surface's clipping rectangle, with properties 'x', 'y', 'w', and 'h'.

Line 203:		Line 227:
	* GradientTriangle(x1, y1, x2, y2, x3, y3, [[API:Color\|color1]], [[API:Color\|color2]], [[API:Color\|color3]])		* GradientTriangle(x1, y1, x2, y2, x3, y3, [[API:Color\|color1]], [[API:Color\|color2]], [[API:Color\|color3]])
	::Draws a triangle with vertices 'x1', 'y1', 'x2', 'y2', 'x3', 'y3', fading between the colors.		::Draws a triangle with vertices 'x1', 'y1', 'x2', 'y2', 'x3', 'y3', fading between the colors.

			* Polygon(array, color)
			:: Draws a polygon described by array, filled with 'color'. The elements of 'array' must have x and y properties.

	=BMPFontSDL=		=BMPFontSDL=
Line 216:		Line 243:
	:: Draws 'str' using 'font' at 'x', 'y'.		:: Draws 'str' using 'font' at 'x', 'y'.

	*font.~~gatStringWidth~~(str)		* font.drawZoomedText(x, y, str, f)
			:: Draws 'str' using 'font' at 'x', 'y', zoomed by factor 'f'.

			* font.drawTextBox(x, y, w, h, y_offset, str)
			:: Draws 'str' using 'font' inside the box described by 'x', 'y', 'w', 'h', and offset vertically by 'y_offset'.

			* font.wordWrapString(str)
			:: Returns an array of strings, breaking up 'str' as though font.drawTextBox was called, and each element of the array is a line of text to be drawn.

			* font.getStringWidth(str)
	:: Returns the width of 'str' as drawn by 'font'.		:: Returns the width of 'str' as drawn by 'font'.

			* font.setColorMask(color)
			:: Sets the mask of 'font'.

			* font.getColorMask()
			:: Returns the color mask of 'font'.

	* GetSystemFont()		* GetSystemFont()

Flying Jester at 11:45, 8 September 2013

2013-09-08T11:45:37Z

← Older revision		Revision as of 11:45, 8 September 2013
Line 2:		Line 2:

	Note that while functions and objects are linked to by this page, all pages prefixed with 'API' refer to the Sphere versions of the objects and functions. The descriptions and examples for Sphere functions and objects are generally analogous to the TurboSphere versions, but not exactly the same.		Note that while functions and objects are linked to by this page, all pages prefixed with 'API' refer to the Sphere versions of the objects and functions. The descriptions and examples for Sphere functions and objects are generally analogous to the TurboSphere versions, but not exactly the same.


	__TOC__		__TOC__

Flying Jester: /* File Object */

2013-06-16T01:31:49Z

File Object

← Older revision		Revision as of 01:31, 16 June 2013
Line 467:		Line 467:
	::; Example:		::; Example:
	<syntaxhighlight>		<syntaxhighlight>
	var file1 = new File("savefile1.save"); //create the file '~~newfile~~.save' in the save directory.		var file1 = new File("savefile1.save"); //create the file 'savefile1.save' in the save directory.

	file1.write("Lives", "3"); //write a value to the file.		file1.write("Lives", "3"); //write a value to the file.

Flying Jester at 01:29, 16 June 2013

2013-06-16T01:29:30Z

← Older revision		Revision as of 01:29, 16 June 2013
Line 1:		Line 1:
	This page documents the TurboSphere API. Currently, it is up to date for TurboSphere version 0.3.0. It is sorted by which plugin the function is provided by, and contains lists for all the plugins included with the standard TurboSphere distribution.		This page documents the TurboSphere API. Currently, it is up to date for TurboSphere version 0.3.0. It is sorted by which plugin the function is provided by, and contains lists for all the plugins included with the standard TurboSphere distribution.

			Note that while functions and objects are linked to by this page, all pages prefixed with 'API' refer to the Sphere versions of the objects and functions. The descriptions and examples for Sphere functions and objects are generally analogous to the TurboSphere versions, but not exactly the same.

	__TOC__		__TOC__

Flying Jester at 01:25, 16 June 2013

2013-06-16T01:25:43Z

← Older revision		Revision as of 01:25, 16 June 2013
Line 500:		Line 500:
	:: Returns an ascii character that represents the key constant 'key'. If 'shift' is true, then it the character is represented as though the shift key is pressed.		:: Returns an ascii character that represents the key constant 'key'. If 'shift' is true, then it the character is represented as though the shift key is pressed.

	=~~audioBass~~=		=AudioBass=

	===Sound Object===		===Sound Object===

Flying Jester at 01:25, 16 June 2013

2013-06-16T01:25:11Z

← Older revision		Revision as of 01:25, 16 June 2013
Line 499:		Line 499:
	* getkeystring(key [, shift])		* getkeystring(key [, shift])
	:: Returns an ascii character that represents the key constant 'key'. If 'shift' is true, then it the character is represented as though the shift key is pressed.		:: Returns an ascii character that represents the key constant 'key'. If 'shift' is true, then it the character is represented as though the shift key is pressed.

			=audioBass=

			===Sound Object===

			* Sound(filename)
			::Creates a [[API:Sound\|sound object]] from the file 'filename'. In 0.3.0, all sounds are streamed, although this will not be the case in later releases.

			* sound.play([loop])
			::Plays the sound. If 'loop' is false or no parameter is given, the sound is played once. If 'loop' is true then the sound is played until [[API:Sound.stop\|stop()]] is called. If the sound is already playing, it is restarted from the beginning.

			* sound.stop()
			::Stops playing a sound. The sound will be started from the beginning next time [[API:Sound.play\|play()]] is called.

			* sound.pause()
			::Stops playing a sound. Playback will resume from the pausing point next time [[API:Sound.play\|play()]] is called.

			* sound.getLength()
			::Returns the length of 'sound' in milliseconds.

			* sound.isPlaying()
			::Checks if the sound is currently playing.

			===SoundEffect Object===

			* SoundEffect(filename)
			::Creates a [[API:SoundEffect\|soundeffect object]] from the file 'filename'.

			* soundeffect.play([loop])
			::Plays the soundeffect. If 'loop' is false or no parameter is given, the sound is played once. If 'loop' is true then the sound is played until [[API:SoundEffect.stop\|stop()]] is called. A soundeffect may be played as many times simultaneously as desired.

			* soundeffect.stop()
			::Stops playing all instances of 'soundeffect'.

			* soundeffect.getLength()
			::Returns the length of 'soundeffect' in milliseconds.

			* soundeffect.isPlaying()
			::Checks if the soundeffect is currently playing.