Scripting:Interfaces - Revision history

Glest Durnham: /* ColoniePortal */

2010-09-11T10:34:18Z

ColoniePortal

← Older revision		Revision as of 10:34, 11 September 2010
Line 42:		Line 42:

	== ColoniePortal ==		== ColoniePortal ==
-	The {{code\|ColoniePortal}} interface enables a script to be used as a ~~ship~~ portal.	+	The {{code\|ColoniePortal}} interface enables a script to be used as a colony portal.
-	Colony portals can be installed on a ~~ship~~.	+	Colony portals can be installed on a colony.
	Anyone with a ship in the same sector can enter the colony's portal, and they will see the HTML output generated by the script.		Anyone with a ship in the same sector can enter the colony's portal, and they will see the HTML output generated by the script.
	By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted.		By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted.

Glest Durnham at 16:51, 10 September 2010

2010-09-10T16:51:55Z

← Older revision		Revision as of 16:51, 10 September 2010
Line 1:		Line 1:
-	[[Category:Scripting~~\|Interfaces~~]]	+	[[Category:Scripting]]
		+	{{ScriptingMenu}}
		+
	Interfaces extend the possibilities of scripts by registering pre-defined variables.		Interfaces extend the possibilities of scripts by registering pre-defined variables.
	For example, the {{code\|Web}} interface provides two variables representing the HTTP request and response.		For example, the {{code\|Web}} interface provides two variables representing the HTTP request and response.

Glest Durnham at 15:14, 16 August 2010

2010-08-16T15:14:02Z

← Older revision		Revision as of 15:14, 16 August 2010
Line 1:		Line 1:
	[[Category:Scripting\|Interfaces]]		[[Category:Scripting\|Interfaces]]
	Interfaces extend the possibilities of scripts by registering pre-defined variables.		Interfaces extend the possibilities of scripts by registering pre-defined variables.
-	For example, the 'Web' interface provides ~~the~~ variables ~~'Response As CWebResponse'~~ and ~~'Request As CWebRequest'~~	+	For example, the {{code\|Web}} interface provides two variables representing the HTTP request and response.
	Using this interface, scripts can generate HTML output and get some information about the HTTP request.		Using this interface, scripts can generate HTML output and get some information about the HTTP request.

	You can use an interface in a script by going to the settings tab in the script editor and ticking the interfaces you want to use.		You can use an interface in a script by going to the settings tab in the script editor and ticking the interfaces you want to use.
	You can also do it manually by adding this code at the top of the script:		You can also do it manually by adding this code at the top of the script:
-	#UseInterface Web, ShipPortal // a comma separated list of interfaces	+	#UseInterface Web, ShipPortal // a comma separated list of interfaces


	== Web ==		== Web ==
-	The 'Web' interface provides a script with the ability to generate HTML output and to read some information about the HTTP request.	+	The {{code\|Web}} interface provides a script with the ability to generate HTML output and to read some information about the HTTP request.

	=== Registered variables ===		=== Registered variables ===
-	; Response As CWebResponse	+	; {{code\|Response As CWebResponse}}
	: This represents the root element for your script's HTML response. By adding elements to Response, the script can generate HTML output.		: This represents the root element for your script's HTML response. By adding elements to Response, the script can generate HTML output.
-	; Request As CWebRequest	+	; {{code\|Request As CWebRequest}}
	: This contains some data describing the HTTP request and some additional data added by STNE. Most notably, it contains the submitted form data.		: This contains some data describing the HTTP request and some additional data added by STNE. Most notably, it contains the submitted form data.


	== ShipPortal ==		== ShipPortal ==
-	The 'ShipPortal' interface enables a script to be used as a ship portal.	+	The {{code\|ShipPortal}} interface enables a script to be used as a ship portal.
	Ship portals can be installed on a ship.		Ship portals can be installed on a ship.
	Anyone with a ship in the same sector can enter the ship's portal, and they will see the HTML output generated by the script.		Anyone with a ship in the same sector can enter the ship's portal, and they will see the HTML output generated by the script.
Line 27:		Line 27:

	The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.		The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.
-	It also seems to include everything the 'Web' interface provides.	+	It also seems to include everything the {{code\|Web}} interface provides.
-	However, it is recommended to also include the 'Web' interface whenever you include this interface.	+	However, it is recommended to also include the {{code\|Web}} interface whenever you include this interface.

	=== Registered variables ===		=== Registered variables ===
