Legacy:Functions - Revision history

DaVince: Added category and warning

2017-08-05T16:24:45Z

Added category and warning

← Older revision		Revision as of 16:24, 5 August 2017
Line 1:		Line 1:
	~~[[Category:Functions]]~~		{{LegacyWarning}}


	This is a definitive reference of the legacy Sphere 1.5 API. In other words, the functions that Sphere 1.5 uses in its JavaScript engine.		This is a definitive reference of the legacy Sphere 1.5 API. In other words, the functions that Sphere 1.5 uses in its JavaScript engine.

Line 143:		Line 145:

	* [[Legacy:HashByteArray\|HashByteArray]](''byte_array''): Calculate MD5 'fingerprint' of data in ''byte_array''.		* [[Legacy:HashByteArray\|HashByteArray]](''byte_array''): Calculate MD5 'fingerprint' of data in ''byte_array''.


			[[Category:Functions]]
			[[Category:Sphere 1]]

DaVince: Renamed all API: references to Legacy: and edited the introduction

2017-06-19T09:07:30Z

Renamed all API: references to Legacy: and edited the introduction

Show changes

Apollolux: /* Clipping */ clipping rectangle object -> ClippingRectangle

2013-06-04T05:57:07Z

Clipping: clipping rectangle object -> ClippingRectangle

← Older revision		Revision as of 05:57, 4 June 2013
Line 81:		Line 81:
	=== Clipping ===		=== Clipping ===

	* Sphere [[API:~~Rectangle (object)~~\|~~Rectangle~~]] object: Holds dimensions for clipping rectangle functions.		* Sphere [[API:ClippingRectangle\|ClippingRectangle]] object: Holds dimensions for clipping rectangle functions.
	* [[API:GetClippingRectangle\|GetClippingRectangle]](): Get the rectangle in which drawing is being clipped on screen.		* [[API:GetClippingRectangle\|GetClippingRectangle]](): Get the rectangle in which drawing is being clipped on screen.
	* [[API:SetClippingRectangle\|SetClippingRectangle]](''x'', ''y'', ''width'', ''height''): Set a rectangle to clip screen drawing.		* [[API:SetClippingRectangle\|SetClippingRectangle]](''x'', ''y'', ''width'', ''height''): Set a rectangle to clip screen drawing.

Apollolux: /* ByteArray object */ API links

2013-06-02T00:41:33Z

ByteArray object: API links

← Older revision		Revision as of 00:41, 2 June 2013
Line 128:		Line 128:
	== ByteArray object ==		== ByteArray object ==

	* Sphere [[~~Object-~~ByteArray\|ByteArray]] object: Holds an array of bytes.		* Sphere [[API:ByteArray\|ByteArray]] object: Holds an array of bytes.
	* [[CreateByteArray]](''length''): Create a new [[~~Object-~~ByteArray\|ByteArray]].		* [[API:CreateByteArray\|CreateByteArray]](''length''): Create a new [[API:ByteArray\|ByteArray]].
	* [[~~bytearray~~.concat]](''byte_array_object'', ''byte_array_to_append''): Returns bytearray with byte_array_to_append attached to the end of it		* [[API:ByteArray/concat\|ByteArray.concat]](''byte_array_object'', ''byte_array_to_append''): Returns bytearray with byte_array_to_append attached to the end of it
	* [[~~bytearray~~.slice]](''start_slice'' [, ''end_slice'']): Returns a slice of the bytearray starting at start, and ending at end or the end of the bytearray if end is omitted. If end is a negative number, the end point is started from the end of the bytearray.		* [[API:ByteArray/slice\|ByteArray.slice]](''start_slice'' [, ''end_slice'']): Returns a slice of the bytearray starting at start, and ending at end or the end of the bytearray if end is omitted. If end is a negative number, the end point is started from the end of the bytearray.

			=== Conversion ===

	~~=== Conversion to and from strings ===~~		* [[API:CreateByteArrayFromString\|CreateByteArrayFromString]](''string''): Create a [[API:ByteArray\|ByteArray]] from ''string''.
			* [[API:CreateStringFromByteArray\|CreateStringFromByteArray]](''byte_array''): Convert a [[API:ByteArray\|ByteArray]] into a string.
	* [[CreateByteArrayFromString]](''string''): Create a [[~~Object-~~ByteArray\|ByteArray]] from ''string''.
	* [[CreateStringFromByteArray]](''byte_array''): Convert a [[~~Object-~~ByteArray\|ByteArray]] into a string.

	=== Data hashing ===		=== Data hashing ===

	* [[HashByteArray]](''byte_array''): Calculate MD5 'fingerprint' of data in ''byte_array''.		* [[API:HashByteArray\|HashByteArray]](''byte_array''): Calculate MD5 'fingerprint' of data in ''byte_array''.

