ModdersGuide - Revision history

JYWLuca8269 at 20:09, 1 April 2022

2022-04-01T20:09:45Z

JYWLuca8269 at 19:40, 1 April 2022

2022-04-01T19:40:25Z

← Older revision		Revision as of 19:40, 1 April 2022
Line 1:		Line 1:
	==What is a Scenario?==		{{DISPLAYTITLE:<span style="position: absolute; clip: rect(1px 1px 1px 1px); clip: rect(1px, 1px, 1px, 1px);">{{FULLPAGENAME}}</span>}}
			{{HeaderTemplate
			\|welcome=Modder's Guide
			}}
			{{SectionTemplate
			\|h=h1
			\|title=What is a Scenario?
			\|content=
	A scenario is a mission that you can create and share with other players. At the simplest, you can create a new map (or use an existing map) and design your own waves of enemies. At its most complex you can use the scripting system in Siege to trigger a wide variety of actions and threats for the player.		A scenario is a mission that you can create and share with other players. At the simplest, you can create a new map (or use an existing map) and design your own waves of enemies. At its most complex you can use the scripting system in Siege to trigger a wide variety of actions and threats for the player.

	Scenarios can be easily uploaded and downloaded from the scenario workshop in Siege.		Scenarios can be easily uploaded and downloaded from the scenario workshop in Siege.
			}}
	==Creating a Map==		{{SectionTemplate
			\|h=h1
			\|title=Creating a Map
			\|content=
	The map editor is accessible from the main menu of Siege of Centauri.		The map editor is accessible from the main menu of Siege of Centauri.
			}}
	~~===~~Map Select~~===~~		'''Map Select'''<br>
	Select an existing map or select New Map. If you select New Map you will need to name the map, select a Map Size (I know everyone wants to pick the largest size, I recommend starting at 1536 for your first map) and a Terrain Type.		Select an existing map or select New Map. If you select New Map you will need to name the map, select a Map Size (I know everyone wants to pick the largest size, I recommend starting at 1536 for your first map) and a Terrain Type.

	[[File:MapEditor-03.png]]		[[File:MapEditor-03.png\|thumb]]

	Once you have set those things you start with a blank map with your colony on it and lots of options.		Once you have set those things you start with a blank map with your colony on it and lots of options.

	[[File:MapEditor-04.png]]		[[File:MapEditor-04.png\|thumb]]

	====Edit Terrain====		====Edit Terrain====
Line 45:		Line 55:
	This will cause the game to generate the map based on everything you have set. It may take a few minutes to do based on the size of your map and the power of your computer.		This will cause the game to generate the map based on everything you have set. It may take a few minutes to do based on the size of your map and the power of your computer.

	[[File:MapEditor-01.png]]		[[File:MapEditor-01.png\|thumb]]

	====Toggle Display Mode====		====Toggle Display Mode====

Corg: /* WaveStarted */

2019-08-22T16:58:14Z

WaveStarted

← Older revision		Revision as of 16:58, 22 August 2019
Line 424:		Line 424:
	<Trigger Name="Wave2Started" Type="WaveStarted" Target="Wave2">		<Trigger Name="Wave2Started" Type="WaveStarted" Target="Wave2">
	<Dialog>		<Dialog>
	<Entry Character="Husk" Text="~~Dialog_Circosta_Corrosion_Husk~~" />		<Entry Character="Husk" Text="The tight pathways of this sector are ideal for the /color:EEBeige/Corrosion Mortar/endcolor/. It can fire over terrain and soften up the enemy with damage over time." />
	</Dialog>		</Dialog>
	</Trigger>		</Trigger>
Line 441:		Line 441:
	<Trigger Name="Wave2Started" Type="WaveStarted" Target="Wave2">		<Trigger Name="Wave2Started" Type="WaveStarted" Target="Wave2">
	<Dialog>		<Dialog>
	<Entry Character="Husk" Text="~~Dialog_Circosta_Corrosion_Husk~~" />		<Entry Character="Husk" Text="The tight pathways of this sector are ideal for the /color:EEBeige/Corrosion Mortar/endcolor/. It can fire over terrain and soften up the enemy with damage over time." />
	</Dialog>		</Dialog>
	</Trigger>		</Trigger>