-	; MyShip As CMyShip	+	; {{code\|MyShip As CMyShip}}
	: This is the ship the portal is running on.		: This is the ship the portal is running on.
-	; GuestShip As CShip	+	; {{code\|GuestShip As CShip}}
	: This is the ship that the guest entered the portal from.		: This is the ship that the guest entered the portal from.
-	; GuestUser As CUser	+	; {{code\|GuestUser As CUser}}
	: The user who entered the portal.		: The user who entered the portal.


-		+	== ColoniePortal ==
-	== ~~ColonyPortal~~ ==	+	The {{code\|ColoniePortal}} interface enables a script to be used as a ship portal.
-	The ~~'ColonyPortal'~~ interface enables a script to be used as a ship portal.	+
	Colony portals can be installed on a ship.		Colony portals can be installed on a ship.
	Anyone with a ship in the same sector can enter the colony's portal, and they will see the HTML output generated by the script.		Anyone with a ship in the same sector can enter the colony's portal, and they will see the HTML output generated by the script.
	By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted.		By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted.
-	See the 'Web' interface on details how to generate output.	+	See the {{code\|Web}} interface on details how to generate output.

	The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.		The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.
-	It also seems to include everything the 'Web' interface provides.	+	It also seems to include everything the {{code\|Web}} interface provides.
-	However, it is recommended to also include the 'Web' interface whenever you include this interface.	+	However, it is recommended to also include the {{code\|Web}} interface whenever you include this interface.

	=== Registered variables ===		=== Registered variables ===
-	; MyColony As CMyColony	+	; {{code\|MyColony As CMyColony}}
	: This is the colony the portal is running on.		: This is the colony the portal is running on.
-	; GuestShip As CShip	+	; {{code\|GuestShip As CShip}}
	: This is the ship that the guest entered the portal from.		: This is the ship that the guest entered the portal from.
-	; GuestUser As CUser	+	; {{code\|GuestUser As CUser}}
	: The user who entered the portal.		: The user who entered the portal.

Glest Durnham at 01:03, 16 August 2010

2010-08-16T01:03:11Z

← Older revision		Revision as of 01:03, 16 August 2010
Line 33:		Line 33:
	; MyShip As CMyShip		; MyShip As CMyShip
	: This is the ship the portal is running on.		: This is the ship the portal is running on.
-	; GuestShip	+	; GuestShip As CShip
	: This is the ship that the guest entered the portal from.		: This is the ship that the guest entered the portal from.
	; GuestUser As CUser		; GuestUser As CUser
Line 54:		Line 54:
	; MyColony As CMyColony		; MyColony As CMyColony
	: This is the colony the portal is running on.		: This is the colony the portal is running on.
-	; GuestShip	+	; GuestShip As CShip
	: This is the ship that the guest entered the portal from.		: This is the ship that the guest entered the portal from.
	; GuestUser As CUser		; GuestUser As CUser
	: The user who entered the portal.		: The user who entered the portal.

Glest Durnham at 01:31, 15 August 2010

2010-08-15T01:31:15Z

← Older revision		Revision as of 01:31, 15 August 2010
Line 1:		Line 1:
-	[[Category:Scripting]]	+	[[Category:Scripting\|Interfaces]]
	Interfaces extend the possibilities of scripts by registering pre-defined variables.		Interfaces extend the possibilities of scripts by registering pre-defined variables.
	For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'		For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'

Glest Durnham at 01:29, 15 August 2010

2010-08-15T01:29:58Z

← Older revision		Revision as of 01:29, 15 August 2010
Line 1:		Line 1:
		+	[[Category:Scripting]]
	Interfaces extend the possibilities of scripts by registering pre-defined variables.		Interfaces extend the possibilities of scripts by registering pre-defined variables.
	For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'		For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'

Glest Durnham at 00:49, 15 August 2010

2010-08-15T00:49:59Z

← Older revision		Revision as of 00:49, 15 August 2010
Line 1:		Line 1:
-	Interfaces extend the possibilities of scripts by registering pre-defined variables. For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'. Using this interface, scripts can generate HTML output and get some information about the HTTP request.	+	Interfaces extend the possibilities of scripts by registering pre-defined variables.
		+	For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'
		+	Using this interface, scripts can generate HTML output and get some information about the HTTP request.