Apollolux: wrap msg box in noinclude

2013-06-02T00:03:33Z

wrap msg box in noinclude

← Older revision		Revision as of 00:03, 2 June 2013
Line 8:		Line 8:
	*https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference - Mozilla JavaScript Reference		*https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference - Mozilla JavaScript Reference

			<noinclude>
	{{section\|sph-section-green\|Making new function/object pages\|Simple steps:		{{section\|sph-section-green\|Making new function/object pages\|Simple steps:
	#Click a red link.		#Click a red link.
Line 27:		Line 27:
	</div>		</div>
	-->		-->
			</noinclude>

	__TOC__		__TOC__

Apollolux: /* Map Engine */ section out

2013-06-01T23:50:07Z

Map Engine: section out

Show changes

Apollolux: /* System interfaces */ API links

2013-06-01T23:24:59Z

System interfaces: API links

← Older revision		Revision as of 23:24, 1 June 2013
Line 68:		Line 68:
	== Video ==		== Video ==

	* [[~~ApplyColorMask~~]](~~''color''~~): ~~Fills~~ the ~~whole~~ screen ~~with~~ ''~~color~~''.		* [[API:FlipScreen\|FlipScreen]](): Show the results of drawing to the screen.
	* [[~~FlipScreen~~]](): ~~Show the results of drawing to~~ the screen.		* [[API:GetFrameRate\|GetFrameRate]](): Get the frame rate that limits [[API:FlipScreen\|FlipScreen]]() call rate.
			* [[API:SetFrameRate\|SetFrameRate]](''frames_per_second''): Limit the rate of [[API:FlipScreen\|FlipScreen]]() calls.
			* [[API:ApplyColorMask\|ApplyColorMask]](''color''): Fills the whole screen with ''color''.

	=== ~~Clipping~~ ===		=== Screen size ===

	* ~~Sphere~~ [[~~Object-Rectangle~~\|~~Rectangle]] object: Holds dimensions for clipping rectangle functions.~~		* [[API:GetScreenWidth\|GetScreenWidth]](): Get the width of the screen.
	* [[GetClippingRectangle]](): Get the ~~rectangle in which drawing is being clipped on~~ screen.		* [[API:GetScreenHeight\|GetScreenHeight]](): Get the height of the screen.
	* [[~~SetClippingRectangle~~]](~~''x'', ''y'', ''width'', ''height''~~): ~~Set a rectangle to clip~~ screen ~~drawing~~.

	=== ~~Frame rate control~~ ===		=== Clipping ===

	* [[~~GetFrameRate~~]](): ~~Get the frame rate that limits~~ [[~~FlipScreen~~]]() ~~call rate~~.		* Sphere [[API:Rectangle (object)\|Rectangle]] object: Holds dimensions for clipping rectangle functions.
	* [[~~SetFrameRate~~]](''~~frames_per_second~~''): ~~Limit the rate of [[FlipScreen]]() calls~~.		* [[API:GetClippingRectangle\|GetClippingRectangle]](): Get the rectangle in which drawing is being clipped on screen.
			* [[API:SetClippingRectangle\|SetClippingRectangle]](''x'', ''y'', ''width'', ''height''): Set a rectangle to clip screen drawing.

	=== Graphics primitives ===		=== Graphics primitives ===

	{{API:Functions/Primitives}}		{{API:Functions/Primitives}}

	~~=== Screen size ===~~

	* [[GetScreenWidth]](): Get the width of the screen.
	* [[GetScreenHeight]](): Get the height of the screen.

	{{API:Functions/Input}}		{{API:Functions/Input}}

			{{API:Functions/Networking}}
	~~== Networking ==~~

	* [[GetLocalAddress]](): Get the local IP address.
	* [[GetLocalName]](): Get the local computer name.
	* [[ListenOnPort]](''port''): Wait for a connection and return a socket for it.
	* [[OpenAddress]](''address'', ''port''): ~~Connect to ''address'' on ''port''.~~

	~~=== Socket object ===~~

	* Sphere [[Object-Socket\|Socket]] object: Has the ability to send/~~receive data over a network.~~
	* [[Socket.close]](): Close the socket.
	* [[Socket.getPendingReadSize]](): Get size of next incoming data block in bytes.
	* [[Socket.isConnected]](): Find if the socket is connected or not.
	* [[Socket.read]](''size''): Read ''size'' number of bytes into a [[Object-ByteArray\|ByteArray]] from socket.
	* [[Socket.write]](''data''): Send a [[Object-ByteArray\|ByteArray]] into the socket.

	= Map Engine =		= Map Engine =

Apollolux: /* Script functions */ API links

2013-06-01T23:10:39Z

Script functions: API links

← Older revision		Revision as of 23:10, 1 June 2013
Line 49:		Line 49:
	= Script functions =		= Script functions =

	* [[GarbageCollect]](): Run JavaScript's garbage collector to free memory.		* [[API:GarbageCollect\|GarbageCollect]](): Run JavaScript's garbage collector to free memory.

	== File inclusion ==		== File inclusion ==

	* [[EvaluateScript]](''filename''): Include a script file unconditionally.		* [[API:EvaluateScript\|EvaluateScript]](''filename''): Include a script file unconditionally.
	* [[EvaluateSystemScript]](''filename''): Include a system script file unconditionally.		* [[API:EvaluateSystemScript\|EvaluateSystemScript]](''filename''): Include a system script file unconditionally.
	* [[RequireScript]](''filename''): Include a script file once.		* [[API:RequireScript\|RequireScript]](''filename''): Include a script file once.
	* [[RequireSystemScript]](''filename''): Include a system script file once.		* [[API:RequireSystemScript\|RequireSystemScript]](''filename''): Include a system script file once.

	== Time ==		== Time ==
	* [[GetTime]](): Get the number of milliseconds since an arbitrary point in time.		* [[API:GetTime\|GetTime]](): Get the number of milliseconds since an arbitrary point in time.

	== Conversion ==		== Conversion ==

Apollolux: /* Time */ move CreateStringFromCode

2013-06-01T22:24:24Z

Time: move CreateStringFromCode

← Older revision		Revision as of 22:24, 1 June 2013
Line 60:		Line 60:
	== Time ==		== Time ==
	* [[GetTime]](): Get the number of milliseconds since an arbitrary point in time.		* [[GetTime]](): Get the number of milliseconds since an arbitrary point in time.

			== Conversion ==
			* [[API:CreateStringFromCode\|CreateStringFromCode]](''ascii_code''): Translate a number to the matching character.

	= System interfaces =		= System interfaces =

Apollolux: /* Engine functions */ move CreateStringFromCode

2013-06-01T22:23:54Z

Engine functions: move CreateStringFromCode

← Older revision		Revision as of 22:23, 1 June 2013
Line 34:		Line 34:
	* [[API:GetVersion\|GetVersion]](): Get the version of Sphere as a number.		* [[API:GetVersion\|GetVersion]](): Get the version of Sphere as a number.
	* [[API:GetVersionString\|GetVersionString]](): Get the full Sphere version.		* [[API:GetVersionString\|GetVersionString]](): Get the full Sphere version.
	* [[API:CreateStringFromCode\|CreateStringFromCode]](''ascii_code''): Translate a number to the matching character.

	== Game control ==		== Game control ==