TFE Level Script - Revision history

Lucius at 00:24, 15 December 2024

2024-12-15T00:24:50Z

← Older revision		Revision as of 17:24, 14 December 2024
Line 63:		Line 63:

	== API ==		== API ==

			* [[Math Script API]]
			* [[System Script API]]
			* [[Game Script API]]
			* [[Level Script API]]

Lucius at 00:23, 15 December 2024

2024-12-15T00:23:10Z

← Older revision		Revision as of 17:23, 14 December 2024
Line 61:		Line 61:
	}		}
	</pre>		</pre>

			== API ==

Lucius: /* inimal Script Example */

2024-12-15T00:21:45Z

inimal Script Example

← Older revision		Revision as of 17:21, 14 December 2024
Line 8:		Line 8:
	To include a Level Script with your mod, simply create a '''LevelScript.fs''' file and include it in the same ZIP or folder as your GOB file. This is a simple text file that can be edited in Notepad-like applications, such as Notepad++.		To include a Level Script with your mod, simply create a '''LevelScript.fs''' file and include it in the same ZIP or folder as your GOB file. This is a simple text file that can be edited in Notepad-like applications, such as Notepad++.

	== ~~inimal~~ Script Example ==		== Minimal Script Example ==
	<pre>		<pre>
	//////////////////////////////////		//////////////////////////////////

Lucius at 00:21, 15 December 2024

2024-12-15T00:21:15Z

← Older revision		Revision as of 17:21, 14 December 2024
Line 1:		Line 1:
	~~To include a~~ Level ~~Script with your mod, simply create a '''LevelScript.fs''' file and include it in the same ZIP or folder as your GOB file.~~		== Purpose ==
			TFE Level scripts have two major functions:

	~~Minimal~~ script ~~example:~~		* Enable script based level interactivity.
			* Extend INF functionality with new script-based functions using ScriptCall directly from INF.

			== Setup ==
			To include a Level Script with your mod, simply create a '''LevelScript.fs''' file and include it in the same ZIP or folder as your GOB file. This is a simple text file that can be edited in Notepad-like applications, such as Notepad++.

			== inimal Script Example ==
	<pre>		<pre>
	//////////////////////////////////		//////////////////////////////////

Lucius: Created page with "To include a Level Script with your mod, simply create a '''LevelScript.fs''' file and include it in the same ZIP or folder as your GOB file. Minimal script example:

 ////////////////////////////////// // Level Script. //////////////////////////////////  // Level Start! void levelStart(string levelName) { 	// Prints out the levelName and sector count. 	// This is just an example and should be replaced by your own code. 	// **Important** Script state is persistant a..."

2024-12-15T00:13:43Z

Created page with "To include a Level Script with your mod, simply create a '''LevelScript.fs''' file and include it in the same ZIP or folder as your GOB file. Minimal script example: <pre> ////////////////////////////////// // Level Script. ////////////////////////////////// // Level Start! void levelStart(string levelName) { // Prints out the levelName and sector count. // This is just an example and should be replaced by your own code. // **Important** Script state is persistant a..."

New page

To include a Level Script with your mod, simply create a '''LevelScript.fs''' file and include it in the same ZIP or folder as your GOB file.

Minimal script example:
<pre>
//////////////////////////////////
// Level Script.
//////////////////////////////////

// Level Start!
void levelStart(string levelName)
{
// Prints out the levelName and sector count.
// This is just an example and should be replaced by your own code.
// **Important** Script state is persistant across levels, use this function
// to reset any necessary state on level load.
system.print("Start Level {}, Sector Count {}", levelName, level.sectorCount);
}

// This is called once per game update.
void levelUpdate(float dt)
{
// This is called once per **game** update, dt is the delta time in
// seconds since the last game update.
}

// You can write internal helper functions as well.

// Finally, you can write functions called by `ScriptCall` from INF.
// ScriptCall functions can have up to 4 parameters in addition to the final
// parameter which will always be the elevator or trigger ID that called it.
void InfScriptCallExample(int elevID)
{
// Given the elevator ID, get the elevator from `level`. IDs don't change
// during level execution, so elev will remain valid while in the same level.
Elevator elev = level.getElevator(elevID);
// It is possible for a scriptCall function to keep running using 'yield'
// Keep running while the elevator is active, for example.
float prevTime = game.getGameTime();
while (elev.master)
{
// Do stuff while the elevator is active (master is on).
// Use game.getGameTime() to get the current game time to stay synced.
// This is an example of computing a delta time.
float curTime = game.getGameTime();
float dt = curTime - prevTime;
prevTime = curTime;

// Return control to the system. A delay in seconds can be passed in
// to handle timing.
// The script will resume after the yield with the call stack and local
// variables preserved.
yield();
}
}
</pre>