Script (OpenXcom) - Revision history

Hobbes: Undo revision 126445 by Hobbes (talk)

2026-03-10T14:56:13Z

Undo revision 126445 by Hobbes (talk)

Hobbes: Protected "Script (OpenXcom)" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2026-03-10T14:01:17Z

Protected "Script (OpenXcom)" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 14:01, 10 March 2026
(No difference)

Hobbes: Redirected page to OpenXcom

2026-03-10T14:00:52Z

Redirected page to OpenXcom

Show changes

Buscher at 09:48, 29 July 2025

2025-07-29T09:48:57Z

← Older revision		Revision as of 09:48, 29 July 2025
Line 73:		Line 73:
	The names of script hooks are pre-defined. You can find a complete list of all script hooks in the script API.		The names of script hooks are pre-defined. You can find a complete list of all script hooks in the script API.

	Global Scripts can be replaced when using the same script names (see TEST_SCRIPT_NAME in the example below). Older mods may not have script names which use the new, update, override, delete keywords. Therefore global scripts which are only referenced by a script hook (f. ex. createUnit) and an offset cannot be overwritten, till a script name has been added. Multiple scripts with the same script hook can use the same offset which will then run after another. For local scripts it's sufficient to add script with the same hook to replace the previous one.		Global Scripts can be replaced when using the same script names (see TEST_SCRIPT_NAME in the example below). Older mods may not have script names which use the new, update, override, delete keywords. Therefore global scripts which are only referenced by a script hook (f. ex. createUnit) and an offset cannot be overwritten, till a script name has been added. Multiple scripts with the same script hook can use the same offset which will then run after another. For local scripts it's sufficient to add a script with the same hook to replace the previous one.

	=== Names ===		=== Names ===

Buscher: Clarification on how scripts can be replaced by other mods

2025-07-29T09:46:15Z

Clarification on how scripts can be replaced by other mods