-	You can use an interface in a script by going to the settings tab in the script editor and ticking the interfaces you want to use. You can also do it manually by adding this code at the top of the script:	+	You can use an interface in a script by going to the settings tab in the script editor and ticking the interfaces you want to use.
		+	You can also do it manually by adding this code at the top of the script:
	#UseInterface Web, ShipPortal // a comma separated list of interfaces		#UseInterface Web, ShipPortal // a comma separated list of interfaces


	== Web ==		== Web ==
-	The 'Web' interface provides ~~the~~ script with the ability to generate HTML output and to read information about the HTTP request.	+	The 'Web' interface provides a script with the ability to generate HTML output and to read some information about the HTTP request.

	=== Registered variables ===		=== Registered variables ===
	; Response As CWebResponse		; Response As CWebResponse
-	: This represents the root element for your script's HTML response. By adding elements to Response ~~you~~ generate HTML output.	+	: This represents the root element for your script's HTML response. By adding elements to Response, the script can generate HTML output.
	; Request As CWebRequest		; Request As CWebRequest
-	: This contains some data describing the HTTP request. Most notably, it contains the submitted form data.	+	: This contains some data describing the HTTP request and some additional data added by STNE. Most notably, it contains the submitted form data.


	== ShipPortal ==		== ShipPortal ==
-	The 'ShipPortal' interface ~~provides~~ a ~~few variables exposing~~ on ~~which~~ ship the portal ~~is running~~, and the ~~user and ship that entered~~ the ~~portal~~. ~~It seems~~ to ~~include everything~~ the ~~'Web' interface provides. However, it is recommended to~~ also ~~include~~ the 'Web' interface ~~whenever you include this interface~~.	+	The 'ShipPortal' interface enables a script to be used as a ship portal.
		+	Ship portals can be installed on a ship.
		+	Anyone with a ship in the same sector can enter the ship's portal, and they will see the HTML output generated by the script.
		+	By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted.
		+	See the 'Web' interface on details how to generate output.

-	~~Ship portals can be installed on~~ a ship~~. Anyone with a ship in the same sector can enter~~ the ~~ships~~ portal, and ~~they will see~~ the ~~HTML output generated by~~ the ~~script~~. ~~By adding forms to the output you can~~ also ~~have the guest enter data which will be available~~ to the ~~script when the form is submitted~~. ~~See~~ the 'Web' interface ~~on details how to generate output~~.	+	The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.
		+	It also seems to include everything the 'Web' interface provides.
		+	However, it is recommended to also include the 'Web' interface whenever you include this interface.

	=== Registered variables ===		=== Registered variables ===
Line 31:		Line 40:

	== ColonyPortal ==		== ColonyPortal ==
-	The 'ColonyPortal ' interface ~~provides~~ a ~~few variables exposing~~ on ~~which colony~~ the portal ~~is running~~, and the ~~user and ship that entered~~ the ~~portal~~. ~~It seems~~ to ~~include everything~~ the ~~'Web' interface provides. However, it is recommended to~~ also ~~include~~ the 'Web' interface ~~whenever you include this interface~~.	+	The 'ColonyPortal' interface enables a script to be used as a ship portal.
		+	Colony portals can be installed on a ship.
		+	Anyone with a ship in the same sector can enter the colony's portal, and they will see the HTML output generated by the script.
		+	By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted.
		+	See the 'Web' interface on details how to generate output.

-	~~Colony portals can be installed on a colony. Anyone with~~ a ship ~~in the same sector can enter~~ the ~~colonies~~ portal, and ~~they will see~~ the ~~HTML output generated by~~ the ~~script~~. ~~By adding forms to the output you can~~ also ~~have the guest enter data which will be available~~ to the ~~script when the form is submitted~~. ~~See~~ the 'Web' interface ~~on details how to generate output~~.	+	The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.
		+	It also seems to include everything the 'Web' interface provides.
		+	However, it is recommended to also include the 'Web' interface whenever you include this interface.

	=== Registered variables ===		=== Registered variables ===

Glest Durnham at 23:57, 14 August 2010

2010-08-14T23:57:52Z

← Older revision		Revision as of 23:57, 14 August 2010
Line 5:		Line 5:


