Tomb Raider Mod Launcher Wiki - User contributions [en]

Server Changes

2015-01-06T08:25:51Z

Jack9267:

This page documents any notable changes to new versions of the server.

It may miss out some bug fixes and some changes may not be tracked.

== 0.2.8 ==

* Fixed a bug that caused players to stay on fire when respawning.
* The "engine" element in the server.xml is now deprecated, you must now use the "game" element.

== 0.2.7 ==

* Resources must now specify a type in the file element. Valid values are "http" or "client".
* Added URL decoding for query string parsing.
* '''Basic''' client-side files support.

=== Scripting Functions Added ===

[[Engine.PreventDefault]]

Client Changes

2015-01-06T08:23:31Z

Jack9267:

This page documents any notable changes to new versions of the client.

It may miss out some bug fixes and some changes may not be tracked.

== 0.2.8 ==

* Fixed a bug that caused players to stay on fire when respawning.

=== Scripting Functions Added ===

[[Engine.DrawRectangle]]

== 0.2.7 ==

* Fixed a '''crash''' when loading any type 2 maps. This affected some maps in all versions of Tomb Raider IV. The maps affected were ones such as "Angkor Wat" or the "Tomb of Seth".
* Added URL decoding for query string parsing.
* '''Basic''' client-side files support.

=== Scripting Functions Added ===

[[Engine.PreventDefault]]

Client Scripting Functions

2015-01-02T03:15:21Z

Jack9267:

== Classes ==

[[Engine.AudioInstance]]

== Resource functions ==

[[Engine.GetThisResource]]

[[Engine.GetResourceName]]

[[Engine.IsResourceReady]]

== TR functions ==

[[Engine.TR.GetScreenWidth]]

[[Engine.TR.GetScreenHeight]]

[[Engine.TR.GetFontHeight]]

[[Engine.TR.RenderProgressBar]]

[[Engine.TR.RenderString]]

[[Engine.TR.ChangeLevel]]

[[Engine.TR.FlipEffect]]

== Client functions ==

[[Engine.GetPlayingAudioInstances]]

[[Engine.SetFPSLimit]]

[[Engine.OutputChatBox]]

== Event functions ==

[[Engine.AddEventHandler]]

[[Engine.PreventDefault]]

[[Engine.TriggerServerEvent]]

== Command functions ==

[[Engine.AddCommandHandler]]

Client Scripting Functions

2015-01-02T03:12:54Z

Jack9267: Created page with "== Resource functions == Engine.GetThisResource Engine.GetResourceName Engine.IsResourceReady == Event functions == Engine.AddEventHandler Engine.Preve..."

== Resource functions ==

[[Engine.GetThisResource]]

[[Engine.GetResourceName]]

[[Engine.IsResourceReady]]

== Event functions ==

[[Engine.AddEventHandler]]

[[Engine.PreventDefault]]

[[Engine.TriggerServerEvent]]

Server Scripting Functions

2015-01-02T03:12:52Z

Jack9267:

== Resource functions ==

[[Engine.GetThisResource]]

[[Engine.GetResourceName]]

[[Engine.StartResource]]

[[Engine.StopResource]]

[[Engine.RestartResource]]

[[Engine.UpdateResources]]

== Player functions ==

[[Engine.GetPlayers]]

[[Engine.SpawnPlayer]]

[[Engine.GetPlayerName]]

[[Engine.SetPlayerRoom]]

[[Engine.GetPlayerRoom]]

[[Engine.SetPlayerPosition]]

[[Engine.GetPlayerPosition]]

[[Engine.SetPlayerHealth]]

[[Engine.GetPlayerHealth]]

[[Engine.ResetPlayerCamera]]

== Server functions ==

[[Engine.SetPassword]]

[[Engine.ShutdownServer]]

[[Engine.OutputChatBox]]

== Event functions ==

[[Engine.AddEventHandler]]

[[Engine.PreventDefault]]

[[Engine.TriggerClientEvent]]

== Command functions ==

[[Engine.AddCommandHandler]]

Client Changes

2015-01-02T03:10:59Z

Jack9267:

This page documents any notable changes to new versions of the client.

It may miss out some bug fixes and some changes may not be tracked.

== 0.2.7 ==

=== Scripting Functions Added ===

[[Engine.PreventDefault]]

=== Map Loading ===

Fixed a '''crash''' when loading any type 2 maps. This affected some maps in all versions of Tomb Raider IV. The maps affected were ones such as "Angkor Wat" or the "Tomb of Seth".

