ScriptTypes/TeamMissionTypes - Revision history

MarkJFox: 29 revisions imported

2025-03-31T20:04:06Z

29 revisions imported

← Older revision	Revision as of 22:04, 31 March 2025
(No difference)

en>Crimsonum: Redirect to old, restored page

2023-06-07T10:14:33Z

Redirect to old, restored page

Show changes

en>Crimsonum: Unified spelling

2023-02-17T09:50:15Z

Unified spelling

Show changes

en>Crimsonum: Update on team mission type 0

2023-02-17T09:19:18Z

Update on team mission type 0

← Older revision		Revision as of 11:19, 17 February 2023
Line 14:		Line 14:
	\|style="text-align: center;"\|0		\|style="text-align: center;"\|0
	\|style="text-align: center;"\|Quarry Type#{{fnl\|1}}		\|style="text-align: center;"\|Quarry Type#{{fnl\|1}}
	\|'''Attack ~~Target~~ Type'''		\|'''Attack Quarry Type'''
	This instructs the TeamType to use the task force to approach and attack a target that fits the [[QuarryTypes\|quarry type]] (target category) specified by the second parameter. The target is selected from this category based on distance, [[TechnoTypes\|object type]], and/or [[SpecialThreatValue\|threat posed]]. See [[the Threat System]] and specifically [[TargetDistanceCoefficientDefault]] for more information.		This instructs the TeamType to use the task force to approach and attack a target that fits the [[QuarryTypes\|quarry type]] (target category) specified by the second parameter. The target is selected from this category based on distance, [[TechnoTypes\|object type]], and/or [[SpecialThreatValue\|threat posed]]. See [[the Threat System]] and specifically [[TargetDistanceCoefficientDefault]] for more information.

en>Crimsonum: Update on team mission type 0

2023-02-17T09:17:27Z

Update on team mission type 0