-	= Web =	+	== Web ==
	The 'Web' interface provides the script with the ability to generate HTML output and to read information about the HTTP request.		The 'Web' interface provides the script with the ability to generate HTML output and to read information about the HTTP request.
-

	=== Registered variables ===		=== Registered variables ===
Line 16:		Line 15:


-	= ShipPortal =	+	== ShipPortal ==
	The 'ShipPortal' interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal. It seems to include everything the 'Web' interface provides. However, it is recommended to also include the 'Web' interface whenever you include this interface.		The 'ShipPortal' interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal. It seems to include everything the 'Web' interface provides. However, it is recommended to also include the 'Web' interface whenever you include this interface.

	Ship portals can be installed on a ship. Anyone with a ship in the same sector can enter the ships portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.		Ship portals can be installed on a ship. Anyone with a ship in the same sector can enter the ships portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.
-

	=== Registered variables ===		=== Registered variables ===
Line 32:		Line 30:


-	= ColonyPortal =	+	== ColonyPortal ==
	The 'ColonyPortal ' interface provides a few variables exposing on which colony the portal is running, and the user and ship that entered the portal. It seems to include everything the 'Web' interface provides. However, it is recommended to also include the 'Web' interface whenever you include this interface.		The 'ColonyPortal ' interface provides a few variables exposing on which colony the portal is running, and the user and ship that entered the portal. It seems to include everything the 'Web' interface provides. However, it is recommended to also include the 'Web' interface whenever you include this interface.

	Colony portals can be installed on a colony. Anyone with a ship in the same sector can enter the colonies portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.		Colony portals can be installed on a colony. Anyone with a ship in the same sector can enter the colonies portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.
-

	=== Registered variables ===		=== Registered variables ===

Glest Durnham at 23:51, 14 August 2010

2010-08-14T23:51:38Z

← Older revision		Revision as of 23:51, 14 August 2010
Line 8:		Line 8:
	The 'Web' interface provides the script with the ability to generate HTML output and to read information about the HTTP request.		The 'Web' interface provides the script with the ability to generate HTML output and to read information about the HTTP request.

-	~~'''~~Registered variables~~'''~~	+
		+	=== Registered variables ===
	; Response As CWebResponse		; Response As CWebResponse
	: This represents the root element for your script's HTML response. By adding elements to Response you generate HTML output.		: This represents the root element for your script's HTML response. By adding elements to Response you generate HTML output.
Line 20:		Line 21:
	Ship portals can be installed on a ship. Anyone with a ship in the same sector can enter the ships portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.		Ship portals can be installed on a ship. Anyone with a ship in the same sector can enter the ships portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.

-	~~'''~~Registered variables~~'''~~	+
		+	=== Registered variables ===
	; MyShip As CMyShip		; MyShip As CMyShip
	: This is the ship the portal is running on.		: This is the ship the portal is running on.
Line 35:		Line 37:
	Colony portals can be installed on a colony. Anyone with a ship in the same sector can enter the colonies portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.		Colony portals can be installed on a colony. Anyone with a ship in the same sector can enter the colonies portal, and they will see the HTML output generated by the script. By adding forms to the output you can also have the guest enter data which will be available to the script when the form is submitted. See the 'Web' interface on details how to generate output.

-	~~'''~~Registered variables~~'''~~	+
		+	=== Registered variables ===
	; MyColony As CMyColony		; MyColony As CMyColony
	: This is the colony the portal is running on.		: This is the colony the portal is running on.

Glest Durnham at 23:50, 14 August 2010

2010-08-14T23:50:17Z

← Older revision		Revision as of 23:50, 14 August 2010
Line 1:		Line 1:
-	Interfaces extend the possibilities of scripts by registering pre-defined variables. For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'. Using this interface, scripts can generate HTML output and get some information about the HTTP request.	+	Interfaces extend the possibilities of scripts by registering pre-defined variables. For example, the 'Web' interface provides the variables 'Response As CWebResponse' and 'Request As CWebRequest'. Using this interface, scripts can generate HTML output and get some information about the HTTP request.
		+
		+	You can use an interface in a script by going to the settings tab in the script editor and ticking the interfaces you want to use. You can also do it manually by adding this code at the top of the script:
		+	#UseInterface Web, ShipPortal // a comma separated list of interfaces
		+

	= Web =		= Web =