=== Core Changes ===

Added URL decoding for query string parsing.

'''Basic''' client-side files support.

Main Page

2014-12-26T00:34:36Z

Jack9267:

Welcome to the Tomb Raider Mod Launcher Wiki.

== Getting started ==
* [[Resources]]

* [[Client Manual]]

* [[Server Manual]]

== Changes ==
* [[Client Changes]]

* [[Server Changes]]

Server Changes

2014-12-26T00:34:18Z

Jack9267:

This page documents any notable changes to new versions of the server.

It may miss out some bug fixes and some changes may not be tracked.

== 0.2.7 ==

=== Scripting Functions Added ===

[[Engine.PreventDefault]]

=== Resources ===

Resources must now specify a type in the file element. Valid values are "http" or "client".

=== Core Changes ===

Added URL decoding for query string parsing.

'''Basic''' client-side files support.

Client Changes

2014-12-26T00:34:03Z

Jack9267:

Client Changes

2014-12-26T00:33:33Z

Jack9267: Created page with "This page documents any notable changes to new versions of the client. It may miss out some bug fixes and some changes may not be tracked. == 0.2.7 == === Scripting Functio..."

Server Changes

2014-12-26T00:32:40Z

Jack9267:

Server Changes

2014-12-26T00:32:08Z

Jack9267:

Server Changes

2014-12-26T00:30:20Z

Jack9267:

Server Changes

2014-12-26T00:28:52Z

Jack9267: Created page with "== 0.2.7 == === Scripting Functions Added === Engine.PreventDefault === Core Changes === Added URL decoding for query string parsing."

== 0.2.7 ==

=== Scripting Functions Added ===

[[Engine.PreventDefault]]

=== Core Changes ===

Added URL decoding for query string parsing.

Main Page

2014-12-26T00:27:05Z

Jack9267:

Welcome to the Tomb Raider Mod Launcher Wiki.

== Getting started ==
* [[Resources]]

* [[Client Manual]]

* [[Server Manual]]

== Changes ==
* [[Server Changes]]

Main Page

2014-12-26T00:26:53Z

Jack9267:

Welcome to the Tomb Raider Mod Launcher Wiki.

== Getting started ==
* [[Resources]]

* [[Client Manual]]

* [[Server Manual]]

== Changes ==
* [[Server]]

Engine.PreventDefault

2014-12-25T23:00:32Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function bool Engine.PreventDefault(); </syntaxhighlight> === Description === This function prevents the default handling..."

== Function ==

<syntaxhighlight lang="javascript">
function bool Engine.PreventDefault();
</syntaxhighlight>

=== Description ===

This function prevents the default handling of an event (only if the event supports this functionality).

=== Returns ===

The function returns '''true''' if the event was successfully cancelled, '''false''' otherwise.

=== Example ===

<syntaxhighlight lang="javascript">

// Prevent chat.
//
Engine.AddEventHandler("OnPlayerChat",function(player,message){
Engine.PreventDefault();
});

</syntaxhighlight>

== Notes ==

This function should '''only''' be called from within an '''event handler callback'''.

Server Scripting Functions

2014-12-25T22:57:43Z

Jack9267:

== Resource functions ==

[[Engine.StartResource]]

[[Engine.StopResource]]

[[Engine.RestartResource]]

[[Engine.UpdateResources]]

== Player functions ==

[[Engine.GetPlayers]]

[[Engine.SpawnPlayer]]

[[Engine.GetPlayerName]]

[[Engine.SetPlayerRoom]]

[[Engine.GetPlayerRoom]]

[[Engine.SetPlayerPosition]]

[[Engine.GetPlayerPosition]]

[[Engine.SetPlayerHealth]]

[[Engine.GetPlayerHealth]]

[[Engine.ResetPlayerCamera]]

== Server functions ==

[[Engine.SetPassword]]

[[Engine.ShutdownServer]]

[[Engine.OutputChatBox]]

== Event functions ==

[[Engine.AddEventHandler]]

[[Engine.PreventDefault]]

== Command functions ==

[[Engine.AddCommandHandler]]

Engine.ShutdownServer

2014-08-22T15:27:43Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function Engine.ShutdownServer(); </syntaxhighlight> === Description === This function will cause the server to close whe..."

== Function ==

<syntaxhighlight lang="javascript">
function Engine.ShutdownServer();
</syntaxhighlight>