Line 504:		Line 504:
	<Trigger Name="OutpostDies" Type="BuildingDestroyed" Template="Building_Outpost">		<Trigger Name="OutpostDies" Type="BuildingDestroyed" Template="Building_Outpost">
	<Dialog>		<Dialog>
	<Entry Character="Husk" Text="~~Dialog_Dule_OutpostDestroyed_Husk~~" />		<Entry Character="Husk" Text="The first Outpost has been destroyed. Expect them to focus on the other Outpost and the Colony next." />
	</Dialog>		</Dialog>
	</Trigger>		</Trigger>

Corg: /* Var */

2019-08-22T15:54:13Z

Var

← Older revision		Revision as of 15:54, 22 August 2019
Line 418:		Line 418:
	This SpecialAbility trigger increments the ReinforceTrigger count each time the player uses the Reinforce ability.		This SpecialAbility trigger increments the ReinforceTrigger count each time the player uses the Reinforce ability.

	Used together the counter goes up each time the player uses Reinforce. But when the player uses it for the 3rd time it disables the ~~reinforce~~ ability for the rest of the mission (or at least until a script turns it back on).		Used together, the counter goes up each time the player uses Reinforce. But when the player uses it for the 3rd time, it disables the Reinforce ability for the rest of the mission (or at least until a script turns it back on).

	====WaveStarted====		====WaveStarted====
Line 429:		Line 429:
	</pre>		</pre>

	This trigger fires when the specified wave starts. In the example it ~~trigger~~ a dialog when Wave2 (Target=”Wave2”) begins.		This trigger fires when the specified wave starts. In the example, it triggers a dialog when Wave2 (Target=”Wave2”) begins.

	*Name- Names need to be unique.		*Name - Names need to be unique.
	*Type- WaveStarted in this example.		*Type - WaveStarted in this example.
	*Target- The name of the Wave that will cause this trigger to fire.		*Target - The name of the Wave that will cause this trigger to fire.

	===Actions===		===Actions===
Line 446:		Line 446:
	</pre>		</pre>

	The above reads as: when the “WaveStarted” trigger fires it the Dialog action occurs.		The above reads as: when the “WaveStarted” trigger fires, the Dialog action occurs.

	Triggers can contain multiple actions such as:		Triggers can contain multiple actions such as:
Line 457:		Line 457:
	</pre>		</pre>

	The above reads as: when the “ReinforceCount” variable gets to 3 or higher it will disable the ~~reinforcements~~ orbital ability and deactivate the “ReinforceTrigger” trigger.		The above reads as: when the “ReinforceCount” variable gets to 3 or higher, it will disable the Reinforcements orbital ability and deactivate the “ReinforceTrigger” trigger.

	====ActivateTrigger====		====ActivateTrigger====
Line 473:		Line 473:
	</pre>		</pre>

	Triggers also deactivate after firing. So if you have a timer trigger that goes off after 10 seconds it will fire after 10 seconds then mark itself as inactive.		Triggers also deactivate after firing. So if you have a timer trigger that goes off after 10 seconds, it will fire after 10 seconds then mark itself as inactive.

	The ActivateTrigger action marks these triggers as active again. It is commonly used to cause triggers to repeat, or to have other triggers start working after a certain condition has been met (for example, if you want to start spawning new waves after the player upgrades his colony).		The ActivateTrigger action marks these triggers as active again. It is commonly used to cause triggers to repeat, or to have other triggers start working after a certain condition has been met (for example, if you want to start spawning new waves after the player upgrades his colony).
Line 491:		Line 491:
	This creates a gameplay timer that you can trigger off of with the GameplayTimerExpired trigger. You could, for example, give the player 60 seconds to place towers and then disable all towers afterwards.		This creates a gameplay timer that you can trigger off of with the GameplayTimerExpired trigger. You could, for example, give the player 60 seconds to place towers and then disable all towers afterwards.

	This is also commonly used with the GameplayTimerExpired trigger and the EndMission action to allow the player to win if he survives for X minutes.		This is also commonly used with the GameplayTimerExpired trigger and the EndMission action to allow the player to win if he survives for N minutes.

	====DeactivateTrigger====		====DeactivateTrigger====
