onScriptLoad

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function is called when a Squirrel script is loaded automatically by the server on startup, via manual console input or using the function LoadScript. This event is only called in the script which was loaded.

Syntax

function onScriptLoad()

Arguments

• none

Returns

This event does not handle return values.

Example

This example will print the name of the loaded script to the server console.

 
function onScriptLoad()
{
     print( "Loaded LU Test Script" );
     
     return 1;
}
 

Notes

The function print was used in this example. More info about this in the corresponding page.

Related Events

• onConsoleInput
• onScriptLoad
• onScriptUnload
• onServerStart