Scripting:Interfaces

From STNE Wiki

(Difference between revisions)
Jump to: navigation, search
(→ColoniePortal)
 
(8 intermediate revisions not shown)
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.
+
[[Category:Scripting]]
 +
{{ScriptingMenu}}
-
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:
+
Interfaces extend the possibilities of scripts by registering pre-defined variables.
-
  #UseInterface Web, ShipPortal  // a comma separated list of interfaces
+
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.
 +
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 =
 
-
The 'Web' interface provides the script with the ability to generate HTML output and to read information about the HTTP request.
 
-
'''Registered variables'''
+
== Web ==
-
; Response As CWebResponse
+
The {{code|Web}} interface provides a script with the ability to generate HTML output and to read some information about the HTTP request.  
-
: This represents the root element for your script's HTML response. By adding elements to Response you generate HTML output.
+
-
; Request As CWebRequest
+
-
: This contains some data describing the HTTP request. Most notably, it contains the submitted form data.
+
 +
=== Registered variables ===
 +
; {{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.
 +
; {{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.
-
= 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.
 
-
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.
+
== ShipPortal ==
 +
The {{code|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.
-
'''Registered variables'''
+
The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.
-
; MyShip As CMyShip
+
It also seems to include everything the {{code|Web}} interface provides.
 +
However, it is recommended to also include the {{code|Web}} interface whenever you include this interface.
 +
 
 +
=== Registered variables ===
 +
; {{code|MyShip As CMyShip}}
: This is the ship the portal is running on.
: This is the ship the portal is running on.
-
; GuestShip
+
; {{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 ==
 +
The {{code|ColoniePortal}} interface enables a script to be used as a colony portal.
 +
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.
 +
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 {{code|Web}} interface on details how to generate output.
-
= ColonyPortal =
+
The interface provides a few variables exposing on which ship the portal is running, and the user and ship that entered the portal.
-
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.
+
It also seems to include everything the {{code|Web}} interface provides.
-
 
+
However, it is recommended to also include the {{code|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.
+
-
'''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
+
; {{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.

Latest revision as of 10:34, 11 September 2010


Main | Syntax | Operators | Interfaces | FAQ | Contents | API Reference | Index


Interfaces extend the possibilities of scripts by registering pre-defined variables. For example, the 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.

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


Contents

Web

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

Registered variables

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.
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.


ShipPortal

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.

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

MyShip As CMyShip
This is the ship the portal is running on.
GuestShip As CShip
This is the ship that the guest entered the portal from.
GuestUser As CUser
The user who entered the portal.


ColoniePortal

The ColoniePortal interface enables a script to be used as a colony portal. 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. 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

MyColony As CMyColony
This is the colony the portal is running on.
GuestShip As CShip
This is the ship that the guest entered the portal from.
GuestUser As CUser
The user who entered the portal.
Retrieved from "http://wiki.en.stne.net/index.php/Scripting:Interfaces"
Personal tools