Line 498:		Line 498:
	</pre>		</pre>

	This is the opposite of the ActivateTrigger function, it can deactivate any trigger. For example, if you have a trigger that spawns an enemy wave every 15 seconds as long as an enemy building exists you could have the destruction of that ~~build~~ deactivate the unit spawning trigger.		This is the opposite of the ActivateTrigger function; it can deactivate any trigger. For example, if you have a trigger that spawns an enemy wave every 15 seconds as long as an enemy building exists, you could have the destruction of that building deactivate the unit spawning trigger.

	====Dialog====		====Dialog====
Line 516:		Line 516:
	</pre>		</pre>

	Siege missions normally end when the game ~~have~~ processed a wave with the “IsFinalWave” attribute and all enemies have been killed. ~~But if~~ you don’t want your scenario to end like that you don’t need to ever include a wave with the “IsFinalWave” attribute and you can use this action to end the mission instead.		Siege missions normally end when the game has processed a wave with the “IsFinalWave” attribute and all enemies have been killed. If you don’t want your scenario to end like that you don’t need to ever include a wave with the “IsFinalWave” attribute, and you can use this action to end the mission instead.

	You could have a trigger that requires the player to kill 1,000,000 reapers, and this EndMIssion trigger only grants victory when this is done. Or if the player has survived for 15 minutes.		You could have a trigger that requires the player to kill 1,000,000 reapers, and this EndMIssion trigger only grants victory when this is done. Or if the player has survived for 15 minutes.
Line 532:		Line 532:
	</pre>		</pre>

	GrantStuff provides free metal or energy (under the covers Energy is tracked as Radioactives). The ~~Free~~ metal is used at the beginning of every mission to determine how much metal the player starts with. ~~But you~~ can have triggers give out additional metal or energy if a certain enemy is killed, if you want to help the player out when he is getting attacked, etc.		GrantStuff provides free metal or energy (under the covers Energy is tracked as Radioactives). The free metal is used at the beginning of every mission to determine how much metal the player starts with. You can have triggers give out additional metal or energy if a certain enemy is killed, if you want to help the player out when he is getting attacked, etc.

	====GrantTech====		====GrantTech====
Line 540:		Line 540:
	</pre>		</pre>

	GrantTech provides bonuses to the specified player. Remember Player 0 is the human player and Player 1 is the AI. Granting a “Weapons” tech to the player increases the amount of damage towers do. Granting a “HPs” tech to the ai increases the hit points of enemy ships.		GrantTech provides bonuses to the specified player. Remember Player 0 is the human player and Player 1 is the AI. Granting a “Weapons” tech to the player increases the amount of damage towers do. Granting a “HPs” tech to the AI increases the hit points of enemy ships.

	Granting increased HP’s to enemy ships is used frequently on the difficulty level triggers, ~~its~~ also used on Endless maps to make sure the enemy waves keep getting tougher.		Granting increased HP’s to enemy ships is used frequently on the difficulty level triggers, it's also used on Endless maps to make sure the enemy waves keep getting tougher.

	====QueueWave====		====QueueWave====
Line 549:		Line 549:
	</pre>		</pre>

	QueueWave ~~Was~~ discussed in the Waves section above~~. But~~ it can be called from any trigger. For example it might be interesting if the waves queued were based on the towers the player placed. So the Script was adjusting the enemies it was sending based on what the ~~players~~ towers were weak against.		QueueWave was discussed in the Waves section above but it can be called from any trigger. For example, it might be interesting if the waves queued were based on the towers the player placed. So the Script was adjusting the enemies it was sending based on what the player's towers were weak against.

	This is also used in special triggers on some of the timed missions so that special waves get triggered when there is only 5 minutes left of the 10 minutes the player needs to survive.		This is also used in special triggers on some of the timed missions so that special waves get triggered when there is only 5 minutes left of the 10 minutes the player needs to survive.