← Older revision		Revision as of 11:17, 17 February 2023
Line 13:		Line 13:
	\|-		\|-
	\|style="text-align: center;"\|0		\|style="text-align: center;"\|0
	\|style="text-align: center;"\|~~Target~~ Type#{{fnl\|1}}		\|style="text-align: center;"\|Quarry Type#{{fnl\|1}}
	\|'''Attack Target Type'''		\|'''Attack Target Type'''
	This instructs the TeamType to use the task force to approach and attack the target specified by the second parameter. These attack missions are inherently self-repeating. For example, when executing team mission {{tt\|0,2}} ("attack ~~structure~~"), the task force will attack the next ~~structure~~ when the current ~~structure~~ being attacked is destroyed and will continue to destroy enemy buildings until there are no more left. When no more ~~target is~~ left to attack, the team mission is complete and the task force moves on to execute its next mission. ~~The~~ completion of this team mission ~~could~~ get cut short in case the task force gets destroyed or runs out of ammo. ~~Check [[TargetDistanceCoefficientDefault]] as it affects the target selection of these team missions.~~ The following are the ~~target types~~ which can be used:		This instructs the TeamType to use the task force to approach and attack a target that fits the [[QuarryTypes\|quarry type]] (target category) specified by the second parameter. The target is selected from this category based on distance, [[TechnoTypes\|object type]], and/or [[SpecialThreatValue\|threat posed]]. See [[the Threat System]] and specifically [[TargetDistanceCoefficientDefault]] for more information.

			These attack missions are inherently self-repeating. For example, when executing team mission {{tt\|0,2}} ("attack building"), the task force will attack the next [[BuildingTypes\|building]] when the current building being attacked is destroyed and will continue to destroy enemy buildings until there are no more left. When no more targets are left to attack, the team mission is complete and the task force moves on to execute its next mission, if any.

			Note that the completion of this team mission can get cut short in case the task force gets destroyed or runs out of ammo.

			The following are the quarry type values which can be used:
	{\|class="wikitable"		{\|class="wikitable"
	!Value		!Value
	!~~Target~~ Type		!Quarry Type
	!Description		!Description
	\|-		\|-

en>Crimsonum: Correction.

2022-09-12T13:55:27Z

Correction.

← Older revision		Revision as of 15:55, 12 September 2022
Line 710:		Line 710:

	{{fn\|1\|For convenience, the "#" symbol refers to a number/index of the object type. For example, "Waypoint#" refers to the index number of the Waypoint in the [[Waypoints]] list}}		{{fn\|1\|For convenience, the "#" symbol refers to a number/index of the object type. For example, "Waypoint#" refers to the index number of the Waypoint in the [[Waypoints]] list}}
	{{fn\|2\|Time to guard area in tenths of a minute (multiples of 6 seconds) at normal game speed.}}		{{fn\|2\|Time to guard area. In {{ts}}, the time is measured in seconds at default game speed (15 FPS). In {{ra2}} and {{yr}}, the time is measured in tenths of a minute (multiples of 6 seconds) at normal game speed.}}
	{{fn\|3\|'''B'''uilding '''w'''ith '''P'''roperty is the computed value of the building's index in [[BuildingTypes]] and the AI's choice for target selection. See the [[#Notes\|notes]] below for more information}}		{{fn\|3\|'''B'''uilding '''w'''ith '''P'''roperty is the computed value of the building's index in [[BuildingTypes]] and the AI's choice for target selection. See the [[#Notes\|notes]] below for more information}}
	{{fn\|4\|Note that the internal "compass" is tilted due to the game's dimetric projection, i.e. internal North is top-right, North-East is right, etc.}}		{{fn\|4\|Note that the internal "compass" is tilted due to the game's dimetric projection, i.e. internal North is top-right, North-East is right, etc.}}

en>Crimsonum at 12:00, 7 September 2022

2022-09-07T12:00:35Z

en>Crimsonum: Centered parameter column contents horizontally + fixed facing/direction types

2022-09-07T10:00:11Z

Centered parameter column contents horizontally + fixed facing/direction types

Show changes

en>Crimsonum: Forgot to replace all mentions of script actions + some other minor fixes.

2022-09-07T09:32:33Z

Forgot to replace all mentions of script actions + some other minor fixes.

Show changes

en>Crimsonum: Crimsonum moved page TeamMissionTypes to ScriptTypes/TeamMissionTypes: Moved under ScriptTypes due to close association

2022-09-07T08:39:17Z

Crimsonum moved page TeamMissionTypes to ScriptTypes/TeamMissionTypes: Moved under ScriptTypes due to close association

← Older revision	Revision as of 10:39, 7 September 2022
(No difference)

← Older revision		Revision as of 15:55, 12 September 2022
Line 710:		Line 710:

	{{fn\|1\|For convenience, the "#" symbol refers to a number/index of the object type. For example, "Waypoint#" refers to the index number of the Waypoint in the [[Waypoints]] list}}		{{fn\|1\|For convenience, the "#" symbol refers to a number/index of the object type. For example, "Waypoint#" refers to the index number of the Waypoint in the [[Waypoints]] list}}
	{{fn\|2\|Time to guard area in tenths of a minute (multiples of 6 seconds) at normal game speed.}}		{{fn\|2\|Time to guard area. In {{ts}}, the time is measured in seconds at default game speed (15 FPS). In {{ra2}} and {{yr}}, the time is measured in tenths of a minute (multiples of 6 seconds) at normal game speed.}}
	{{fn\|3\|'''B'''uilding '''w'''ith '''P'''roperty is the computed value of the building's index in [[BuildingTypes]] and the AI's choice for target selection. See the [[#Notes\|notes]] below for more information}}		{{fn\|3\|'''B'''uilding '''w'''ith '''P'''roperty is the computed value of the building's index in [[BuildingTypes]] and the AI's choice for target selection. See the [[#Notes\|notes]] below for more information}}
	{{fn\|4\|Note that the internal "compass" is tilted due to the game's dimetric projection, i.e. internal North is top-right, North-East is right, etc.}}		{{fn\|4\|Note that the internal "compass" is tilted due to the game's dimetric projection, i.e. internal North is top-right, North-East is right, etc.}}

← Older revision		Revision as of 14:00, 7 September 2022
Line 80:		Line 80:
	\|style="text-align: center;"\|0		\|style="text-align: center;"\|0
	\|'''Do Nothing'''		\|'''Do Nothing'''
	With no associated ~~action to~~ perform, the team moves on to its next mission in the script, if present.		With no associated mission perform, the team moves on to its next mission in the script, if present.
	\|-		\|-
	\|style="text-align: center;"\|3		\|style="text-align: center;"\|3
Line 90:		Line 90:
	\|style="text-align: center;"\|Cell#{{fnl\|1}}		\|style="text-align: center;"\|Cell#{{fnl\|1}}
	\|'''Move Into Specific Cell'''		\|'''Move Into Specific Cell'''
	This instructs the TeamType to use the task force to move into the Cell specified by the second parameter. Cell number in the second parameter uses formula of (Y * 128) + X. With modulus operator being used to compute the X value from the given parameter, even if the X values used in the formula is 128 or higher, the resultant X value is limited to between 0 and 127. This ~~action~~ can be used when you want the TeamType to trigger a specific Action (when the game tests for the CellTag being entered). CellTags are attached to cells and are used to trigger Events and thus fire Actions when that cell is entered by a unit (or any unit from the task force). Refer [[CellTags]] for details on celltag.		This instructs the TeamType to use the task force to move into the Cell specified by the second parameter. Cell number in the second parameter uses formula of (Y * 128) + X. With modulus operator being used to compute the X value from the given parameter, even if the X values used in the formula is 128 or higher, the resultant X value is limited to between 0 and 127. This mission can be used when you want the TeamType to trigger a specific Action (when the game tests for the CellTag being entered). CellTags are attached to cells and are used to trigger Events and thus fire Actions when that cell is entered by a unit (or any unit from the task force). Refer [[CellTags]] for details on celltag.
	\|-		\|-
	\|style="text-align: center;"\|5		\|style="text-align: center;"\|5
Line 98:		Line 98:
	\|-		\|-
	\|style="text-align: center;"\|6		\|style="text-align: center;"\|6
	\|style="text-align: center;"\|~~Action~~#{{fnl\|1}}		\|style="text-align: center;"\|Line#{{fnl\|1}}
	\|'''Loop'''		\|'''Loop'''
	This is used to repeat team missions within the ScriptType. The second parameter is the mission ''line number'' of the ScriptType that you want to jump to.<br/>'''Note''': Team mission index starts at 0 whereas the line number starts at 1. So, to jump to the first team mission whose index is 0, use {{tt\|n=6,1}} for this script. Jump to line number could be specified to any of the preceding line numbers, not just to the first team mission to create a loop of missions.		This is used to repeat team missions within the ScriptType. The second parameter is the mission ''line number'' of the ScriptType that you want to jump to.<br/>'''Note''': Team mission index starts at 0 whereas the line number starts at 1. So, to jump to the first team mission whose index is 0, use {{tt\|n=6,1}} for this script. Jump to line number could be specified to any of the preceding line numbers, not just to the first team mission to create a loop of missions.
Line 131:		Line 131:
	\|style="text-align: center;"\|0		\|style="text-align: center;"\|0
	\|'''Deploy'''		\|'''Deploy'''
	If the task force contains a unit or units that are able to deploy (for example a unit which {{f\|DeploysInto\|\|link}} a [BuildingType] or has any of {{f\|Deployer\|yes\|link}}, {{f\|DeployFire\|yes\|link}}, {{f\|DeployToFire\|yes\|link}} set) then this ~~action~~ causes them to deploy at the current cell they are occupying (same effect as selecting a unit and pressing the Deploy key as defined in KEYBOARD.INI or clicking the relevant button on the Advanced Command Bar).		If the task force contains a unit or units that are able to deploy (for example a unit which {{f\|DeploysInto\|\|link}} a [BuildingType] or has any of {{f\|Deployer\|yes\|link}}, {{f\|DeployFire\|yes\|link}}, {{f\|DeployToFire\|yes\|link}} set) then this mission causes them to deploy at the current cell they are occupying (same effect as selecting a unit and pressing the Deploy key as defined in KEYBOARD.INI or clicking the relevant button on the Advanced Command Bar).
	\|-		\|-
	\|style="text-align: center;"\|10		\|style="text-align: center;"\|10
Line 406:		Line 406:
	\|style="text-align: center;"\|Waypoint#{{fnl\|1}}		\|style="text-align: center;"\|Waypoint#{{fnl\|1}}
	\|'''Patrol to waypoint'''		\|'''Patrol to waypoint'''
	This is similar to Move to waypoint. This instructs the TeamType to use the task force to move to the waypoint number specified by the second parameter. The difference is that the units in the task force will move out of their patrol route to actively go and engage any enemy objects that are within their {{f\|Sight\|\|link}} as they move to the waypoint. NOTE: this ~~action~~ eats up processor time, because the task force will scan for enemy objects with each movement. If you have a lot of task forces (or lots of units in them) engaged in this ~~action~~, you will experience slowdown in the game - this is one reason why the single player missions are comparatively slow, they use this ~~action~~ a lot. The rate at which the scanning for targets whilst in this mission is controlled by the {{f\|PatrolScan\|\|link}} statement in the [AI]section of RULES.INI. Refer [[Waypoints]] for details on waypoint.		This is similar to Move to waypoint. This instructs the TeamType to use the task force to move to the waypoint number specified by the second parameter. The difference is that the units in the task force will move out of their patrol route to actively go and engage any enemy objects that are within their {{f\|Sight\|\|link}} as they move to the waypoint. NOTE: this mission eats up processor time, because the task force will scan for enemy objects with each movement. If you have a lot of task forces (or lots of units in them) engaged in this mission, you will experience slowdown in the game - this is one reason why the single player missions are comparatively slow, they use this mission a lot. The rate at which the scanning for targets whilst in this mission is controlled by the {{f\|PatrolScan\|\|link}} statement in the [AI]section of RULES.INI. Refer [[Waypoints]] for details on waypoint.
	\|-		\|-
	\|style="text-align: center;"\|17		\|style="text-align: center;"\|17
Line 451:		Line 451:
	\|style="text-align: center;"\|Sound#{{fnl\|1}}		\|style="text-align: center;"\|Sound#{{fnl\|1}}
	\|'''Play Sound'''		\|'''Play Sound'''
	This instructs the task force to play one of the generic in game sounds from the [SoundList] in the [[Sounds.ini\|SOUNDS.INI]] file ~~(note that for all in game Action and Trigger purposes this number is from an internal table~~.		This instructs the task force to play one of the generic in game sounds from the {{sl\|SoundList}} in the [[Sounds.ini\|SOUNDS.INI]] file.
	\|-		\|-
	\|style="text-align: center;"\|26		\|style="text-align: center;"\|26
	\|style="text-align: center;"\|Movie#{{fnl\|1}}		\|style="text-align: center;"\|Movie#{{fnl\|1}}
	\|'''Play Movie'''		\|'''Play Movie'''
	This instructs the task force to play one of the movies from the [Movies] list in the [[Art.ini\|ART.INI]] file ~~(note that for all in game Action and Trigger purposes this number is from an internal table~~.		This instructs the task force to play one of the movies from the {{sl\|Movies}} list in the [[Art.ini\|ART.INI]] file.
	\|-		\|-
	\|style="text-align: center;"\|27		\|style="text-align: center;"\|27
	\|style="text-align: center;"\|Theme#{{fnl\|1}}		\|style="text-align: center;"\|Theme#{{fnl\|1}}
	\|'''Play Theme'''		\|'''Play Theme'''
	This instructs the task force to play one of the game soundtracks from the [Themes] list in the [[Theme.ini\|Theme.INI]] file ~~(note that for all in game Action and Trigger purposes this number is from an internal table~~.		This instructs the task force to play one of the game soundtracks from the {{sl\|Themes}} list in the [[Theme.ini\|Theme.INI]] file.
	\|-		\|-
	\|style="text-align: center;"\|28		\|style="text-align: center;"\|28
Line 501:		Line 501:
	\|style="text-align: center;"\|Time#{{fnl\|1}}		\|style="text-align: center;"\|Time#{{fnl\|1}}
	\|'''Shroud Map For Time Interval'''		\|'''Shroud Map For Time Interval'''
	This ~~action~~ will shroud the entire map except for the area revealed by the player's own and/or friendly units. The second parameter determines the number of [[frames]] for which the map should remain shrouded after which the explored areas are revealed again.		This mission will shroud the entire map except for the area revealed by the player's own and/or friendly units. The second parameter determines the number of [[frames]] for which the map should remain shrouded after which the explored areas are revealed again.
	\|-		\|-
	\|style="text-align: center;"\|36		\|style="text-align: center;"\|36
	\|style="text-align: center;"\|Time#{{fnl\|1}}		\|style="text-align: center;"\|Time#{{fnl\|1}}
	\|'''Reveal Map For Time Interval'''		\|'''Reveal Map For Time Interval'''
	This ~~action~~ will reveal the entire map. The second parameter determines the number of [[frames]] for which the map should remain revealed after which the map is shrouded again.		This mission will reveal the entire map. The second parameter determines the number of [[frames]] for which the map should remain revealed after which the map is shrouded again.
	\|-		\|-
	\|style="text-align: center;"\|37		\|style="text-align: center;"\|37
Line 531:		Line 531:
	\|style="text-align: center;"\|0		\|style="text-align: center;"\|0
	\|'''Unpanic'''		\|'''Unpanic'''
	If the task force contains a unit or units that have {{f\|Fraidycat\|yes\|link}} set which are currently assigned the {{f\|Panic}}= sequence then this ~~action~~ nullifies that effect and the unit(s) adopt their default behaviour.		If the task force contains a unit or units that have {{f\|Fraidycat\|yes\|link}} set which are currently assigned the {{f\|Panic}}= sequence then this mission nullifies that effect and the unit(s) adopt their default behaviour.
	\|-		\|-
	\|style="text-align: center;"\|42		\|style="text-align: center;"\|42
Line 578:		Line 578:
	\|style="text-align: center;"\|0		\|style="text-align: center;"\|0
	\|'''Wait Until Fully Loaded'''		\|'''Wait Until Fully Loaded'''
	This is always used after members of the task force have entered a transport in the same task force and serves two purposes. The effect of this is that the transport will be used to carry out any subsequent movement or deploy ~~actions~~ but after that it is no longer considered a part of this task force and as such is available to be recruited into new TeamTypes. It is this mission which enables use of the {{f\|TransportsReturnOnUnload\|yes\|link}} statement in the corresponding TeamType entry. The second purpose is to flag the transport as being 'loaded' with passengers and thus is considered in the AI's targeting logic as a potential threat (see the {{f\|ContentScan\|\|link}} entry in the RULES.INI). This mission also orders the transport to wait until it is fully loaded before executing any subsequent team missions.		This is always used after members of the task force have entered a transport in the same task force and serves two purposes. The effect of this is that the transport will be used to carry out any subsequent movement or deploy missions but after that it is no longer considered a part of this task force and as such is available to be recruited into new TeamTypes. It is this mission which enables use of the {{f\|TransportsReturnOnUnload\|yes\|link}} statement in the corresponding TeamType entry. The second purpose is to flag the transport as being 'loaded' with passengers and thus is considered in the AI's targeting logic as a potential threat (see the {{f\|ContentScan\|\|link}} entry in the RULES.INI). This mission also orders the transport to wait until it is fully loaded before executing any subsequent team missions.
	\|-		\|-
	\|style="text-align: center;"\|44		\|style="text-align: center;"\|44