=== Description ===

This function will cause the server to close when it is safe.

=== Example ===

<syntaxhighlight lang="javascript">

// Close the server.
//
Engine.ShutdownServer();
</syntaxhighlight>

== Notes ==

* This will cause everyone to be disconnected from the game.

Server Scripting Functions

2014-08-22T15:23:36Z

Jack9267:

== Resource functions ==

[[Engine.StartResource]]

[[Engine.StopResource]]

[[Engine.RestartResource]]

[[Engine.UpdateResources]]

== Player functions ==

[[Engine.GetPlayers]]

[[Engine.SpawnPlayer]]

[[Engine.GetPlayerName]]

[[Engine.SetPlayerRoom]]

[[Engine.GetPlayerRoom]]

[[Engine.SetPlayerPosition]]

[[Engine.GetPlayerPosition]]

[[Engine.SetPlayerHealth]]

[[Engine.GetPlayerHealth]]

[[Engine.ResetPlayerCamera]]

== Server functions ==

[[Engine.SetPassword]]

[[Engine.ShutdownServer]]

[[Engine.OutputChatBox]]

== Event functions ==

[[Engine.AddEventHandler]]

== Command functions ==

[[Engine.AddCommandHandler]]

Engine.SetPassword

2014-08-22T15:18:22Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function Engine.SetPassword(newPassword); </syntaxhighlight> === Arguments === * newPassword ** The new password for the..."

== Function ==

<syntaxhighlight lang="javascript">
function Engine.SetPassword(newPassword);
</syntaxhighlight>

=== Arguments ===

* newPassword
** The new password for the server.

=== Description ===

This function will change the password for the server.

=== Example ===

<syntaxhighlight lang="javascript">

// Force the password to hello.
//
Engine.SetPassword("hello");
</syntaxhighlight>

== Notes ==

* This function will not save the password to the configuration file and it is only temporary.

* When the server is restarted the password from the configuration file is used.

Server Scripting Functions

2014-08-22T15:16:36Z

Jack9267:

== Resource functions ==

[[Engine.StartResource]]

[[Engine.StopResource]]

[[Engine.RestartResource]]

[[Engine.UpdateResources]]

== Player functions ==

[[Engine.GetPlayers]]

[[Engine.SpawnPlayer]]

[[Engine.GetPlayerName]]

[[Engine.SetPlayerRoom]]

[[Engine.GetPlayerRoom]]

[[Engine.SetPlayerPosition]]

[[Engine.GetPlayerPosition]]

[[Engine.SetPlayerHealth]]

[[Engine.GetPlayerHealth]]

[[Engine.ResetPlayerCamera]]

== Server functions ==

[[Engine.SetPassword]]

[[Engine.OutputChatBox]]

== Event functions ==

[[Engine.AddEventHandler]]

== Command functions ==

[[Engine.AddCommandHandler]]

Server Scripting Functions

2014-08-20T18:28:33Z

Jack9267:

== Resource functions ==

[[Engine.StartResource]]

[[Engine.StopResource]]

[[Engine.RestartResource]]

[[Engine.UpdateResources]]

== Player functions ==

[[Engine.GetPlayers]]

[[Engine.SpawnPlayer]]

[[Engine.GetPlayerName]]

[[Engine.SetPlayerRoom]]

[[Engine.GetPlayerRoom]]

[[Engine.SetPlayerPosition]]

[[Engine.GetPlayerPosition]]

[[Engine.SetPlayerHealth]]

[[Engine.GetPlayerHealth]]

[[Engine.ResetPlayerCamera]]

== Server functions ==

[[Engine.OutputChatBox]]

== Event functions ==

[[Engine.AddEventHandler]]

== Command functions ==

[[Engine.AddCommandHandler]]

Main Page

2014-08-18T19:41:27Z

Jack9267:

Welcome to the Tomb Raider Mod Launcher Wiki.

== Getting started ==
* [[Resources]]

* [[Client Manual]]

* [[Server Manual]]

MediaWiki:Sidebar

2014-08-18T19:40:10Z

Jack9267:

Server Manual

2014-08-16T18:39:41Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

If the file doesn't exist you will need to create it, be sure to name it "server.xml" without the quotes.

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<gamemode>Free Roam</gamemode>


<serverbrowser>ENABLED</serverbrowser>


<maxplayers>128</maxplayers>


<port>22000</port>