Line 559:		Line 559:
	</pre>		</pre>

	Restrict can be used to enable or disable ~~Orbital’s~~ or towers. Enable=”1” will enable the orbital or building and Enable=”0” disables it. Hide=”0” means that the icon will still be visible (but disabled) while Hide=”1” hides the icon for that orbital or tower.		Restrict can be used to enable or disable orbitals or towers. Enable=”1” will enable the orbital or building; and Enable=”0” disables it. Hide=”0” means that the icon will still be visible (but disabled) while Hide=”1” hides the icon for that orbital or tower.

	This could also be used to disable all the towers and force the player to play a mission using only orbitals.		This could also be used to disable all the towers and force the player to play a mission using only orbitals.
Line 576:		Line 576:
	</pre>		</pre>

	The above trigger fires if the unit called “Egg10” is destroyed. This is one of the large eggs on Caina. If it is destroyed it will spawn a Harridan (“Unit_Spider”) and send it on Path-Egg10 (a route from the destroyed egg to the colony.		The above trigger fires if the unit called “Egg10” is destroyed. This is one of the large eggs on Caina. If it is destroyed it will spawn a Harridan (“Unit_Spider”) and send it on Path-Egg10 (a route from the destroyed egg to the colony).

	===Putting It All Together===		===Putting It All Together===

Corg: /* What is a Path? */

2019-08-22T15:39:21Z

What is a Path?

Show changes

Corg: /* What is a Wave? */

2019-08-22T15:06:37Z

What is a Wave?

Corg: /* The Mission File */

2019-08-22T14:50:37Z

The Mission File

← Older revision		Revision as of 14:50, 22 August 2019
Line 65:		Line 65:

	===The Mission File===		===The Mission File===
	This is an XML file and it can be made with any text editor, even notepad. I use Notepad++.		This is an XML file and it can be made with any text editor, even notepad. I use [https://notepad-plus-plus.org/ Notepad++].

	Create the file and save it in the ..\My Games\Siege of Centauri\Scenario\ directory. Name it the same as your scenario. In this example I’m creating a scenario called “Aberny”. Note I called my Map “Aberny” my Mission “Aberny” and the Scenario will be called “Aberny”. ~~But they~~ don’t need to be the same, it was just convenient.		Create the file and save it in the ..\My Games\Siege of Centauri\Scenario\ directory. Name it the same as your scenario. In this example I’m creating a scenario called “Aberny”. Note I called my Map “Aberny”, my Mission “Aberny”, and the Scenario will be called “Aberny”. They don’t need to be the same - it was just convenient.
	<pre style="color: blue">		<pre style="color: blue">
	<Mission		<Mission
Line 90:		Line 90:
	'''Mission attributes:'''		'''Mission attributes:'''

	*ID- This needs to be unique. You may want to append your own name to it so you don’t have to worry about conflicting with someone else’s in the workshop.		*ID - This needs to be unique. You may want to append your own name to it so you don’t have to worry about conflicting with someone else’s in the workshop.
	*Title- The name that people will see in the workshop.		*Title - The name that people will see in the workshop.
	*Description- The detailed description that appears when someone clicks on this in the workshop.		*Description - The detailed description that appears when someone clicks on this in the workshop.
	*Map- The name of the map you created for this mission.		*Map - The name of the map you created for this mission.
	*PreviewImage- This is the picture that will be displayed in the workshop and in game. Later we will go through how to create it.		*PreviewImage - This is the picture that will be displayed in the workshop and in game. Later we will go through how to create it.

	Ignore the other mission attributes and the score element. In setting up the players, the human always has to be the first player listed. The first player listed is player 0, the second player listed is player 1, etc.		Ignore the other mission attributes and the score element. In setting up the players, ''the human always has to be the first player listed.'' The first player listed is player 0, the second player listed is player 1, etc.

	Player attributes:		'''Player attributes:'''

	*Name- Not used.		*Name - Not used.
	*Faction- The Human player should always be “PHC”, the enemies should always be “ss”.		*Faction - The Human player should always be “PHC”, the enemies should always be “ss”.
	*Team- Typically the human player is team “0” and the AI is team “1” but if you want to create multiple players you can make more teams or put them on teams together.		*Team - Typically the human player is team “0” and the AI is team “1” but if you want to create multiple players you can make more teams or put them on teams together.
	*Color- Typically the human player is 2 (blue) and the AI is 4 (orange) though we do player with his a bt on some maps to make them more visible.		*Color - Typically the human player is 2 (blue) and the AI is 4 (orange) though we do player with his a bt on some maps to make them more visible.
	*StartLocation- This should always be set to “0”.		*StartLocation - This should always be set to “0”.
	*AIType- The human player should be “Player” and the AI “Off”.		*AIType - The human player should be “Player” and the AI “Off”.
	*NoEngineer- Always set to “1”.		*NoEngineer - Always set to “1”.
	*NoSeed- AI players should have this set to “1”.		*NoSeed - AI players should have this set to “1”.

	====Example: Warring Enemies====		====Example: Warring Enemies====

Corg: /* Creating a Map */

2019-08-22T14:39:13Z

Creating a Map

← Older revision		Revision as of 14:39, 22 August 2019
Line 5:		Line 5:

	==Creating a Map==		==Creating a Map==
	The map editor is accessible from the main menu of Siege of Centauri. ~~With it you can create~~		The map editor is accessible from the main menu of Siege of Centauri.

	===Map Select===		===Map Select===
Line 17:		Line 17:

	====Edit Terrain====		====Edit Terrain====
	This allows you to set the terrain you would like.		This allows you to set the terrain you would like for areas of your map.
	*Plains- This is the default ground enemies can travel on.
	*Plateau- This is where towers can be placed.		*Plains - This is the default flat ground enemies can travel on.
	*Mountains- Mountains are impassable by ground units and can block shots from direct fire weapons.		*Plateau - This is where towers can be placed. It is elevated above Plains.
	*Basin- Basins are impassable by ground units.		*Mountains - Mountains are impassable by ground units and can block shots from direct fire weapons.
			*Basin - Basins are impassable by ground units.

	====Edit Buildings====		====Edit Buildings====
	*Relay- Relay’s connect paths for unit movement.
	*Metal Refinery- This produces metal for the player.		*Relay - Relay’s connect paths for unit movement.
	*Fission Reactor- This produces energy for the player.		*Metal Refinery - This produces metal for the player.
	*Outpost- Players get a score boost for each surviving Outpost when they complete the Mission.		*Fission Reactor - This produces energy for the player.
	*Storage Cell- Storage cells explode when clicked on, but they can only be used once.		*Outpost - Players get a score boost for each surviving Outpost when they complete the Mission.
	*Dead Region- This marks an area that can’t be entered (to block relays from connecting over mountains, basins, etc).		*Storage Cell - Storage cells explode when clicked on, but they can only be used once.
			*Dead Region - This marks an area that can’t be entered (to block relays from connecting over mountains, basins, etc).

	====Edit Cosmetic====		====Edit Cosmetic====
	Depending on the environment different cosmetic layers may use different textures. For example on arctic one cosmetic layer is a snowy ground, while another is clear dirt. Play with the ~~layer~~ to find the one you want.		Depending on the environment, different cosmetic layers may use different textures. For example, on arctic one cosmetic layer is a snowy ground, while another is clear dirt. Play with the layers to find the one you want.

	====Edit Effects====		====Edit Effects====
	Effect layer 1 is ~~ground fog~~. Typically we use to fill in the basins and give them life~~. But~~ you can use it anywhere if you want to create foggy paths. More advanced modders can edit their MapEffects.csv file to use any effect in Siege for these layers~~. But~~ the default is just for ground fog.		Effect layer 1 is Ground Fog. Typically we use to fill in the basins and give them life, but you can use it anywhere if you want to create foggy paths. More advanced modders can edit their MapEffects.csv file to use any effect in Siege for these layers; but the default is just for ground fog.

	====Brush Size====		====Brush Size====
Line 57:		Line 59:

	====Toggle Mouse Position====		====Toggle Mouse Position====
	This shows you the map coordinates of the cursor position. This is very important later on when we are making the mission.		This shows you the map coordinates of the cursor position. This is very important later on when we are making the mission.<blockquote>'''Pro Tip:''' Write down the coordinates of important locations so you have them ready when you go to make your mission. You will want the coordinates of the places you want enemies to enter from, the coordinates of the colony and other buildings, as well as any other special locations you might want to send enemies to, or trigger actions at.</blockquote>[[File:MapEditor-02.png]]

	'''Pro Tip:''' Write down the coordinates of important locations so you have them ready when you go to make your mission. You will want the coordinates of the places you want enemies to enter from, the coordinates of the colony and other buildings, as well as any other special locations you might want to send enemies to, or trigger actions at.

	[[File:MapEditor-02.png]]

	==Creating a Mission==		==Creating a Mission==
Line 91:		Line 89:

	'''Mission attributes:'''		'''Mission attributes:'''

	*ID- This needs to be unique. You may want to append your own name to it so you don’t have to worry about conflicting with someone else’s in the workshop.		*ID- This needs to be unique. You may want to append your own name to it so you don’t have to worry about conflicting with someone else’s in the workshop.
	*Title- The name that people will see in the workshop.		*Title- The name that people will see in the workshop.
Line 100:		Line 99:

	Player attributes:		Player attributes:

	*Name- Not used.		*Name- Not used.
	*Faction- The Human player should always be “PHC”, the enemies should always be “ss”.		*Faction- The Human player should always be “PHC”, the enemies should always be “ss”.
Line 163:		Line 163:

	'''Wave'''		'''Wave'''

	*Timer- How many second after this wave is triggered will it wait before spawning. This allows us to control the gap between waves. Do you want it to wait 90 seconds before sending the next army in, or 5 seconds?		*Timer- How many second after this wave is triggered will it wait before spawning. This allows us to control the gap between waves. Do you want it to wait 90 seconds before sending the next army in, or 5 seconds?
	*PortraitUnit- This is the template name of the unit you want to represent this wave in the wave panel on the top of the screen.		*PortraitUnit- This is the template name of the unit you want to represent this wave in the wave panel on the top of the screen.
Line 176:		Line 177:

	'''DoWaveSpawn'''		'''DoWaveSpawn'''

	*Target- This is the trigger that the DoWaveSpawn calls (we will take a look at setting these up later) that actually generates the units.		*Target- This is the trigger that the DoWaveSpawn calls (we will take a look at setting these up later) that actually generates the units.
	*Delay- If you want to have a delay between these DoWaveSpawns. In the above example it spawns a group of “Normal” then waits 1 second, then spawns another group.		*Delay- If you want to have a delay between these DoWaveSpawns. In the above example it spawns a group of “Normal” then waits 1 second, then spawns another group.
Line 201:		Line 203:

	'''WavePath'''		'''WavePath'''

	*Name- This name has to be unique. It is what PingPath uses and the SpawnUnitOnPath trigger uses.		*Name- This name has to be unique. It is what PingPath uses and the SpawnUnitOnPath trigger uses.
	*ShowInScanMode- This determines if this path is displayed when the player presses the Ctrl key. Typically we only set if for the paths of Air units (so the player can see the path air units will follow).		*ShowInScanMode- This determines if this path is displayed when the player presses the Ctrl key. Typically we only set if for the paths of Air units (so the player can see the path air units will follow).

	'''SpawnPoint'''		'''SpawnPoint'''

	*Position- This is the starting point of the path. This is where units will be initially spawned with a SpawnUnitOnPath trigger is used or where the Ping will happen on a PingPath.		*Position- This is the starting point of the path. This is where units will be initially spawned with a SpawnUnitOnPath trigger is used or where the Ping will happen on a PingPath.

	'''Waypoint'''		'''Waypoint'''

	*Position- This is where the units will go after being spawned. They will go to each waypoint defined and attempt to reach that position before going on to the next. In most cases the only waypoint required is the colony location, but in some cases you might want to have more granular control over where they go. In the above example the path leads to 2 other buildings before heading to the final waypoint, which is the Colony.		*Position- This is where the units will go after being spawned. They will go to each waypoint defined and attempt to reach that position before going on to the next. In most cases the only waypoint required is the colony location, but in some cases you might want to have more granular control over where they go. In the above example the path leads to 2 other buildings before heading to the final waypoint, which is the Colony.

Line 222:		Line 227:

	'''Trigger'''		'''Trigger'''

	*Name- This is the name that is called from the DoWaveSpawn trigger.		*Name- This is the name that is called from the DoWaveSpawn trigger.
	*Type- Always use “WaveSpawn” here. We will cover other types of triggers later.		*Type- Always use “WaveSpawn” here. We will cover other types of triggers later.

	'''SpawnUnitOnPath'''		'''SpawnUnitOnPath'''

	*Name- We typically use “Parent” for every unit name. The only time this really matters is when you are parenting other units to this unit or if you have a specific trigger setup (when this unit is destroyed or gets to a particular location).		*Name- We typically use “Parent” for every unit name. The only time this really matters is when you are parenting other units to this unit or if you have a specific trigger setup (when this unit is destroyed or gets to a particular location).
	*Parent- This is only needed when you are building an army where you want the units to stay together. In the example above there are 3 “Unit_Normal_3” units being spawned and the second two are following the first.		*Parent- This is only needed when you are building an army where you want the units to stay together. In the example above there are 3 “Unit_Normal_3” units being spawned and the second two are following the first.
Line 233:		Line 240:

	'''Available Units'''		'''Available Units'''

	*Unit_Air- Punisher, a medium strength flying unit		*Unit_Air- Punisher, a medium strength flying unit
	*Unit_Air_Carrier- Gliding Crane, air transport.		*Unit_Air_Carrier- Gliding Crane, air transport.
Line 244:		Line 252:
	*Unit_Speed- Taskmaster, speeds up surrounding allies.		*Unit_Speed- Taskmaster, speeds up surrounding allies.
	*Unit_Fast- Capacitor, small and quick.		*Unit_Fast- Capacitor, small and quick.
	*Unit_FastShielded- Hooded Turbine, medium sized fast and shielded unit.		*Unit_FastShielded- Hooded Turbine, medium sized fast and shielded unit.
	*Unit_Healer- Corrupted Healer, Heals surrounding allies.		*Unit_Healer- Corrupted Healer, Heals surrounding allies.
	*Unit_HeartOfThePhoenix- Heart of the Phoenix, Juggernaut, transforms to an egg when destroyed.		*Unit_HeartOfThePhoenix- Heart of the Phoenix, Juggernaut, transforms to an egg when destroyed.

Bonewhip58 at 21:33, 20 August 2019

2019-08-20T21:33:16Z

← Older revision		Revision as of 21:33, 20 August 2019
Line 9:		Line 9:
	===Map Select===		===Map Select===
	Select an existing map or select New Map. If you select New Map you will need to name the map, select a Map Size (I know everyone wants to pick the largest size, I recommend starting at 1536 for your first map) and a Terrain Type.		Select an existing map or select New Map. If you select New Map you will need to name the map, select a Map Size (I know everyone wants to pick the largest size, I recommend starting at 1536 for your first map) and a Terrain Type.

			[[File:MapEditor-03.png]]

	Once you have set those things you start with a blank map with your colony on it and lots of options.		Once you have set those things you start with a blank map with your colony on it and lots of options.

			[[File:MapEditor-04.png]]

	====Edit Terrain====		====Edit Terrain====
Line 56:		Line 60:

	'''Pro Tip:''' Write down the coordinates of important locations so you have them ready when you go to make your mission. You will want the coordinates of the places you want enemies to enter from, the coordinates of the colony and other buildings, as well as any other special locations you might want to send enemies to, or trigger actions at.		'''Pro Tip:''' Write down the coordinates of important locations so you have them ready when you go to make your mission. You will want the coordinates of the places you want enemies to enter from, the coordinates of the colony and other buildings, as well as any other special locations you might want to send enemies to, or trigger actions at.

			[[File:MapEditor-02.png]]

	==Creating a Mission==		==Creating a Mission==

Bonewhip58 at 21:28, 20 August 2019

2019-08-20T21:28:26Z

← Older revision		Revision as of 21:28, 20 August 2019
Line 38:		Line 38:
	====Rebuild Terrain====		====Rebuild Terrain====
	This will cause the game to generate the map based on everything you have set. It may take a few minutes to do based on the size of your map and the power of your computer.		This will cause the game to generate the map based on everything you have set. It may take a few minutes to do based on the size of your map and the power of your computer.

			[[File:MapEditor-01.png]]

	====Toggle Display Mode====		====Toggle Display Mode====

← Older revision		Revision as of 15:06, 22 August 2019
Line 103:		Line 103:
	*Faction - The Human player should always be “PHC”, the enemies should always be “ss”.		*Faction - The Human player should always be “PHC”, the enemies should always be “ss”.
	*Team - Typically the human player is team “0” and the AI is team “1” but if you want to create multiple players you can make more teams or put them on teams together.		*Team - Typically the human player is team “0” and the AI is team “1” but if you want to create multiple players you can make more teams or put them on teams together.
	*Color - Typically the human player is 2 (blue) and the AI is 4 (orange) though we do player ~~with his~~ a bt on some maps to make them more visible.		*Color - Typically the human player is 2 (blue) and the AI is 4 (orange) though we do let the player change this a bit on some maps to make them more visible.
	*StartLocation - This should always be set to “0”.		*StartLocation - This should always be set to “0”.
	*AIType - The human player should be “Player” and the AI “Off”.		*AIType - The human player should be “Player” and the AI “Off”.
Line 164:		Line 164:
	'''Wave'''		'''Wave'''

	*Timer- How many second after this wave is triggered will it wait before spawning. This allows us to control the gap between waves. Do you want it to wait 90 seconds before sending the next army in, or 5 seconds?		*Timer - How many second after this wave is triggered will it wait before spawning. This allows us to control the gap between waves. Do you want it to wait 90 seconds before sending the next army in, or 5 seconds?
	*PortraitUnit- This is the template name of the unit you want to represent this wave in the wave panel on the top of the screen.		*PortraitUnit - This is the template name of the unit you want to represent this wave in the wave panel on the top of the screen.
	*Description- This is the description that will go in the wave panel for this wave.		*Description - This is the description that will go in the wave panel for this wave.
	*Direction- This can be Top, Bottom, Right, Left or any combination of them. This is what is used to set the arrows ~~whne~~ the player mouses over the wave panel icon. If multiples are used put a comma between them. (ex: Direction=”Right,Left”)		*Direction - This can be Top, Bottom, Right, Left or any combination of them. This is what is used to set the arrows when the player mouses over the wave panel icon. If multiples are used, put a comma between them. (ex: Direction=”Right,Left”)
	*RushBonus- The maximum amount of metal that can be gained by rushing this wave. Typically about 250 is good.		*RushBonus - The maximum amount of metal that can be gained by rushing this wave. Typically about 250 is good.
	*RushCountdown- The countdown timer that ~~rushed~~ how quickly to reduce the metal as it gets closer to the time ~~the wave~~ is going to spawn. Typically 70 is good.		*RushCountdown - The countdown timer that determines how quickly to reduce the metal bonus as a wave gets closer to the time it is going to spawn. Typically 70 is good.
	*Repeat- If you want this wave to repeat you can put the amount of times here. If you want it to repeat forever set it equal to Repeat=”-1”.		*Repeat - If you want this wave to repeat you can put the amount of times here. If you want it to repeat forever set it equal to Repeat=”-1”.
	*RepeatTimer- If the wave is set to repeat this is the time before it repeats. Does it repeat every 300 seconds or every 30?		*RepeatTimer - If the wave is set to repeat, this is the time before it repeats. Does it repeat every 300 seconds or every 30?
	*IsFinalWave- The last wave you have needs to have this set to IsFinalWave=”1”. This tells the game that no future waves are coming so it can award victory to the player if they kill all the enemies after this point.		*IsFinalWave - The last wave you have needs to have this set to IsFinalWave=”1”. This tells the game that no future waves are coming so it can award victory to the player if they kill all the enemies after this point.

	The Wave element has DoWaveSpawn sub-elements. This is what those do.		The Wave element has DoWaveSpawn sub-elements. This is what those do.
Line 178:		Line 178:
	'''DoWaveSpawn'''		'''DoWaveSpawn'''

	*Target- This is the trigger that the DoWaveSpawn calls (we will take a look at setting these up later) that actually generates the units.		*Target - This is the trigger that the DoWaveSpawn calls (we will take a look at setting these up later) that actually generates the units.
	*Delay- If you want to have a delay between these DoWaveSpawns. In the above example it spawns a group of “Normal” then waits 1 second, then spawns another group.		*Delay - If you want to have a delay between these DoWaveSpawns. In the above example it spawns a group of “Normal” then waits 1 second, then spawns another group.

	====The Ping Spawn====		====The Ping Spawn====