← Older revision		Revision as of 09:46, 29 July 2025
Line 65:		Line 65:
	So while global scripts have to be under the top-level name "extended", local scripts are attached directly to a gameobject.		So while global scripts have to be under the top-level name "extended", local scripts are attached directly to a gameobject.

	Scripts are executed in order of their offsets. So a script with offset 10 will be executed after a script with offset 5~~. <del>When scripts with the same name define the same offset one overrides the other, as with every other value in OXC rulesets.</del> (that's not true, scripts do not override each other)~~. Script offsets cannot be 100 or greater. Up to two decimals can be added. This means that 99.99 is the highest possible value for the offset.		Scripts are executed in order of their offsets. So a script with offset 10 will be executed after a script with offset 5. Script offsets cannot be 100 or greater. Up to two decimals can be added. This means that 99.99 is the highest possible value for the offset. Local scripts run with an effective offset of 0.

	Under the hood, the global scripts will later be "sorted" into the respective local ones. Internally, local scripts always have offset 0. So a global script with offset -1 would run before the local one. Offsets are also a valuable tool make sure two mods and their scripts don't conflict with each other.		Under the hood, the global scripts will later be "sorted" into the respective local ones. Internally, local scripts always have offset 0. So a global script with offset -1 would run before the local one. Offsets are also a valuable tool make sure two mods and their scripts don't conflict with each other.

	While global scripts execute for every gameobject, local ones only run for the gameobjects they are bound to.		While global scripts execute for every gameobject, local ones only run for the gameobjects they are bound to.

	The ~~name~~ of ~~the~~ script is pre-defined. You can find a complete list of all script hooks in the script API.		The names of script hooks are pre-defined. You can find a complete list of all script hooks in the script API.

			Global Scripts can be replaced when using the same script names (see TEST_SCRIPT_NAME in the example below). Older mods may not have script names which use the new, update, override, delete keywords. Therefore global scripts which are only referenced by a script hook (f. ex. createUnit) and an offset cannot be overwritten, till a script name has been added. Multiple scripts with the same script hook can use the same offset which will then run after another. For local scripts it's sufficient to add script with the same hook to replace the previous one.

	=== Names ===		=== Names ===

Sayurime: /* Tags */ Clarify tag defining and tagsFile

2024-01-15T23:42:04Z

Tags: Clarify tag defining and tagsFile

← Older revision		Revision as of 23:42, 15 January 2024
Line 237:		Line 237:
	Currently OXCE only supports integer data types, so the part after the name will currently alway be "int".		Currently OXCE only supports integer data types, so the part after the name will currently alway be "int".
	The data type tells the engine what kind of data is stored there. Integers are just whole numbers (eg. 0, 1, 56 or -3).		The data type tells the engine what kind of data is stored there. Integers are just whole numbers (eg. 0, 1, 56 or -3).

			Tags must be defined in each file where they are used, multiple times if necessary, or with a single [https://openxcom.org/forum/index.php/topic,11102.0.html tagsFile].

	After defining a tag, you can apply it in a ruleset like this:		After defining a tag, you can apply it in a ruleset like this:

NigerianPrince at 00:12, 4 February 2022

2022-02-04T00:12:23Z

← Older revision		Revision as of 00:12, 4 February 2022
Line 3:		Line 3:
	https://raw.githubusercontent.com/ohartenstein23/Yankes-Scripting/master/yankesScript.txt		https://raw.githubusercontent.com/ohartenstein23/Yankes-Scripting/master/yankesScript.txt

	If you just want a quick reference then click ~~here~~.		If you just want a quick reference then click above.

	Scripts for OXCE are able to change the behaviour of the game while it is running.		Scripts for OXCE are able to change the behaviour of the game while it is running.

NigerianPrince at 00:12, 4 February 2022

2022-02-04T00:12:11Z

← Older revision		Revision as of 00:12, 4 February 2022
Line 1:		Line 1:
	== Scripting Basics ==		== Scripting Basics ==

			https://raw.githubusercontent.com/ohartenstein23/Yankes-Scripting/master/yankesScript.txt

			If you just want a quick reference then click here.

	Scripts for OXCE are able to change the behaviour of the game while it is running.		Scripts for OXCE are able to change the behaviour of the game while it is running.
Line 5:		Line 9:
	They are not based on any pre-existing programming language but borrows from assembler syntax.		They are not based on any pre-existing programming language but borrows from assembler syntax.
	The language was created by Yankes, so for any details of the implementation you might want to ask him.		The language was created by Yankes, so for any details of the implementation you might want to ask him.

	~~https://raw.githubusercontent.com/ohartenstein23/Yankes-Scripting/master/yankesScript.txt~~

	~~If you just want a quick reference then click here.~~

	=== Introduction (for non-programmers) ===		=== Introduction (for non-programmers) ===

NigerianPrince at 00:11, 4 February 2022

2022-02-04T00:11:29Z

← Older revision		Revision as of 00:11, 4 February 2022
Line 7:		Line 7:

	https://raw.githubusercontent.com/ohartenstein23/Yankes-Scripting/master/yankesScript.txt		https://raw.githubusercontent.com/ohartenstein23/Yankes-Scripting/master/yankesScript.txt

	If you just want a quick reference then click here.		If you just want a quick reference then click here.

NigerianPrince at 00:11, 4 February 2022

2022-02-04T00:11:16Z

← Older revision		Revision as of 00:11, 4 February 2022
Line 5:		Line 5:
	They are not based on any pre-existing programming language but borrows from assembler syntax.		They are not based on any pre-existing programming language but borrows from assembler syntax.
	The language was created by Yankes, so for any details of the implementation you might want to ask him.		The language was created by Yankes, so for any details of the implementation you might want to ask him.

			https://raw.githubusercontent.com/ohartenstein23/Yankes-Scripting/master/yankesScript.txt
			If you just want a quick reference then click here.

	=== Introduction (for non-programmers) ===		=== Introduction (for non-programmers) ===