<httpport>22000</httpport>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<logpath>logs</logpath>


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The UDP port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

The TCP port that you need to allow for the server is in the httpport field. This port is required to download any files the server provides to the client and for any HTTP capabilities.

<syntaxhighlight lang="xml">

<httpport>22000</httpport>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Server Manual

2014-08-16T02:53:09Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

If the file doesn't exist you will need to create it, be sure to name it "server.xml" without the quotes.

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<gamemode>Free Roam</gamemode>


<serverbrowser>ENABLED</serverbrowser>


<maxplayers>128</maxplayers>


<port>22000</port>


<httpport>22000</httpport>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The UDP port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

The TCP port that you need to allow for the server is in the httpport field. This port is required to download any files the server provides to the client and for any HTTP capabilities.

<syntaxhighlight lang="xml">

<httpport>22000</httpport>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Server Manual

2014-08-16T02:44:19Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

If the file doesn't exist you will need to create it, be sure to name it "server.xml" without the quotes.

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<maxplayers>128</maxplayers>


<port>22000</port>


<httpport>22000</httpport>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The UDP port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

The TCP port that you need to allow for the server is in the httpport field. This port is required to download any files the server provides to the client and for any HTTP capabilities.

<syntaxhighlight lang="xml">

<httpport>22000</httpport>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Engine.OutputChatBox

2014-08-15T20:11:12Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function Engine.OutputChatBox(message[, specificPlayer = null]); </syntaxhighlight> === Arguments === * message ** The me..."

== Function ==

<syntaxhighlight lang="javascript">
function Engine.OutputChatBox(message[, specificPlayer = null]);
</syntaxhighlight>

=== Arguments ===

* message
** The message to output.

=== Optional Arguments ===

* specificPlayer
** The player to show the message to, not specifying this argument makes the message output to everyone.

=== Description ===

This function will output the message specified to the chatbox.

=== Example ===

<syntaxhighlight lang="javascript">

// Output: "Hello world!" to everyone.
//
Engine.OutputChatBox("Hello world!");

// Output: "Hello" to the player using the command "hello".
//
Engine.AddCommandHandler("hello",function(player, commandLine, command, arguments){
Engine.OutputChatBox("Hello",player);
});
</syntaxhighlight>

== Notes ==

* If you don't specify the second argument the message is outputted to every player that is online.

* Any message outputted will appear in the server logs even if its only to one player.

Engine.AddEventHandler

2014-08-15T20:04:53Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function bool Engine.AddEventHandler(eventName, handler); </syntaxhighlight> === Arguments === * eventName ** The name of..."

== Function ==

<syntaxhighlight lang="javascript">
function bool Engine.AddEventHandler(eventName, handler);
</syntaxhighlight>

=== Arguments ===

* eventName
** The name of the event to listen for. See [[Server Scripting Events]] for some events you can listen for.

* handler
** The function to call when the event happens.

=== Description ===

This function will add a handler for the event you specify.

=== Returns ===

The function returns '''true''' if the handler was successfully added, '''false''' otherwise.

=== Example ===

<syntaxhighlight lang="javascript">

// Add a handler for when a player joins the server to give them a nice greeting.
//
Engine.AddEventHandler("OnPlayerJoin",function(player){
Engine.OutputChatBox("Hello " + Engine.GetPlayerName(player) + ", thanks for joining!",player);
});

</syntaxhighlight>

== Notes ==

Take care with event names as they could be case sensitive in future versions, currently as of 0.1.3 event names are not case sensitive. This could change in the future.

Engine.GetPlayers

2014-08-15T19:56:57Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function array Engine.GetPlayers(); </syntaxhighlight> === Description === This function retrieves all the players that a..."

== Function ==

<syntaxhighlight lang="javascript">
function array Engine.GetPlayers();
</syntaxhighlight>

=== Description ===

This function retrieves all the players that are currently on the server.

=== Returns ===

The function returns if the server was able to start the resource, possible reasons could include scripts containing errors.

=== Example ===

<syntaxhighlight lang="javascript">

// Add a handler for "online" so that the server will output who is online currently.
//
Engine.AddCommandHandler("online",function(player, commandLine, command, arguments){
local players = Engine.GetPlayers(); // Get the players that are online
foreach (k,v in players) // Loop through all the players...
{
Engine.OutputChatBox(Engine.GetPlayerName(v),player); // Output their name!
}
});

</syntaxhighlight>

== Notes ==

If nobody is online the array is empty.

Server Scripting Events

2014-08-12T11:59:04Z

Jack9267:

== Player events ==

[[OnPlayerConnect]]

[[OnPlayerJoin]]

[[OnPlayrQuit]]

[[OnPlayerChat]]

== Server events ==

[[OnProcess]]

Engine.StartResource

2014-08-12T07:00:32Z

Jack9267:

== Function ==

<syntaxhighlight lang="javascript">
function bool Engine.StartResource(resourceName);
</syntaxhighlight>

=== Arguments ===

* resourceName
** The name of the resource to start.

=== Description ===

This function will attempt to start the resource.

=== Returns ===

The function returns if the server was able to start the resource, possible reasons could include scripts containing errors.

=== Example ===

<syntaxhighlight lang="javascript">

// Add a handler for "start" to that we can start a resource using the chatbox.
// It would be a good idea to check if the user is allowed to do so when possible.
// It would also be a good idea to check the number of arguments in the array to prevent errors.
//
Engine.AddCommandHandler("start",function(player, commandLine, command, arguments){
Engine.StartResource(arguments[0]);
});

</syntaxhighlight>

== Notes ==

If the resource doesn't exist then an error is thrown.

Engine.StopResource

2014-08-12T07:00:08Z

Jack9267:

== Function ==

<syntaxhighlight lang="javascript">
function Engine.StopResource(resourceName);
</syntaxhighlight>

=== Arguments ===

* resourceName
** The name of the resource to stop.

=== Description ===

This function will stop the resource.

=== Returns ===

This function doesn't return any arguments.

=== Example ===

<syntaxhighlight lang="javascript">

// Add a handler for "stop" to that we can stop a resource using the chatbox.
// It would be a good idea to check if the user is allowed to do so when possible.
// It would also be a good idea to check the number of arguments in the array to prevent errors.
//
Engine.AddCommandHandler("stop",function(player, commandLine, command, arguments){
Engine.StopResource(arguments[0]);
});

</syntaxhighlight>

== Notes ==

If the resource doesn't exist then an error is thrown.

Engine.RestartResource

2014-08-12T06:59:35Z

Jack9267:

== Function ==

<syntaxhighlight lang="javascript">
function bool Engine.RestartResource(resourceName);
</syntaxhighlight>

=== Arguments ===

* resourceName
** The name of the resource to restart.

=== Description ===

This function will attempt to restart the resource.

=== Returns ===

If the resource is currently stopped the function will return false.

Then the function returns if the server was able to start the resource, possible reasons could include scripts containing errors.

=== Example ===

<syntaxhighlight lang="javascript">

// Add a handler for "restart" to that we can restart a resource using the chatbox.
// It would be a good idea to check if the user is allowed to do so when possible.
// It would also be a good idea to check the number of arguments in the array to prevent errors.
//
Engine.AddCommandHandler("restart",function(player, commandLine, command, arguments){
Engine.RestartResource(arguments[0]);
});

</syntaxhighlight>

== Notes ==

If the resource doesn't exist then an error is thrown.

Engine.UpdateResources

2014-08-12T06:57:43Z

Jack9267:

== Function ==

<syntaxhighlight lang="javascript">
function Engine.UpdateResources();
</syntaxhighlight>

=== Arguments ===

There are no arguments to this function.

=== Description ===

This function will update the resource cache.

=== Returns ===

This function doesn't return any arguments.

=== Example ===

<syntaxhighlight lang="javascript">

// Add a handler for "refresh" to that we can update the resource cache using the chatbox.
// It would be a good idea to check if the user is allowed to do so when possible.
//
Engine.AddCommandHandler("refresh",function(player, commandLine, command, arguments){
Engine.UpdateResources();
});

</syntaxhighlight>

== Notes ==

The resource cache contains a list of all the resources that can be started or stopped. If you modify the resources folder you will need to call this function to update the resource cache accordingly.

Engine.UpdateResources

2014-08-12T06:56:43Z

Jack9267:

== Function ==

<syntaxhighlight lang="javascript">
function Engine.UpdateResources();
</syntaxhighlight>

=== Arguments ===

There are no arguments to this function.

=== Description ===

This function will update the resource cache.

=== Returns ===

This function doesn't return any arguments.

=== Example ===

<syntaxhighlight lang="javascript">

Engine.AddCommandHandler("refresh",function(player, commandLine, command, arguments){
Engine.UpdateResources();
});

</syntaxhighlight>

== Notes ==

The resource cache contains a list of all the resources that can be started or stopped. If you modify the resources folder you will need to call this function to update the resource cache accordingly.

Engine.UpdateResources

2014-08-12T06:56:06Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function Engine.UpdateResources(); </syntaxhighlight> === Arguments === There are no arguments to this function. === Des..."

Engine.RestartResource

2014-08-12T06:54:47Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function bool Engine.RestartResource(resourceName); </syntaxhighlight> === Arguments === * resourceName ** The name of th..."

Engine.StopResource

2014-08-12T06:53:44Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function Engine.StopResource(resourceName); </syntaxhighlight> === Arguments === * resourceName ** The name of the resour..."

Engine.StartResource

2014-08-12T06:52:58Z

Jack9267: Created page with "== Function == <syntaxhighlight lang="javascript"> function bool Engine.StartResource(resourceName); </syntaxhighlight> === Arguments === * resourceName ** The name of the..."

Server Scripting Functions

2014-08-12T06:49:58Z

Jack9267:

== Resource functions ==

[[Engine.StartResource]]

[[Engine.StopResource]]

[[Engine.RestartResource]]

[[Engine.UpdateResources]]

== Player functions ==

[[Engine.GetPlayers]]

[[Engine.SpawnPlayer]]

[[Engine.GetPlayerName]]

[[Engine.SetPlayerRoom]]

[[Engine.GetPlayerRoom]]

[[Engine.SetPlayerPosition]]

[[Engine.GetPlayerPosition]]

[[Engine.SetPlayerHealth]]

[[Engine.GetPlayerHealth]]

== Server functions ==

[[Engine.OutputChatBox]]

== Event functions ==

[[Engine.AddEventHandler]]

== Command functions ==

[[Engine.AddCommandHandler]]

Server Manual

2014-08-09T23:17:16Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

If the file doesn't exist you will need to create it, be sure to name it "server.xml" without the quotes.

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<maxplayers>128</maxplayers>


<port>22000</port>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<laraenemy />


<levelflags />


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Server Manual

2014-08-09T23:16:39Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<maxplayers>128</maxplayers>


<port>22000</port>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<laraenemy />


<levelflags />


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Server Manual

2014-08-09T23:01:47Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<maxplayers>128</maxplayers>


<port>22000</port>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<laraenemy />


<levelflags />


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Server Manual

2014-08-09T13:11:43Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<maxplayers>128</maxplayers>


<port>22000</port>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<laraenemy />


<levelflags />


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Server Manual

2014-08-09T13:11:31Z

Jack9267:

== Setting up the server ==

To set up the server you will need to first download it.

You can download the latest version of the server from our [http://tombraidermodlauncher.co.uk/downloads/ downloads page].

You will need to extract the archive, I recommend that you use [http://www.7-zip.org/download.html 7-Zip].

Once you have extracted the archive you will find it contains the server executable, example resources and the example server.xml configuration file.

== Configuring the server ==

To configure the server you will need to open server.xml in Notepad or [http://notepad-plus-plus.org/ Notepad++].

Once you've got the configuration file open, you should then see the contents of it like below:

<syntaxhighlight lang="xml">
<server>

<servername>Playable Tutorial Level</servername>


<maxplayers>128</maxplayers>


<port>22000</port>


<password></password>


<engine>IV_EDITOR</engine>


<map>1</map>


<larastartpos>0</larastartpos>


<flags>13</flags>


<flycheat>DISABLED</flycheat>


<allowmoddedexecutables>DISABLED</allowmoddedexecutables>


<laraenemy />


<levelflags />


<resources>
<resource src="joinquit" />
<resource src="chat" />
</resources>
</server>
</syntaxhighlight>

All the options have comments on them specifying what they do to the server.

If the option is enabled or disabled you would use ENABLED or DISABLED to toggle the value.

You can specify a command line argument to the server for the configuration file to use, this can be useful for hosting multiple servers and sharing the resources.

== Server port ==

The port that you need to allow for the server is in the port field.

<syntaxhighlight lang="xml">

<port>22000</port>
</syntaxhighlight>

You will need to look into how to allow the port as this various by modem. It is generally refered to as port forwarding.

== Resources ==

The server runs resources which control various aspects of the game and what logic should be processed.

To create a resource you should look into [[Resources]].

To add a resource to the list of resources that are started you simply add an entry for it in the configuration.

See the resources section below for an example:

<syntaxhighlight lang="xml">

<resources>
<resource src="joinquit" />
<resource src="chat" />
<resource src="deathmatch" />
<resource src="deathmessages" />
<resource src="deathpickups" />
</resources>
</syntaxhighlight>

== Starting the server ==

When you have setup your server to however you wish to have it setup you can then double click on "server.exe" and then the server will start.

[[File:Server_Started.png|Server Started]]

Once your server is started you will need to get your [http://ip-lookup.net/ IP address] and note down the port.

The format you need to give people your server address is as follows, "IP:PORT" without the quotes and you will need to replace IP with your [http://ip-lookup.net/ IP address] and the port with the port as defined in the configuration of the server.

Here is an example:

85.150.200.200:22000

Note: This is not a real IP address it is just an example. If you need the default server it is "jack9267.duckdns.org:22000" without the quotes.

Resources

2014-08-09T13:09:36Z

Jack9267:

== What is a resource? ==

A resource is a folder that contains a file to identify information about the resource and the files associated with the resource, such as the script files. The meta file tells the game how to interpret the resource like for example what scripts the server runs and which scripts the client will have to download and run.

A resource is very similar to an executable. You can start or stop resources, you can have more than 1 resource running at the same time. Resources would usually contain a script for game modes or other tasks to help control the server like add commands or manage the server.

The scripting language of the resources is done through the Squirrel programming language.

The server is compiled with support for Squirrel 3.0 you can see the documentation for Squirrel [http://www.squirrel-lang.org/doc/squirrel3.html here].

== Creating a resource ==

To create a resource for the server you would simply create a new folder with the name of the resource.

Once you created the new folder go inside it.

To configure the resource you will need to create a file named "meta.xml" without the quotes and then open it in Notepad or [http://notepad-plus-plus.org/ Notepad++].

Here is an example for the contents of the meta file:

<syntaxhighlight lang="xml">
<meta>
<info author="jack9267" type="script" version="1.0.0" />

<script src="server.nut" type="server" />
</meta>
</syntaxhighlight>

The info element would contain who made the script, the type of script and the version of the script.

You would have a script element for each script file you wish to load.

The type attribute refers to where the script will run, for now you should only specify "server" as client scripts are unsupported.

== Default resources ==

You can checkout the default resources for the server [http://code.google.com/p/trmultiplayerresources/ here].

Engine.SpawnPlayer

2014-08-09T03:17:09Z

Jack9267:

== Overload 1 ==

<syntaxhighlight lang="javascript">
function Engine.SpawnPlayer(player);
</syntaxhighlight>

=== Arguments ===

* player
** The player to spawn.

=== Description ===

This way of spawning the player will maintain where the player currently is. It will however still have implications such as resetting of the inventory.

== Overload 2 ==

<syntaxhighlight lang="javascript">
function Engine.SpawnPlayer(player, room, x, y, z, rotation = 0, startingHealth = 1000);
</syntaxhighlight>

=== Arguments ===

* player
** The player to spawn.
* room
** The room index the player should spawn in.
* x
** The x position to spawn at.
* y
** The y position to spawn at.
* z
** The z position to spawn at.

=== Optional Arguments ===
* rotation
** The rotation to spawn with.
* startingHealth
** The starting health the player will spawn with, 1000 is full health.

=== Description ===

Using this overload will cause the player to be somewhere else. You can also set the rotation and starting health this way.

== Notes ==

Calling Engine.SpawnPlayer with only the player will just respawn the player in the same place.

Calling Engine.SpawnPlayer will create a new player this means that your inventory will be reset.

Engine.SpawnPlayer

2014-08-09T03:09:23Z

Jack9267:

== Function ==

<syntaxhighlight lang="javascript">
function Engine.SpawnPlayer(player);
function Engine.SpawnPlayer(player, room, x, y, z, rotation, startingHealth = 1000);
</syntaxhighlight>

== Arguments ==

* player
** The player to spawn.

== Optional Arguments ==

* room
** The room index the player should spawn in.
* x
** The x position to spawn at.
* y
** The y position to spawn at.
* z
** The z position to spawn at.
* rotation
** The rotation to spawn with.
* startingHealth
** The starting health the player will spawn with, 1000 is full health.

== Notes ==

Calling Engine.SpawnPlayer with only the player will just respawn the player in the same position and rotation.

Calling Engine.SpawnPlayer will create a new player this means that your inventory will be reset.