https://wiki.ashesofthesingularity.com/api.php?action=feedcontributions&feedformat=atom&user=AlphonsoHornibro 2026-04-21T20:29:57Z User contributions MediaWiki 1.41.1 https://wiki.ashesofthesingularity.com/index.php?title=Map_Editor&diff=9749 2018-08-06T03:10:33Z

<p>AlphonsoHornibro: /* Fixing Issues */</p> <hr /> <div>[[Category:Modding]]<br /> The Map Editor is the tool the Ashes of the Singularity team uses to create maps. It has many powerful options, but be aware - generating maps at high quality levels, and especially at large sizes, requires a ton of CPU and RAM. Minimum of 16gb RAM is recommended for creating maps.<br /> <br /> == Enabling the Map Editor ==<br /> To enable the '''Map Editor''' add the “-modding” (without the quotes) to the Launch Options for the game (in Steam, right-click the game, go to Properties, click Set Launch Options in the General tab). That will add a Map Editor button to Modding menu of the game. From there you can decide if you want to modify an existing map, or create a new one. If you create a new one the menu to the right is presented. If you are going to edit an existing map, you should make a copy of the original map and modify the duplicate with a new name.<br /> <br /> DX11 should be used with the Map Editor as running DX12 will cause issues where objects such as the cursor don't properly display. Running windowed mode will also make it easier if you have issues and need to force close the game.<br /> <br /> == New Map Options ==<br /> [[File:New Map Menu.jpg|thumb]]<br /> <br /> When creating a new map, there's several options to choose from:<br /> <br /> *'''Map Name''' - The name the map shows up as in-game. This can be changed later on simply renaming the map folder, so don't stress about getting the perfect name when you are first starting. <br /> *'''Map Size''' - 12/24/36/48/72/96 correlates to Arena(Currently not used),Tiny,Small,Medium,Large,Enormous.<br /> *'''Terrain Synth Type''' - Effects textures of the map. Just leave this at 1 as changing it can cause issues.<br /> *'''Cell Size''' - The smaller the cell size, the smaller terrain objects you can place but will increase map size. I'd recommend you leave this at default of 400 to avoid issues, and the difference is negligible. <br /> *'''Terrain Type''' - The type of map terrain used, such as snow or desert. This can be changed later.<br /> *'''Light Environment &amp; Sky Background''' - These change the lightning profiles used, such as if a map is during the day or night. Changing these on Volanic, Crystal and Turinium Terrain Types will cause a crashe.<br /> <br /> == Map Editor Commands ==<br /> <br /> *'''File''' - This is where you can edit the MapProperties.xml file for increasing Turinium Requirements, go to the folder where the map information is stored or exit the Map Editor. <br /> *'''Show/Hide Help''' - This displays some useful information for using the Map Editor. I have it set to display help in the above screenshot. <br /> <br /> *'''Toggle Display Mode''' - This changes how you are viewing the map. In the above screenshot I’m not looking at modeled terrain. It’s often easier to layout the map in this mode. But you can switch over to realistic terrain if you want to see exactly what your map would look like to the player. <br /> *'''Enable Symmetry''' - Enable this if you want your terrain painting to be symmetrical. If it is set you can choose to make is symmetrically mirrored or use a radial symmetry for multiple equal positions. <br /> *'''Terran/Desert/Frozen/Volcanic/Crystal/Turinium''' - This is quite misleading, this is supposed to let you change terrain setting but this doesn't stay after you saved the file. To actually change the the map from terran to desert you need to edit the GraphicsSettings.csv file with Notepad++. A much easier way of doing this is just copying the GraphicsSetting.csv file from another map that has the desired terrain setting. <br /> <br /> *'''Brush Size''' - When painting terrain or cosmetics this is the brush size you would like to use. ''Also [ctrl+mousewheel]'' <br /> *'''Edit Terrain''' - Chose the terrain type to paint from 7 base terrains: <br /> **'''Plains''' - Normal ground <br /> **'''Plateau''' - Higher ground that the player can still move and build on. Height is an advantage for many units so plateaus generally make for good defensive positions. <br /> **'''Hill''' - Hills connect Plains and Plateaus. Use them to determine where players can access one elevation from the other. <br /> **'''Mountain''' - Mountains are impassable by anything except flying units. Use them to block parts of the map. <br /> **'''Basin''' - Basins are also impassable to anything except for flying units. But units with long enough range can fire across basins. <br /> **'''Highlands''' - Like Plateaus, but higher. Connect them to other terrain types with Hills. <br /> **'''Lowlands''' - Like Plains, but lower. Connect them to other terrain types with Hills. <br /> <br /> &amp;nbsp;<br /> <br /> *'''Edit Buildings''' - Use this to place the following on the map: <br /> **'''Player Seed''' - A player's Nexus, their starting location. <br /> **'''Relay''' - The heart of a region. Surround it with Metal and Radioactive deposits to decide what that region offer. <br /> **'''Turinium_Generator''' - This is a special type of power generator that can provide victory points. <br /> **'''Metal_Deposit''' - Provides Metal for the player who owns this region. <br /> **'''Radioactive_Deposit''' - Provides Radioactives for the player who owns this region. <br /> **'''Artifact''' - Ignore this, it's not functional.<br /> **'''Scale Unit''' - Ignore this, it's not functional and just causes crashes.<br /> **'''Dead Region''' - Determines the connection between regions. Useful for setting up cutoffs.<br /> <br /> &amp;nbsp;<br /> <br /> *'''Edit Cosmetic''' - Place alternate ground textures. This makes the map look more detailed and varied, it is recommended you use lots of cosmetics all over the map. '''NOTE: Turn off symmetry when editing cosmetic details!''' <br /> *'''Edit Effects''' - Place particle (Smoke) effects on the map. This is currently experimental and I recommend you don't use any of these as it can cause crashes<br /> *'''Build Quality''' - Determines the texture quality generated on the map. Raising this will increase the amount of time and memory required to generate the terrain, so leave it at 1 while testing. Stardock generates at terrain quality 3 or 4 for our final maps. Anything higher than 4 will probably crash your machine. The larger the map size, the longer and more difficult it is to render. Small maps render out at 4, large maps at 3. <br /> *'''Erosion''' - Affects texture quality. I'd recommend just leaving this at its default else raising it can cause issues.<br /> *'''Terrain Synth''' - The style of slopes and mountains generated by the erosion simulation. I'd recommend leaving it at 1 and 2 as anything else is experimental and may cause issues.<br /> *'''Rebuild Terrain''' - This regenerates the map with any changes you have made so you can see how they look. This is effectively &quot;saving&quot; the map.<br /> *'''Regionalize / Save Cells''' - Reloads map settings, but doesn't regenerate map changes. This is only useful for updating Turinium Requirement changes.<br /> <br /> == Map Example ==<br /> <br /> I selected Terran (grassland) terrain and default Lighting. As you will see in the demo I change to Frozen Terrain later, it’s easy to do so don’t worry too much about your selection here.<br /> <br /> The following is the default map that you are given. It starts with two player Nexuses, a Turinium Generator and one other region. But we have lots of things we can add.<br /> <br /> [[File:ModGuide 3.png|thumb|right|200px|Logical view of a super-basic map]]<br /> <br /> Teal is plateau, red is mountains, blue is basins, yellow is hills and the green is plains.<br /> <br /> The player Nexuses are in the upper right and the lower left. The point of this map was to create a single channel for the players to battle through. The upper part is biased for the player on the left, giving him a plateau to fire down at enemy units driving by the area below and the reverse for the southern part of the map.<br /> <br /> There are three Turinium_Generators, one in the center of the map and one on each of the two plateaus overlooking the plains pass. The goal is to make one Turinium Generator easy for each player to grab so they need to battle over the one in the center (since victory points are awarded to the player who holds the majority of generators).<br /> <br /> [[File:ModGuide 4.png|thumb|right|200px|Basic map after terrain generation]]<br /> <br /> Rebuilding the terrain and toggling to map display mode gives us a look at what the map will look like. I like the pass, the mountains and the basin. But the rest looks a little bare. So I need to add more details to make that area more interesting. I often forget how big the Ashes maps are, so when I toggle to the real map they don’t seem as full as I imagined.<br /> <br /> [[File:ModGuide 5.png|thumb|right|200px|Better map - logical view]]<br /> <br /> In this update I’ve added more opportunities for the defending player. The overlooking plateaus can only be accessed from the Nexus region so they get to attack in the central channel as well as attacking units forced to come by the plateau wall on their way to the Nexus.<br /> <br /> [[File:ModGuide 6.png|thumb|right|200px|Better map - terrain view]]<br /> <br /> I’ve also switched it over to the Frozen terrain. I think its brutal hostility fits the maps focus better. I put the build quality up to 4 and increased the erosion levels so it looks great. It took a lot more time to generate (btw: don’t attempt to use high build levels on the largest possible maps unless you have a lot of memory) but it looks great.<br /> <br /> This map is a lot of fun to play, but may favor aircraft too strongly (since they can bypass all of these defense and attack anywhere. In a later section we will talk about creating scripts where we could do things like disable aircraft so the players are forced to slug it out.<br /> <br /> == Updating Turinium Requirements ==<br /> <br /> By default, maps will have lowTurinium Requirements. (How much Turinium is required for players to win.) To increase this, select &quot;Edit MapProperties.xml&quot; under the &quot;File&quot; menu in the top left corner, and change the number inside the victory_point_cap=&quot;500&quot; to the desired Turinium. (Using Notepad++ is recommended) Save the .xml file, but the Turinium levels won't be updated until you open up the map again in the Map Editor, and Regionalize or Regenerate the map terrain. Regionalize is much faster than Regnerate, and is all you need to do for the purpose of updating Turinium. To check a maps Turinium requirements, you can also play the map in a Skirmish and in the top right corner you will see a Turinium value in the player panel.<br /> <br /> == Distributing Maps ==<br /> Maps will not be downloaded when a player joins a lobby that is on a new or edited map, attempting to start the match will result in a crash. A modder will need to upload their map to a web hosting platform such as Dropbox, and everyone wishing to play that map will have to manually download and install the map into \Steamapps\common\Ashes of the Singularity Escalation\Assets\Maps. Every time that map receives a change, even if the name remains the same, it will have to be redownoaded. We don't currently have Steam Workshop support enabled for Ashes, but it is something we are hoping for.<br /> <br /> == Fixing Issues ==<br /> <br /> The current form of the Map Editor wasn't intended for public use, which is why it's hidden behind the -modding command. The Map Editor is rough and a number of unintuitive things can cause crashes with no explanation to the user, causing much frustration. There's a number of things the Map Editor doesn't like which can cause crashes during regenerating terrain or loading into it. Alternative to crashes, problems can also be manifested by the map editor endlessly hanging at regenerating terrain. (If you check your CPU usage, you can tell when the terrain generation is actually working or when it has frozen.) If you are experiencing a crash or map editor being stuck during terrain generation, ensure none of these things are happening:<br /> <br /> *'''Buildings are on Mountain, Hill or Basin''' - Buildings shouldn't be placed on all terrain types.<br /> *'''Too many Effects''' - Effects are experimental and can cause crashes if there's too many of them. Remove all effects and see if the crash persists.<br /> *'''Adjacent Terrain Types''' - Placing different terrain types adjacent can cause a crash. This is hard to identify, but if you have Plateau, Lowlands and Basin all connected next to each other, it can cause a crash.<br /> *'''Terrain Quality too high''' - Try lowering the Terrain quality to 1 and see if it still crashes during render.<br /> *'''Buildings hanging over map edge''' - Ensure none of the buildings are hanging over the edge of the map, this can especially happen with the Dead Regions.<br /> *'''Sky Background incompatible with Terrain Type''' - This is easy to identify because the crash will occur when you place a Nexus. The Sky Background options seem to be incompatible with the newer Terrain Types introduced in Escalation such as Crystal, Lava, Turinium. Create a new map with default Sky Background settings.<br /> *'''Crashing When Loading a Map or Creating New One''' If your game is reliably crashing when creating or loading a map, make sure you have virtual memory (paging file) disabled.<br /> *'''Black Lines Issue''' - Sometimes a map won't generate properly, and when you open the map in-game it will have a giant black line throughout the map. If this happens, regenerate the terrain and it will fix it most of the time. If regenerating doesn't fix this issue, you may need to flatten out that effected area then redraw it.<br /> <br /> == Changing Map Thumbnail ==<br /> <br /> Regenerating Terrain will automatically create a map thumbnail MapPreview.dds in the map directory which shows up in the map selection menu and in the in-game minimap. However, the default generated thumbnails are quite messy compared to ones which are manually created, which is what every map in the game uses. Creating a release quality map thumbmail involves a few steps, require some basic knowledge of either Adobe Photoshop or GIMP (which is a free alternative), downloading [https://1drv.ms/i/s!AvSWhdBjPNfkvTAkISVNYVZPSXxT this map preview shade] and will require the [http://gametechdev.github.io/Intel-Texture-Works-Plugin/ Intel .DDS plugin] to save the thumbnail to the required format.<br /> <br /> <br /> '''Take Screenshot:'''<br /> *'''Opt-in to a Modding build under steam betas to enable the developer tools'''<br /> *'''Click “Skirmish” on the Game Menu'''<br /> *'''Start a game on the map you need to Screenshot'''<br /> *'''Open up the developer tools by pressing ` or HOME'''<br /> *'''With Developer Tools open (Top left corner will have two small grey boxes and a third longer grey box'''<br /> *'''Click on the second small box out from the corner'''<br /> *'''Check the box for &quot;DebugPlayerPanel&quot;'''<br /> *'''Wait for the fog to clear/lighting to normalize.''' - Large maps sometimes cause your machine to freak out here and show weird graphic glitches, but they should time out<br /> *'''Hit ESC to Pause the game'''<br /> *'''Check the box for &quot;Screen Shot View&quot;'''<br /> *'''Close Developer Tools ( ` or HOME )'''<br /> *'''Capture a screenshot of the entire map'''<br /> [[File:ScreenShotView.png|center|frame|Screen Shot View]]<br /> <br /> '''Edit Screenshot:'''<br /> *'''Open screenshot of map in Photoshop or GIMP '''<br /> *'''Crop your shot down to just the map terrain''' - (a little black at the very edges is okay.)<br /> *'''Resize it to 512x512 pixels EXACTLY '''<br /> *'''Boost saturation or curves''' - This is optional, but in some map types you may want to lighten up the thumbnail to make it look nicer, this is done is almost all of the existing maps and is especially important in Crystal or Turinium maps.<br /> *'''Add the map preview shade as a new layer'''<br /> *'''Merge the layers'''<br /> *'''Export as MapPreview.dds in map directory''' - (no mipmaps. Must have this filename exactly, will overwrite existing one) The .dds file format will only appear if you have currently installed the intel .dds texture plugin.<br /> <br /> You should now see this much nicer thumbnail when you load the game. Regenerating the map will automatically create a new MapPreview.dds file which will overwrite the fancy one you have made, to prevent this you can right click on it, properties and choose Read Only so it won't be overwritten. If you change the terrain layout of the map you will want to create a new thumbnail, but if you are only changing the building layout there is no need to change the thumbnail.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9620 2018-03-13T07:13:49Z

<p>AlphonsoHornibro: /* Scripting – Creating Scenarios */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. [[Missions (scripting)|Click here]] to see the full list of what can be configured in mission scripting.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9619 2018-03-13T07:13:06Z

<p>AlphonsoHornibro: /* Scripting – Creating Scenarios */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.[[Click here|missions]]) to see the full list of what can be configured in mission scripting.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> <br /> <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9618 2018-03-13T07:11:56Z

<p>AlphonsoHornibro: /* Mission Definition */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. [[Click here]http://wiki.ashesofthesingularity.com/index.php/Missions_](scripting) for the full list of what can be configured in mission scripting.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> <br /> <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9617 2018-03-13T07:11:32Z

<p>AlphonsoHornibro: /* Mission Definition */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. [[Click here]]http://wiki.ashesofthesingularity.com/index.php/Missions_(scripting) for the full list of what can be configured in mission scripting.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> <br /> <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Script_Commands&diff=9616 2018-03-13T07:09:14Z

<p>AlphonsoHornibro: </p> <hr /> <div><br /> Commands are used within [[Triggers|triggers]] to create gameplay effects, from revealing locations to spawning attack waves or even changing an AI's difficulty mid-game.<br /> <br /> == List of Commands ==<br /> <br /> === [[ActivateTrigger|ActivateTrigger]] ===<br /> <br /> Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger).<br /> <br /> *'''Target''' - This is the name of another trigger that will be set from Inactive to Active. <br /> <br /> === [[AreaIndicator|AreaIndicator]] ===<br /> <br /> This places a visible indicator on the map to help the player know where they should go to.<br /> <br /> *'''Name''' - The name of the area. <br /> *'''Position''' - The center of the area. <br /> *'''Color''' - The color the area indicator is. [ Green | Blue | Red ] <br /> *'''Size''' - How big the area indicator will be. <br /> *'''Duration''' - How long the area indicator should last, -1 means that it lasts forever. <br /> <br /> === [[AttackAttackMove|AttackAttackMove]] ===<br /> <br /> Order an army to move to a specific area, engaging enemies along the way.<br /> <br /> *'''Name''' - The name of the army that will be given the order. <br /> *'''Repeat''' - Whether to repeat the order. Use with multiple AttackAttackMove commands to create a patrol path. <br /> *'''Position''' - Where the army is ordered to move to. <br /> <br /> === [[AttackUnit|AttackUnit]] ===<br /> <br /> Order an army to attack a specific script-spawned unit<br /> <br /> *'''Name''' - The name of the unit to do the attacking <br /> *'''Target''' - The name of the unit to be attacked <br /> <br /> === [[Camera|Camera]] ===<br /> <br /> Move the player's view to a specific area.<br /> <br /> *'''Position''' - Where the camera will be looking. <br /> *'''Snap''' - Set to 1 to move the camera instantly, instead of panning <br /> *'''Speed''' - Scalar for how fast the camera will move, compared to clicking on the minimap. 0.5 for half speed, 2 for double, etc. <br /> *'''Unit''' - Follow a specific script-spawned unit. Do not use Position if you use this. <br /> *'''Building''' - Follow a specific script-spawned building. Do not use Position if you use this. <br /> *'''Save''' - Save the current camera settings. Useful if you want to show the player something and then move the camera back to whatever they were looking at. <br /> *'''Load''' - Load the last saved camera settings. Use with Save. May cause a crash if you haven't previously saved a camera position. <br /> *'''RTP''' - Distance, rotation and pitch of the camera. <br /> **The first number is distance. 1000 is a fairly tight shot, 2500 is a fairly typical gameplay zoom <br /> **Second number is rotation. 0 points the camera north, 90 east, 180 south, 270 west. <br /> **Third number is pitch. 40-50 are typical gameplay angles. 90 would be straight down. Note that anything lower than 40 can cause the engine to load a '''lot''' more terrain and models than it's designed to, so use with caution. <br /> <br /> === [[CaptureNearest|CaptureNearest]] ===<br /> <br /> Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there)<br /> <br /> *'''Name''' - The name of the unit to do the capturing <br /> *'''Repeat''' - Whether to repeat the order (indefinitely) <br /> <br /> === [[CaptureNearestNext|CaptureNearestNext]] ===<br /> <br /> Order an army to capture the nearest neutral or enemy-controlled region<br /> <br /> *'''Name''' - The name of the unit to do the capturing <br /> *'''Repeat''' - Whether to repeat the order (indefinitely) <br /> <br /> === [[ChangeAIDifficulty|ChangeAIDifficulty]] ===<br /> <br /> Change an AI player's difficulty setting<br /> <br /> *'''Player''' - The index of the player to change <br /> *'''Difficulty''' - The name of the difficulty to set it to <br /> <br /> === [[ChangeAIPersonality|ChangeAIPersonality]] ===<br /> <br /> Change an AI player's personality<br /> <br /> *'''Player''' - The index of the player to change <br /> *'''Name''' - The name of the personality to set it to (defined in \Assets\GameCore\DefaultPlayerAI.xml) <br /> <br /> === [[DestroyBuilding|DestroyBuilding]] ===<br /> <br /> Destroys a specific script-spawned building.<br /> <br /> *'''Name''' - The name of the building to be destroyed. <br /> <br /> === [[DestroyUnit|DestroyUnit]] ===<br /> <br /> Destroys a specific script-spawned unit.<br /> <br /> *'''Name''' - The name of the unit to be destroyed. <br /> <br /> === [[Dialog|Dialog]] ===<br /> <br /> This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags.<br /> <br /> === [[Entry|Entry]] ===<br /> <br /> The actual text that will be displayed. Use only within &lt;Dialog&gt; tags.<br /> <br /> *'''Text''' - The actual text that is displayed. Corresponds to an entry in a .csv file in \Assets\UIText\ <br /> *'''Icon''' - The icon used with the text popup. Hard-coded to correspond to Ashes characters, and changes the text color to match. <br /> **Mac <br /> **Haalee <br /> **Vexen <br /> **Valen <br /> **Artix <br /> **Ventrix <br /> **Athena <br /> **Narrator<br /> **Agememnon <br /> **Agethon <br /> <br /> === [[EndMission|EndMission]] ===<br /> <br /> Use to force a win or loss of the scenario.<br /> <br /> *'''Victory''' - Set to 0 to lose the scenario or 1 to win. <br /> *'''String''' - The text that is displayed. <br /> <br /> === [[GrantStuff|GrantStuff]] ===<br /> <br /> Give a player free resources.<br /> <br /> *'''Player''' - The index of the player to be hooked up <br /> *'''Metal''' - The amount of metal being granted. <br /> *'''Quanta''' - The amount of quanta being granted. <br /> *'''Radioactives''' - The amount of radioactives being granted. <br /> *'''Turinium''' - The amount of victory points being granted. <br /> <br /> === [[GrantTech|GrantTech]] ===<br /> <br /> Give a player a free Quantum Upgrade<br /> <br /> *'''Player''' - The index of the player to be hooked up <br /> *'''Tech''' - The upgrade to grant [ HPs | Weapons | Radar | BuildingHPs | MetalStorage | RadsStorage | NexusHPs ]<br /> <br /> === [[HidePanel|HidePanel]] ===<br /> <br /> Hide UI panels.<br /> <br /> *'''HidePlayer''' - Hide the Player panel <br /> *'''HideRank''' - Hide the Rank panel <br /> *'''HideResource''' - Hide the Resource panel <br /> <br /> === [[LetterBox|LetterBox]] ===<br /> <br /> Disable commands and go to a cinematic, letterbox view.<br /> <br /> *'''Enable''' - 1 to turn letterbox mode on, 0 to turn it off <br /> *'''Snap''' - 1 to immediately go to/from letterbox mode instead of fading in/out <br /> <br /> === [[MoveUnit|MoveUnit]] ===<br /> <br /> Move an army to a location without stopping to fight<br /> <br /> *'''Name''' - Name of the unit to be moved <br /> *'''Position''' - x/y coordinates to move to <br /> *'''Repeat''' - 1 to repeat this command indefinitely. Use with multiple MoveUnit commands to create a patrol path. <br /> *'''Stop''' - 1 to stop the unit <br /> <br /> === [[Objective|Objective]] ===<br /> <br /> Use this to set objective notifications for the player (so they know what to do).<br /> <br /> *'''Name''' - The name of the objective, use this name when checking or hiding it. <br /> *'''Hide''' - If this objective should be hidden or not, usually this means the objective is complete. <br /> *'''String''' - What the objective displays on the screen. <br /> *'''SetCheck''' - If the objective checkbox is checked or not. <br /> <br /> === [[Restrict|Restrict]] ===<br /> <br /> To block the player from being able to access objects in the game.<br /> <br /> *'''Type''' - Unit, Building, Research or Orbital. Whatever type of object that is being restricted. <br /> *'''ID''' - The name of the object being restricted. <br /> *'''Enable''' - Set this to 1 to enable the object. You can use this to restrict something early in the scenario and then enable it later on (for example: when the player accomplishes an objective or after a set amount of time). <br /> <br /> === [[Reveal|Reveal]] ===<br /> <br /> Reveal the fog of war over a location<br /> <br /> *'''Name''' - The name of this reveal (so you can modify it with a later command) <br /> *'''Enable''' - 1 to enable, 0 to disable <br /> *'''Position''' - x/y coordinates of the center of the revealed area <br /> *'''Size''' - Radius of the area to be revealed <br /> *'''RadarSize''' - Use to add a radar component to the reveal. Can be used with Size=&quot;0&quot; to create a radar-only reveal <br /> <br /> === [[SpawnBuilding|SpawnBuilding]] ===<br /> <br /> Places a building on the map.<br /> <br /> *'''Name''' - The name you assign to the building. <br /> *'''Template''' - The name of the building type being created. <br /> *'''Player''' - The player who will own the building. <br /> *'''Position''' - Where the building will be placed. <br /> *'''NoDeath''' - Set this to &quot;1&quot; to make the unit immortal (you can still kill it with a scripted DestroyBuilding command) <br /> <br /> === [[SpawnUnit|SpawnUnit]] ===<br /> <br /> Places a unit on the map.<br /> <br /> *'''Name''' - The name you assign to the unit. <br /> *'''Parent''' - The army the unit will belong to (used to make it easier to issue moves). <br /> *'''Template''' - The type of unit being created. <br /> *'''Player''' - The player that will own the unit. <br /> *'''Position''' - Where the unit will be created. <br /> <br /> === [[Var_Command|Var]] ===<br /> <br /> Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> *'''Name''' - Name of the variable <br /> *'''Value''' - The value to be used in the operation <br /> *'''Min''' - Minimum value for random functions <br /> *'''Max''' - Maximum value for random functions <br /> *'''Operation''' - Operation to be performed <br /> **&quot;=&quot; or &quot;Set&quot; - set to the value <br /> **&quot;+&quot; or &quot;Add&quot; - add value <br /> **&quot;-&quot; or &quot;Sub&quot; - subtract value <br /> **&quot;Rand&quot; or &quot;SetRand&quot; - set to a random value between Min and Max <br /> **&quot;AddRand&quot; - add a random value between Min and Max <br /> **&quot;SubRand&quot; - subtract a random value between Min and Max <br /> <br /> [[Category:Modding]] [[Category:Commands]]</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Modders_Guide&diff=9614 2018-03-09T05:27:08Z

<p>AlphonsoHornibro: /* Current Limitations (Ashes 2.7) */</p> <hr /> <div><br /> This page provides information for players looking to create mods for the game. We have separate guides for the [[Map Editor]] and [[Scenario Editor]]<br /> <br /> <br /> Ashes of the Singularity gives you access to a powerful strategy game engine to create your own scenarios, objects and worlds. The designers have had a lot of fun creating scenarios for the game, and you will have access to the same features they had to create your own.<br /> <br /> There is a lot to do in Ashes. But it was also built from the ground up to be mod friendly. Modders have access to the gameplay elements to change and tweak as they desire. This document will introduce some of what is possible, and we will make a map and a mod to take advantage of this.<br /> <br /> This is not always going to be a managed and curated editor with limited options. You can mod the game the same way the developers make changes to the game. Editors are nice because they typically keep you from doing “bad” things. But they also keep you from doing incredibly good things. An editor only allows you to do the things the developer set up for you to change. With direct access to the files you can do things the developer never expected. Sometimes that turns out horribly (okay, a lot of the time that turns out horribly), but sometimes it turns out brilliantly. We believe power trumps ease of use.<br /> <br /> <br /> <br /> == Moddable Game Files ==<br /> <br /> Just as with the Map Editor, to enable the game modifications add the “-modding” (without the quotes) to the Launch Options for the game (in Steam, right-click the game, go to Properties, click Set Launch Options in the General tab). That will add a Modifications&amp;nbsp;button to the main menu of the game. You will not be able to play multiplayer if you are using Mods.<br /> <br /> The game supports modding the directories Modders would be most interested in. These are:<br /> <br /> *'''GameCore'''- The home of the most critical files, definitions for all the games units, buildings, weapons, orbital abilties, etc. This directory isn't additive, you make changes by replacing the file you want to change with a new one. For example, if you want to modify the hit poitns on the Zeus your mod will need to include a new UnitTemplates.csv file with the hit point value for the Zeus changed. <br /> *'''Maps'''- For adding new maps with the mod. <br /> *'''Scenario'''- For adding new scenarios with the&amp;nbsp;mod. It is possible to modify existing scenarios with mods (by using the same name as that scenario file) but adding new scnearios with new names will be more common. <br /> *'''UI'''- So a modder can add new art refered to by the Scenario file. <br /> *'''UIText'''- For adding or changing existing text. Files placed here are additive (they don't need to replace an existing file). If you want to change a text string from the base game just include that string in your new text file and it will overwrite it. <br /> <br /> To create a mod add a directory in your My Games/Ashes of the Singularity - Escalation/Mods/ directory with the name of the mod you would like to use.<br /> <br /> [[File:ModDir.png|RTENOTITLE]]<br /> <br /> In the above example the name of the Mod is BalanceMod. There is an index.ashesmod file that is a text file that contains the details about the mod. When you start the game it will create a generic one for you but the format is as follows:<br /> &lt;blockquote&gt;[AshesMod]&lt;br /&gt; Name=Balance Mod&lt;br /&gt; Author=Rob Brink&lt;br /&gt; Description=This is a Balance mod that also includes the Weehawken Scenario.&lt;br /&gt; Version=1.1.10&lt;/blockquote&gt; <br /> This is purely informational, its what is displayed by the mod on the mod screen.<br /> <br /> '''[[File:ModScreen.png|right|300px|ModScreen.png]]'''<br /> <br /> '''Note:''' Ashes can’t use a file if it is locked. If you have a file open with Excel and try to start Ashes, the game will likely crash. Close the file before starting Ashes.<br /> <br /> To use a mod go into the Modification screen from the main menu. You will see all of your Mods here and you can enable or disable them, and change the order they load in. &amp;nbsp;This can also be changed by editing the&amp;nbsp;My Games/Ashes of the Singularity - Escalation/Mods.ini file.<br /> <br /> === Notable Files for Modding ===<br /> <br /> All files for modding are found in the Steamapps\Common\Ashes\Assets\ directory. Any text editor can be used, but I'd recommend using a free program called CSVed as it'll make viewing and modifying values much easier. (If using CSVed enable &quot;Use Start Row as Column Captions)<br /> <br /> The following files are the primary ones responsible for major gameplay changes:<br /> * '''\GameCore\BuffTemplates.csv''' - Controls the value of Dreadnought buffs.<br /> * '''\GameCore\[[BuildingTemplates.csv]]''' - Controls build time, cost, armor, HP, and more for all buildings.<br /> * '''\GameCore\BuildingUpgrades.csv''' - Upgrade path for base defenses.<br /> * '''\GameCore\DefaultPlayerAI.xml''' - Controls difficulty handicaps, personality types and armies built by the AI.<br /> * '''\GameCore\Research.csv''' - Pricing of Quantum Upgrades.<br /> * '''\GameCore\UnitPanel.csv''' - Controls the interface of build menus. <br /> * '''\GameCore\[[UnitTemplates.csv]]''' - Controls build time, cost, armor, HP, and more for all units.<br /> <br /> * '''\GameCore\WeaponVisual.csv''' - Controls visual weapon alignment and other weapon cosmetics.<br /> * '''\GameCore\ModuleTemplates\BuildingModules\''Sample.csv''''' - Controls which weapons and ConstructionModules structures have.<br /> * '''\GameCore\ModuleTemplates\UnitModules\''Sample.csv''''' - Controls which weapons, ConstructionModule and SteeringModules units have.<br /> * '''\GameCore\ModuleTemplates\ConstructionModuleTemplates.csv''' - Controls which ConstructionLists a ConstructionModule uses.<br /> * '''\GameCore\ModuleTemplates\DroneBayModuleTemplates.csv''' - Controls which drones or other units are spawned by units such as Drone Hives.<br /> <br /> * '''\GameCore\ModuleTemplates\ResourceModuleTemplates.csv''' - Controls the amount of resources and storage generated by structures and upgrades.<br /> <br /> * '''\GameCore\ModuleTemplates\[[SteeringModuleTemplates.csv]]''' - Controls the movement behaviour of units when engaging the enemy such as desired attack range.<br /> <br /> * '''\GameCore\ModuleTemplates\[[WeaponModuleTemplates.csv]]''' - Controls rate of fire, range, targeting priority, damage, and everything else for all weapons. Orbital Abilities and healing weapons are also included here.<br /> * '''\GameCore\ModuleTemplates\ConstructionLists\''Sample.csv''''' - Controls what units and structures are build able in a ConstructionLists.<br /> * '''\Formations\FlockerTemplates.csv''' - Controls movement profiles for units.<br /> * '''\Physics\RigidBodyTemplates.csv''' - Controls physics for units, affecting things such as pathing.<br /> * '''\UIText\BuildingText.csv''' - Holds text strings used for in-game display of building names and descriptions<br /> * '''\UIText\UnitText.csv''' - Holds text strings used for in-game display of unit names and descriptions<br /> * '''\UIText\ModuleText.csv''' - Holds text strings used for in-game display of weapon modules and Orbital Abilities<br /> * '''\UIText\Text.csv''' - Holds text strings used for game UI and other miscellaneous things. <br /> <br /> === File Mod Example ===<br /> <br /> There are a lot of files, with a lot of fields that can be tweaked and changed. For this demo we are going to mess with my favorite file, '''[[UnitTemplates.csv|UnitTemplates.csv]]'''.<br /> <br /> [[File:ModGuide 8.png|thumb|right|200px|UnitTemplates.csv]]<br /> <br /> In this screenshot I’ve opened [[UnitTemplates.csv|UnitTemplates.csv]] with Excel, because it makes it easier for me to work with, but Excel isn’t required. Notepad could be used to modify the file. If you use Excel remember to save it as a csv file.<br /> <br /> There are a lot of fields that can be modified. In this screenshot we can see:<br /> <br /> *Max HPs <br /> *Max Energy <br /> *Energy Per Second <br /> *Armor <br /> *Heal Rate <br /> *Max Shields <br /> *Shield Regen Rate <br /> *Radar Radius <br /> *Cost Metal <br /> *Cost Data <br /> *Cost Energy <br /> *Cost Logistics <br /> *Construction Time <br /> <br /> Some of these fields aren’t named the same as they are in game. Names change during the course of development, and we didn’t want to go back and change all these definitions to match each time they do. Because of that you may have to experiment a bit to see how things match. For example, PHC_Smarty is the Smarty System, and Cost Data is actually the Radioactive cost of the unit. You can check out the translation tables in ..\Ashes of the Singularity\Assets\UIText\ directory to see how raw assets relate to in game assets.<br /> <br /> Using this file alone, and just the things in this screenshot (there are many more fields in UnitTemplates.csv) we can dramatically alter the balance and design of the game. Let’s use the above to create a new game variant I call the '''Swarm Mod'''.<br /> <br /> I love the scale of Ashes, I love large battles. So this mod is going to make even larger battles possible and we are going to get into them fast. To do that I’m going to make the following changes:<br /> <br /> [[File:ModGuide 9.png|thumb|right|200px|UnitTemplates.csv, modded]]<br /> <br /> I’ve reduced the Metal, Radioactives, Logistics and Construction time costs by 90%. I’ve reduce the Logistics costs of T1 units to 0 (so you can have as many as you want). With these changes factories should produce 10 units in the time it took to produce 1 before. As long as you can keep feeding the (dramatically reduced) resource costs, units should come out of factories in an endless stream, like a tower defense game on steroids.<br /> <br /> There are a lot of ways to tweak this concept. I could have kept the Metal and Radioactive costs the same and then the player would be strongly incented to claim and upgrade regions to keep his factories fed. I could have just halved the costs rather than dropping them by 90%. I could have increased the resource gathering rates of upgraded metal and radioactive mines rather than lowering costs to incent players to invest in their regions.<br /> <br /> But for this we are going crazy. Everything gets very cheap. Massive armies can be built from the start of the game. Those poor creeps won’t know what hit them. And be prepared to be sieged by thousands of units.<br /> <br /> [[File:ModGuide 10.png|thumb|right|200px|Swarms of frigates!]]<br /> <br /> This is 5 minutes into the game. I only have 2 factories putting out an endless stream of Brutes. I make an army out of them and in the time it takes to do that there are a bunch more waiting to be added. So I find that it works just as well to set the rally point of the factory to where I want to attack, so that my river of death flows out to destroy it.<br /> <br /> [[File:ModGuide 11.png|thumb|right|200px|Pew! Pew pew!]]<br /> <br /> The AI has adapted to the new lower costs and is meeting my endless streams with its own. Unlike me it has opted to go with some cheaply produced dreadnoughts. The game lasts for 45 minutes, and there is a battle waging between my endless armies and his at this chokepoint for nearly all of it. It isn’t until I win more minor battles on some of outskirt regions (to take the resources which even at 90% off still become critical) and I send a strike force around to take out his factories that I cause his production chain to falter and begin to break through.<br /> <br /> [[File:ModGuide 12.png|thumb|right|200px|Pewpewpew!]]<br /> <br /> I had to adjust away from my typical [[Artemis|Artemis]] (long range missile ships) to Nemesis (which are really good against enemy dreadnoughts) to be able to begin killing them faster than he could produce them. I also needed to invest heavily in anti-air [[Apollo|Apollos]] to counter the AI’s strike fleets of aircraft that nearly cost me the game.<br /> <br /> Once the lines were broken I turned the biggest Ashes armada I had ever controlled against his Nexus. There were a lot of dreadnoughts fighting their way up that hill, and the explosions, missile trails and laser blasts cut through and won me the game.<br /> <br /> Overall it is amazing how much game play can change with these changes. If I were to do it again I might keep the reduced cost overall, but maybe just 50% off rather than 90%. I liked the larger armies, but it was a crazy experience more like fighting a fire than playing chess.<br /> <br /> If you decide to modify the csv files with a text editor (Notepad++ is my text editor of choice) you can do everything I was doing in Excel, it just isn’t formatted into columns to be easy to read. Instead it is raw text like the following:<br /> <br /> [[File:ModGuide 13.png|thumb|right|200px|A .csv file in Notepad++]]<br /> <br /> Modifying the files this way works, you just need to count the amount of fields, remembering that commas separate the fields (CSV stands for Comma Separated Values) to get to the right values.<br /> <br /> === Adding a new Map to a Mod ===<br /> <br /> It is also possible to add a custom map to a Mod. &amp;nbsp;The in-game map editor will always create a map in the default \Assets\Maps\&lt;mapname&gt; directory. &amp;nbsp;To include that map in your mod, once created you'll need to move the entire map directory into your &lt;ModName&gt;\Maps directory. &amp;nbsp;Once the map is in the mod directory and the game is restarted, the Map Editor will be able to edit the map directly from the mod directory.<br /> <br /> === Current Limitations (Ashes 2.7) ===<br /> <br /> The Ashes developers are working to expand Modding support, however there are a few significant limtations to the existing modification support.<br /> <br /> The following files from the Ashes \Assets\ directory are currently NOT modifiable.<br /> <br /> *'''\Audio\''': Contains the audio used for in game effects and voice overs. <br /> *'''\Units\''': Contains the models and textures for all the units in the game. <br /> *'''\Buildings\''': Contains the models and textures for all the buildings in the game. <br /> Several gameplay features are currently drawn from game code and not able to be modified via the csv files:<br /> * '''Dreadnought Upgrades'''<br /> Values for Dreadnought upgrades such as the rate of regeneration or weapon damage can be modified, but changing the upgrades and their unlock sequence is not configurable.<br /> * '''Orbital Abilities'''<br /> Values for Quantum Upgrades such as the damage and cost can be modified via WeaponModules.csv, but changing the utility and availability is not configurable<br /> * '''Quantum Upgrades'''<br /> Values for the Quantum Upgrades such as the cost and bonus can be modified, but changing the utility and availability is not configurable<br /> <br /> === Safe Mode ===<br /> <br /> If your Ashes instalation with Mods gets into a state where the game fails to load. It is possible to still load the game via safe mode. &amp;nbsp;Safe mode will not load any mods, but will still present the user interface for enabling and disabling mods. &amp;nbsp;You can open the interface, disable the offending Mod, and restart Ashes in the normal mode.<br /> <br /> To start safe mode, select the option from the launch menu in steam, or add &quot;-safe&quot; to the command line arguments.<br /> <br /> == Creating New Units&amp;nbsp;(Work-in-progress) ==<br /> <br /> With Escalation 2.4, modders are&amp;nbsp;able to introduce their own custom units into the game as mods.&amp;nbsp;<br /> <br /> Adding a new unit to Ashes can be a complicated process, so to make it easier for modders to follow along with this guide, we have provided a sample mod of a custom unit&amp;nbsp;called the &quot;Little Boy&quot;. The Little Boy&amp;nbsp;&lt;ref name=&quot;Little Boy&quot;&gt;Little Boy - https://en.wikipedia.org/wiki/Little_Boy&lt;/ref&gt;, named after the&amp;nbsp;first atomic bomb deployed during World War II, is a Tier 1&amp;nbsp;unit that&amp;nbsp;shoots nuclear warheads from its single turret.&amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> Download the tools required to build a unit mod from here:&amp;nbsp;http://downloads.ashesofthesingularity.com/AshesModdingTools.zip&lt;br /&gt; Download the &quot;LittleBoy&quot; sample mod&amp;nbsp;from here:&amp;nbsp;http://downloads.ashesofthesingularity.com/AshesSampleMod.zip<br /> <br /> &amp;nbsp;<br /> <br /> <br /> === The Anatomy of a Unit ===<br /> <br /> In order for a unit to appear in-game, a series of data (used to configure the visual aspect of the unit)&amp;nbsp;and texture files must exist in the mod's folder structure. These files are:<br /> <br /> *{AssetName).FBX <br /> *Textures (these are .dds files in various formats) <br /> **Ambient Occlusion <br /> **Diffuse <br /> **Curvature <br /> **World Space Normals <br /> **Material Masks <br /> **Team Color Masks <br /> <br /> *{AssetName}.MeshDesc <br /> *{AssetName}.Palette <br /> *{AssetName}_TimelineSet.xml <br /> *Unit.AssetGroup <br /> <br /> &amp;nbsp;<br /> <br /> === The AssetGroup File ===<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === The MeshDesc File ===<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === The Palette File ===<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === The TimelineSet File ===<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> <br /> === Design Guidelines for the 3D Model ===<br /> <br /> *Unit of Measurement: Centimeters (as a point of reference, the Nemesis is 56.75 cm long) <br /> *Ideal Triangle/Quad&amp;nbsp;counts: <br /> **T1 Units:&amp;nbsp; <br /> **T2 Units: 5,000 - 15,000 tris / 2,500 - 7,500 quads <br /> **T3 Units: 40,000 - 60,000 tris / 20,000 - 30,000 quads <br /> **T4 Units:&amp;nbsp;40,000 - 60,000 tris / 20,000 - 30,000 quads <br /> **Buildings:&amp;nbsp;45,000 - 55,000 tris / 22,500 - 27,500 quads or less <br /> <br /> *All models must be exported as a .FBX file with the&amp;nbsp;triangulation option enabled. If the geometry is not triangulated, an error will be occur during the baking process. <br /> *Each mesh should have its own UV sets. <br /> *In general, every unique mesh should have it's own &quot;palette&quot; (which is represented as a record in an asset's .Palette file) and set of textures. Though, there are some cases where multiple meshes should share the same palette and texture files (i.e. a unit that has multiple guns that are identical). <br /> *Each mesh is required to have a 2nd UV set.&amp;nbsp;This 2nd UV set is used to map a faction specific overlay texture to the model. This overlay texture provides additional details to units (i.e hull patterns).&amp;nbsp;More information about&amp;nbsp;this 2nd UV set will be provided in later sections of this guide.&amp;nbsp;Best practice is to have the 2nd UV set be a copy of the primary UV set. Whenever making changes to the UVs, be sure to reflect the changes in the 2nd UV set (this will likely involve deleting the existing 2nd UV set and recreating it as a copy of the 1st). <br /> *Every model must have a top-level mesh called &quot;Root&quot;. All other meshes (i.e. guns, turrets, arms, etc.) must be child meshes beneath this parent &quot;Root&quot; mesh. <br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> <br /> === Texture Authoring Guidelines and Best Practices ===<br /> <br /> *Author your textures in 4K resolution (3840 x 2160) and scale them down from there when getting them into the game. <br /> **It is advised to NOT use 4K textures for your units in-game as they will likely have a negative impact on the performace of the game due to the large amount of VRAM needed. <br /> <br /> *Export your textures from whatever authoring software you are using (i.e. Maya, Substance Designer, etc.) in 3-channel (RGB, no alpha) .tif format. <br /> **Ashes: Escalation expects all textures used in-game to be in .DDS format, but it is a good idea to maintain a &quot;source&quot; copy of your textures in .tif format as they're much easier to iterate on than .dds files. When you're ready to get your textures into the game, you&amp;nbsp;should follow the process described in the following Required Textures and How to Convert Them To DDS Format section for how to generate the .dds version of your textures. <br /> <br /> *The best size for your textures covering&amp;nbsp;the main body portion of your new unit (most likely the &quot;Root&quot; mesh) is 2K. <br /> **Of course, there is nothing to stop you from scaling textures down even further if they looks good enough in-game at a smaller size.&amp;nbsp;But, 2K is a good starting point, and at the same time it is definitely a size you don't want to surpass. <br /> <br /> *The textures for all the other parts of your unit that are small, like turrets, should be at least 1/2 the size of the main body textures. So, if your main body textures are 2K, your turrets should be no larger than 1K. <br /> **If the turrets are small enough, it is a good idea to experiment with smaller sized textures, like 512 and 256. <br /> <br /> *Be sure your textures are sized in increments of the power of 2 so that MIPs can be properly generated during the DDS conversion process. <br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === Required Textures and How to Convert Them To DDS Format ===<br /> <br /> The following textures are required to be defined in the unit's Palette file, and must have the provided DDS format:<br /> <br /> *Ambient Occlusion - BC4_UNORM ''(ex. Root_AO.dds in the LittleBoy mod)'' <br /> *Diffuse - BC7_UNORM&amp;nbsp;''(ex. Root_Color.dds in the LittleBoy mod)'' <br /> *Curvature - BC5_UNORM ''(ex. Root_Curvature.dds in the LittleBoy mod)'' <br /> *World Space Normals - R10G10B10A2_UNORM&amp;nbsp;''(ex. Root_Normals.dds in the LittleBoy mod)'' <br /> *Team Color Masks -&amp;nbsp;BC4_UNORM&amp;nbsp;''(ex. Root_TeamColor_MaskArray.dds in the LittleBoy mod)'' <br /> *Material Masks -&amp;nbsp;BC4_UNORM&amp;nbsp;''(ex. Root_Material_MaskArray.dds in the LittleBoy mod)'' <br /> <br /> &lt;br /&gt; As a best practice, it is&amp;nbsp;recommended that you export your textures from whatever graphics authoring tool you are using (i.e. Photoshop, Substance Designer, etc.) as .tif files WITHOUT the alpha channel. TIF files make a good medium for iterating on textures, as opposed to trying to make edits to the texture in DDS format (which can be difficult to do, depending on the format).&amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> ==== The Team Color Masks Texture ====<br /> <br /> When setting up a Skirmish or a multiplayer game, the player gets to select up to 3 colors to represent their team. It is the purpose of the Team Color Mask texture to control how those 3 colors are shown on the unit in-game. A combination of these 4 separate masks make up the Team Color Masks texture:<br /> <br /> *TC1&amp;nbsp;- The primary team color mask. Anywhere there is white in this mask, team color #1 will show up. <br /> *TC2 - The secondary team color mask. Anywhere there is white in this mask, team color #2 will show up. <br /> *TC3 - The trim team color mask. Anywhere there is white in this mask, team color #3 will show up. <br /> *Decal - The decal mask. Anywhere that this mask is white, the Diffuse texture&amp;nbsp;is used&amp;nbsp;directly as the&amp;nbsp;color.&amp;nbsp;This mask is will appear on top of TC1, TC2 and TC3 and is the way you would include markings (or &quot;decals&quot;) and any other area on your unit that should remain the same color, regardless of the team colors picked by the player. <br /> <br /> &amp;nbsp;<br /> <br /> Using the OxTextureTool.exe tool, these 4 masks are combined into a single DDS file representing the TeamColorMasks texture. Within the package of files for the LittleBoy mode you will find the&amp;nbsp;\SourceArt\maps\MakeTeamColorMask.bat script file. Open up this file to see the process for converting the TC1, TC2, TC3 and Decal mask files into the correct DDS format and then how to merge those 4 DDS files into a single &quot;mask array&quot; texture file. Here are the steps (you can follow allong in the MakeTeamColorMask.bat file):<br /> <br /> #(Lines 1-9) Run the texconv.exe tool against each set of TC1, TC2, TC3 and Decal mask files created for each of your palettes (reference the \Units\PHC\LittleBoy\LittleBoy.Palette file for which Palettes have been defined for the LittleBoy mod) <br /> #(Lines 12 &amp; 13) Run the oxtexturetool.exe tool against each set of converted TC1, TC2, TC3 and Decal files output by the texconv.exe tool. Note that the -o argument passed to the oxtexturetool command is the name of the output mask array file you want generated. <br /> <br /> It's important to note that the file names used in the&amp;nbsp;\SourceArt\maps\MakeTeamColorMask.bat script file of the LittleBoy mod are specific to the LittleBoy unit, and that you may name these source files however you like.<br /> <br /> The Team Color Masks texture is set in the unit's Palette file via the &quot;TeamColorMasks&quot; column. Whatever you provide as the file name that the OxTextureTool.exe tool&amp;nbsp;outputs (via the&amp;nbsp;-o&amp;nbsp;argument) must match what you provide for &quot;TeamColorMasks&quot; column in your unit's Palette file. What you provide for the &quot;teamColorMasks&quot; column in your unit's Palette file must be a path to the file, relative to the root mods directory.<br /> <br /> &amp;nbsp;<br /> <br /> [provide Tools package that contains OxTextureTool, TexConv, EasyBake&amp;nbsp;and some .bat script files]<br /> <br /> &amp;nbsp;<br /> <br /> <br /> <br /> ==== The Material Masks Texture ====<br /> <br /> &amp;nbsp;<br /> <br /> PHC Unit Materials<br /> <br /> *MM1 – Painted Metal <br /> **This is meant to represent a painted surface. <br /> **Most of a PHC unit uses this material. This material responds to the TeamColor_MaskArray texture as follows: <br /> ***Base color of Painted Metal is a constant mid-grey color (hard coded) <br /> ***TC1 – Team color 1, the primary team color. Anywhere this is white, teamcolor 1 will show up. <br /> ***TC2 – Team color 2, secondary team color. Anywhere this is white, teamcolor 2 will show up. <br /> ***TC3 – Team color 3, trim team color. Anywhere this is white, teamcolor 3&amp;nbsp;will show up. <br /> ***Decal – Decal mask, anywhere that this mask is white it uses the ColorMap directly as the diffuse color. This overrides all the other teamcolor masks. <br /> ***Unlike material masks, you won’t get overbright textures if these masks overlap, you’ll just get overlap like layers in photoshop, in this order (top down): <br /> ****Decal <br /> ****TC3 <br /> ****TC2 <br /> ****TC1 <br /> ****Base color <br /> <br /> <br /> <br /> *Painted Metal is affected by the Curvature Map in that edges will be worn off to expose MM2 (Bare Metal). <br /> *Painted Metal also uses the panel detail texture found in Assets/Material/PHC_Unit_Panels.dds that has the following channels: <br /> **R – Panel dirt <br /> **G – Panel edge-wear <br /> **B - AO <br /> **A – Overall color variation <br /> ***White means lighten the color <br /> ***50% Grey means do not change the color <br /> ***Black means darken the color <br /> <br /> <br /> *MM2 – Bare Metal <br /> **Dark silvery material. <br /> **This material uses the Curvature map and panel-detail map to darken the metal in crevices and shine and brighten it on edges. <br /> **This material does not respond to the Color map in any way. <br /> <br /> *MM3 – Emissive <br /> **Glowing parts of the model (running lights, etc.) <br /> **The brightness of the emissive lights is set in the material. However, the material reacts to the Color map by multiplying it in. You can set up the color you want the emissive to be by coloring that area of the Color map. Generally those have been set up with a fade around the edges to make the glow look softer and mip-map more nicely with distance. <br /> <br /> *MM4 – EngineEmissive <br /> **Glowing parts of the hover pods/engines <br /> **This works much the same way the MM3 Emissive material works, but it uses the color map slightly differently. It multiplies the Color map as a grey-scale value with the engine color for that team (set up with the team colors). You still get the effect of the edge fading like regular emissives, but not the color tinting. <br /> **The overall brightness of the Engine Emissive material is scaled by the amount of “thrust” being applied to the object. Engines brighten when the unit is moving itself, darken when it’s not. <br /> <br /> <br /> *Dust – This is not directly controlled by artists. A combination of factors determine where dust is applied, the dust overlays all other materials (except emissives). <br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === The FBX File ===<br /> <br /> The models for all buildings and units in Ashes: Escalation were authored in either Maya or 3dsMax. Of course, this does not mean that other tools like Blender or Modo can't be used. Be aware though that there are minor differences in the ways that each of these 3D modeling tools export FBX files and that their output can be&amp;nbsp;inconsistent between what each tool outputs. This can have the effect of&amp;nbsp;introducing&amp;nbsp;flaws into your model when bringing them into the game.&amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === Baking the Normals ===<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === Baking the Asset into the Game ===<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === Troubleshooting ===<br /> <br /> &amp;nbsp;<br /> <br /> Fatal Error: Assert Fail: pMesh-&gt;GetPolygonSize(0) == Model::eNumIndiciesPerPoly File<br /> <br /> Models are required to have triangulated polygons.&amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> When running the Texconv, OXTextureTool or EasyBake tools, if you are prompted with an error dialog saying MSVCP140D.dll or VCRUNTIME140D.dll or VCOMP140D.dll is missing:<br /> <br /> You will need to install the Visual C++ Redistributable for Visual Studio 2015:&amp;nbsp;https://www.microsoft.com/en-US/download/details.aspx?id=48145<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === When To Create Additional LODs ===<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> [[Category:Modding]]<br /> &lt;references /&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9613 2018-02-23T11:34:50Z

<p>AlphonsoHornibro: </p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> <br /> <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9612 2018-02-23T11:34:41Z

<p>AlphonsoHornibro: </p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9611 2018-02-23T11:34:29Z

<p>AlphonsoHornibro: </p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9610 2018-02-23T11:34:19Z

<p>AlphonsoHornibro: </p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> &amp;nbsp;<br /> &amp;nbsp;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9609 2018-02-23T11:33:59Z

<p>AlphonsoHornibro: /* Commenting Out Code */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb|left]]<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9608 2018-02-23T11:33:21Z

<p>AlphonsoHornibro: /* Commenting Out Code */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. I need to use an image to show which characters are used to comment out.<br /> [[File:Capture.jpg|thumb]]<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=File:Capture.jpg&diff=9607 2018-02-23T11:33:06Z

<p>AlphonsoHornibro: </p> <hr /> <div>Capture</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9606 2018-02-23T11:31:16Z

<p>AlphonsoHornibro: /* Commenting Out Code */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, place &lt;!-- in front of a section and --&gt; at the end. Anything in the middle will be disabled.<br /> <br /> <br /> &lt;!-- Comment out --&gt;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9605 2018-02-23T11:29:59Z

<p>AlphonsoHornibro: /* Commenting Out Code */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &quot;&lt;!--&quot; to the front and &quot;--&gt;&quot; to the end of what you want commented out.<br /> <br /> <br /> &lt;!-- Comment out --&gt;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9604 2018-02-23T11:29:35Z

<p>AlphonsoHornibro: /* Commenting Out Code */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &quot;&lt;!--&quot; to the front and &quot;--&gt;&quot; to the end of what you want commented out.<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Triggers&diff=9603 2018-02-22T11:11:21Z

<p>AlphonsoHornibro: /* Var */</p> <hr /> <div>[[Category:Modding]]<br /> '''Triggers''' are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> == Active vs Inactive ==<br /> <br /> Triggers are &quot;active&quot; by default, meaning they will fire whenever their condition is met. They can be set to Inactive manually in the script.<br /> <br /> Triggers set themselves to Inactive when they fire. This means that if you want something to be repeatable, you need to reactivate it somewhere in the script.<br /> <br /> == Repeating Triggers ==<br /> <br /> Using &lt;ActivateTrigger=&quot;triggername&quot;/&gt; to tell a trigger to activate itself will make it repeatable (if you want something to happen every time the player builds a Dreadnought, for example, or waves of enemies to spawn and attack every 15 seconds).<br /> <br /> == Conditional Triggers ==<br /> <br /> Using the OtherTrigger and NotOtherTrigger arguments is a way to gate your scenario's logic. For purposes of those arguments, a trigger 'counts' '''if it has been activated at least once''' during the game. However, you can't stack multiple Conditional Triggers. To word it another way, OtherTrigger=&quot;Triggername&quot; means only run the Trigger if this Trigger has happened, while NotOtherTrigger means only run the Trigger if this other Trigger hasn't happened.<br /> <br /> There is currently no way to &quot;un-activate&quot; a trigger, as far as OtherTrigger and NotOtherTrigger are concerned.<br /> <br /> Here's what that may look like:<br /> <br /> &lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;&lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;<br /> &lt;Trigger&gt;<br /> <br /> In this case, the NotOtherTrigger means do not run the unit spawn trigger if the SpawnSuppression Trigger has been activated, (a certain region has been captured.) Another example is NotOtherTrigger=&quot;Difficulty4&quot; means don't run the trigger if the player is playing on Expert.<br /> <br /> == Common Trigger Arguments ==<br /> <br /> All triggers share some attributes in common:<br /> <br /> *'''Name''' - Name of the trigger. Required. <br /> *'''Type''' - What type of trigger it is. See below. Required. <br /> *'''Inactive''' - If this trigger is inactive, to activate use the ActivateTrigger option from another Trigger. <br /> *'''OtherTrigger''' - Name of another trigger that must have fired before this one will activate. Use this to set multiple conditions on a trigger occurring. <br /> *'''NotOtherTrigger''' - Inverse of OtherTrigger. If the other trigger has fired this trigger won’t fire. Us this to create branching options in your scenario. <br /> <br /> == Trigger Types ==<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> === [[Area_Trigger|Area]] ===<br /> <br /> Fires when the human player moves a unit into the area.<br /> <br /> *'''Center''' - Map coordinates of the center of the area. Required. <br /> *'''Size''' - Size of the area. <br /> *'''Template''' - Template name of the unit that can trigger this. If you want it to fire if any unit enters the area, do not specify a Template argument. <br /> <br /> === [[Build_Trigger|Build]] ===<br /> <br /> Fires when a human player builds structures or units.<br /> <br /> *'''Target''' - The template of the building that will fire this trigger <br /> *'''IsBuilding''' - Set to &quot;1&quot; if the target is a building <br /> *'''Count''' - How many of the target template must be built to fire the trigger (default 1) <br /> <br /> === [[Destruction_Trigger|Destruction]] ===<br /> <br /> Fires when something specific dies.<br /> <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> <br /> === [[Difficulty_Trigger|Difficulty]] ===<br /> <br /> Fires at the beginning of a scenario if the given difficulty was chosen<br /> <br /> *'''Difficulty''' - The given difficulty (0 for Much Easier, up to 4 for Much Harder) <br /> <br /> === [[NamedCreate_Trigger|NamedCreate]] ===<br /> <br /> Fires when a specific unit or building is spawned via a script.<br /> <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> <br /> === [[Research_Trigger|Research]] ===<br /> <br /> Fires when a player researches a Quantum Upgrade<br /> <br /> *'''Player''' - The player doing the research <br /> *'''Target''' - The name of the tech <br /> <br /> === [[Timer_Trigger|Timer]] ===<br /> <br /> Fires after a delay.<br /> <br /> *'''Time -''' Time in seconds after this gets triggered that it takes place. <br /> <br /> === [[Var_Trigger|Var]] ===<br /> <br /> Fires if a variable meets given criteria<br /> <br /> *'''Var''' - The name of the variable to check <br /> *'''Operator''' - What logical operator to use when evaluating the variable (equal to, less than, etc) '''[ == | &gt;= | &lt;= | &gt; | &lt; |&amp;nbsp;!= ]''' <br /> *'''Value''' - The (integer) value to compare the variable against <br /> *''Example: &lt;Trigger Name=&quot;tWeasleyDead&quot; Type=&quot;Var&quot; Var=&quot;vWeasleyDead&quot; Operator=&quot;==&quot; Value=&quot;1&quot; &gt; - this fires when the &quot;vWeasleyDead&quot; variable is equal to 1''<br /> <br /> This is useful if you want to make capturing 4 regions or killing 4 AI players do something, but only when all of them have been done at the same time. However, you have to be careful in the case of capturing all 4 regions that it doesn't get messed up by if the AI captures the region back. This is where conditional triggers are essential.<br /> <br /> === [[ZoneCapture_Trigger|ZoneCapture]] ===<br /> <br /> Fires when a region is captured.<br /> <br /> *'''Owner''' - Player who must capture this region to fire the trigger. <br /> *'''Position''' - Map coordinates of the generator/Nexus.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Triggers&diff=9602 2018-02-22T11:11:07Z

<p>AlphonsoHornibro: /* Var */</p> <hr /> <div>[[Category:Modding]]<br /> '''Triggers''' are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> == Active vs Inactive ==<br /> <br /> Triggers are &quot;active&quot; by default, meaning they will fire whenever their condition is met. They can be set to Inactive manually in the script.<br /> <br /> Triggers set themselves to Inactive when they fire. This means that if you want something to be repeatable, you need to reactivate it somewhere in the script.<br /> <br /> == Repeating Triggers ==<br /> <br /> Using &lt;ActivateTrigger=&quot;triggername&quot;/&gt; to tell a trigger to activate itself will make it repeatable (if you want something to happen every time the player builds a Dreadnought, for example, or waves of enemies to spawn and attack every 15 seconds).<br /> <br /> == Conditional Triggers ==<br /> <br /> Using the OtherTrigger and NotOtherTrigger arguments is a way to gate your scenario's logic. For purposes of those arguments, a trigger 'counts' '''if it has been activated at least once''' during the game. However, you can't stack multiple Conditional Triggers. To word it another way, OtherTrigger=&quot;Triggername&quot; means only run the Trigger if this Trigger has happened, while NotOtherTrigger means only run the Trigger if this other Trigger hasn't happened.<br /> <br /> There is currently no way to &quot;un-activate&quot; a trigger, as far as OtherTrigger and NotOtherTrigger are concerned.<br /> <br /> Here's what that may look like:<br /> <br /> &lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;&lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;<br /> &lt;Trigger&gt;<br /> <br /> In this case, the NotOtherTrigger means do not run the unit spawn trigger if the SpawnSuppression Trigger has been activated, (a certain region has been captured.) Another example is NotOtherTrigger=&quot;Difficulty4&quot; means don't run the trigger if the player is playing on Expert.<br /> <br /> == Common Trigger Arguments ==<br /> <br /> All triggers share some attributes in common:<br /> <br /> *'''Name''' - Name of the trigger. Required. <br /> *'''Type''' - What type of trigger it is. See below. Required. <br /> *'''Inactive''' - If this trigger is inactive, to activate use the ActivateTrigger option from another Trigger. <br /> *'''OtherTrigger''' - Name of another trigger that must have fired before this one will activate. Use this to set multiple conditions on a trigger occurring. <br /> *'''NotOtherTrigger''' - Inverse of OtherTrigger. If the other trigger has fired this trigger won’t fire. Us this to create branching options in your scenario. <br /> <br /> == Trigger Types ==<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> === [[Area_Trigger|Area]] ===<br /> <br /> Fires when the human player moves a unit into the area.<br /> <br /> *'''Center''' - Map coordinates of the center of the area. Required. <br /> *'''Size''' - Size of the area. <br /> *'''Template''' - Template name of the unit that can trigger this. If you want it to fire if any unit enters the area, do not specify a Template argument. <br /> <br /> === [[Build_Trigger|Build]] ===<br /> <br /> Fires when a human player builds structures or units.<br /> <br /> *'''Target''' - The template of the building that will fire this trigger <br /> *'''IsBuilding''' - Set to &quot;1&quot; if the target is a building <br /> *'''Count''' - How many of the target template must be built to fire the trigger (default 1) <br /> <br /> === [[Destruction_Trigger|Destruction]] ===<br /> <br /> Fires when something specific dies.<br /> <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> <br /> === [[Difficulty_Trigger|Difficulty]] ===<br /> <br /> Fires at the beginning of a scenario if the given difficulty was chosen<br /> <br /> *'''Difficulty''' - The given difficulty (0 for Much Easier, up to 4 for Much Harder) <br /> <br /> === [[NamedCreate_Trigger|NamedCreate]] ===<br /> <br /> Fires when a specific unit or building is spawned via a script.<br /> <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> <br /> === [[Research_Trigger|Research]] ===<br /> <br /> Fires when a player researches a Quantum Upgrade<br /> <br /> *'''Player''' - The player doing the research <br /> *'''Target''' - The name of the tech <br /> <br /> === [[Timer_Trigger|Timer]] ===<br /> <br /> Fires after a delay.<br /> <br /> *'''Time -''' Time in seconds after this gets triggered that it takes place. <br /> <br /> === [[Var_Trigger|Var]] ===<br /> <br /> Fires if a variable meets given criteria<br /> <br /> *'''Var''' - The name of the variable to check <br /> *'''Operator''' - What logical operator to use when evaluating the variable (equal to, less than, etc) '''[ == | &gt;= | &lt;= | &gt; | &lt; |&amp;nbsp;!= ]''' <br /> *'''Value''' - The (integer) value to compare the variable against <br /> *''Example: &lt;Trigger Name=&quot;tWeasleyDead&quot; Type=&quot;Var&quot; Var=&quot;vWeasleyDead&quot; Operator=&quot;==&quot; Value=&quot;1&quot; &gt; - this fires when the &quot;vWeasleyDead&quot; variable is equal to 1''<br /> <br /> This is useful if you want to make capturing 4 regions or killing 4 AI players do something, but only when all of them have been done at the same time. However, you have to be careful in the case of capturing all 4 regions that it doesn't get messed up by if the AI captures the region back. This is where conditional triggers can be useful.<br /> <br /> === [[ZoneCapture_Trigger|ZoneCapture]] ===<br /> <br /> Fires when a region is captured.<br /> <br /> *'''Owner''' - Player who must capture this region to fire the trigger. <br /> *'''Position''' - Map coordinates of the generator/Nexus.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Triggers&diff=9601 2018-02-22T11:09:06Z

<p>AlphonsoHornibro: /* Conditional Triggers */</p> <hr /> <div>[[Category:Modding]]<br /> '''Triggers''' are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> == Active vs Inactive ==<br /> <br /> Triggers are &quot;active&quot; by default, meaning they will fire whenever their condition is met. They can be set to Inactive manually in the script.<br /> <br /> Triggers set themselves to Inactive when they fire. This means that if you want something to be repeatable, you need to reactivate it somewhere in the script.<br /> <br /> == Repeating Triggers ==<br /> <br /> Using &lt;ActivateTrigger=&quot;triggername&quot;/&gt; to tell a trigger to activate itself will make it repeatable (if you want something to happen every time the player builds a Dreadnought, for example, or waves of enemies to spawn and attack every 15 seconds).<br /> <br /> == Conditional Triggers ==<br /> <br /> Using the OtherTrigger and NotOtherTrigger arguments is a way to gate your scenario's logic. For purposes of those arguments, a trigger 'counts' '''if it has been activated at least once''' during the game. However, you can't stack multiple Conditional Triggers. To word it another way, OtherTrigger=&quot;Triggername&quot; means only run the Trigger if this Trigger has happened, while NotOtherTrigger means only run the Trigger if this other Trigger hasn't happened.<br /> <br /> There is currently no way to &quot;un-activate&quot; a trigger, as far as OtherTrigger and NotOtherTrigger are concerned.<br /> <br /> Here's what that may look like:<br /> <br /> &lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;&lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;<br /> &lt;Trigger&gt;<br /> <br /> In this case, the NotOtherTrigger means do not run the unit spawn trigger if the SpawnSuppression Trigger has been activated, (a certain region has been captured.) Another example is NotOtherTrigger=&quot;Difficulty4&quot; means don't run the trigger if the player is playing on Expert.<br /> <br /> == Common Trigger Arguments ==<br /> <br /> All triggers share some attributes in common:<br /> <br /> *'''Name''' - Name of the trigger. Required. <br /> *'''Type''' - What type of trigger it is. See below. Required. <br /> *'''Inactive''' - If this trigger is inactive, to activate use the ActivateTrigger option from another Trigger. <br /> *'''OtherTrigger''' - Name of another trigger that must have fired before this one will activate. Use this to set multiple conditions on a trigger occurring. <br /> *'''NotOtherTrigger''' - Inverse of OtherTrigger. If the other trigger has fired this trigger won’t fire. Us this to create branching options in your scenario. <br /> <br /> == Trigger Types ==<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> === [[Area_Trigger|Area]] ===<br /> <br /> Fires when the human player moves a unit into the area.<br /> <br /> *'''Center''' - Map coordinates of the center of the area. Required. <br /> *'''Size''' - Size of the area. <br /> *'''Template''' - Template name of the unit that can trigger this. If you want it to fire if any unit enters the area, do not specify a Template argument. <br /> <br /> === [[Build_Trigger|Build]] ===<br /> <br /> Fires when a human player builds structures or units.<br /> <br /> *'''Target''' - The template of the building that will fire this trigger <br /> *'''IsBuilding''' - Set to &quot;1&quot; if the target is a building <br /> *'''Count''' - How many of the target template must be built to fire the trigger (default 1) <br /> <br /> === [[Destruction_Trigger|Destruction]] ===<br /> <br /> Fires when something specific dies.<br /> <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> <br /> === [[Difficulty_Trigger|Difficulty]] ===<br /> <br /> Fires at the beginning of a scenario if the given difficulty was chosen<br /> <br /> *'''Difficulty''' - The given difficulty (0 for Much Easier, up to 4 for Much Harder) <br /> <br /> === [[NamedCreate_Trigger|NamedCreate]] ===<br /> <br /> Fires when a specific unit or building is spawned via a script.<br /> <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> <br /> === [[Research_Trigger|Research]] ===<br /> <br /> Fires when a player researches a Quantum Upgrade<br /> <br /> *'''Player''' - The player doing the research <br /> *'''Target''' - The name of the tech <br /> <br /> === [[Timer_Trigger|Timer]] ===<br /> <br /> Fires after a delay.<br /> <br /> *'''Time -''' Time in seconds after this gets triggered that it takes place. <br /> <br /> === [[Var_Trigger|Var]] ===<br /> <br /> Fires if a variable meets given criteria<br /> <br /> *'''Var''' - The name of the variable to check <br /> *'''Operator''' - What logical operator to use when evaluating the variable (equal to, less than, etc) '''[ == | &gt;= | &lt;= | &gt; | &lt; |&amp;nbsp;!= ]''' <br /> *'''Value''' - The (integer) value to compare the variable against <br /> *''Example: &lt;Trigger Name=&quot;tWeasleyDead&quot; Type=&quot;Var&quot; Var=&quot;vWeasleyDead&quot; Operator=&quot;==&quot; Value=&quot;1&quot; &gt; - this fires when the &quot;vWeasleyDead&quot; variable is equal to 1'' <br /> <br /> === [[ZoneCapture_Trigger|ZoneCapture]] ===<br /> <br /> Fires when a region is captured.<br /> <br /> *'''Owner''' - Player who must capture this region to fire the trigger. <br /> *'''Position''' - Map coordinates of the generator/Nexus.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Triggers&diff=9600 2018-02-22T11:08:48Z

<p>AlphonsoHornibro: /* Conditional Triggers */</p> <hr /> <div>[[Category:Modding]]<br /> '''Triggers''' are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> == Active vs Inactive ==<br /> <br /> Triggers are &quot;active&quot; by default, meaning they will fire whenever their condition is met. They can be set to Inactive manually in the script.<br /> <br /> Triggers set themselves to Inactive when they fire. This means that if you want something to be repeatable, you need to reactivate it somewhere in the script.<br /> <br /> == Repeating Triggers ==<br /> <br /> Using &lt;ActivateTrigger=&quot;triggername&quot;/&gt; to tell a trigger to activate itself will make it repeatable (if you want something to happen every time the player builds a Dreadnought, for example, or waves of enemies to spawn and attack every 15 seconds).<br /> <br /> == Conditional Triggers ==<br /> <br /> Using the OtherTrigger and NotOtherTrigger arguments is a way to gate your scenario's logic. For purposes of those arguments, a trigger 'counts' '''if it has been activated at least once''' during the game. However, you can't stack multiple Conditional Triggers. To word it another way, OtherTrigger=&quot;Triggername&quot; means only run the Trigger if this Trigger has happened, while NotOtherTrigger means only run the Trigger if this other Trigger hasn't happened.<br /> <br /> There is currently no way to &quot;un-activate&quot; a trigger, as far as OtherTrigger and NotOtherTrigger are concerned.<br /> <br /> Here's what that may look like:<br /> <br /> &lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;&lt;Trigger Name=&quot;tNE_Spawn1&quot; Type=&quot;Var&quot; Var=&quot;vNE_Spawn&quot; Operator=&quot;==&quot; Value=&quot;1&quot; NotOtherTrigger=&quot;tNE_SpawnSuppress&quot; &gt;<br /> &lt;SpawnUnit Name=&quot;uNE_Leader1&quot; Template=&quot;PHC_2_Zeus&quot; Player=&quot;5&quot; Position=&quot;-9344,-8064&quot; /&gt;<br /> &lt;Trigger&gt;<br /> <br /> In this case, the NotOtherTrigger means do not run the unit spawn trigger if the SpawnSuppression Trigger has been activated, (a certain region has been captured.) NotOtherTrigger=&quot;Difficulty4&quot; means don't run the trigger if the player is playing on Expert.<br /> <br /> == Common Trigger Arguments ==<br /> <br /> All triggers share some attributes in common:<br /> <br /> *'''Name''' - Name of the trigger. Required. <br /> *'''Type''' - What type of trigger it is. See below. Required. <br /> *'''Inactive''' - If this trigger is inactive, to activate use the ActivateTrigger option from another Trigger. <br /> *'''OtherTrigger''' - Name of another trigger that must have fired before this one will activate. Use this to set multiple conditions on a trigger occurring. <br /> *'''NotOtherTrigger''' - Inverse of OtherTrigger. If the other trigger has fired this trigger won’t fire. Us this to create branching options in your scenario. <br /> <br /> == Trigger Types ==<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> === [[Area_Trigger|Area]] ===<br /> <br /> Fires when the human player moves a unit into the area.<br /> <br /> *'''Center''' - Map coordinates of the center of the area. Required. <br /> *'''Size''' - Size of the area. <br /> *'''Template''' - Template name of the unit that can trigger this. If you want it to fire if any unit enters the area, do not specify a Template argument. <br /> <br /> === [[Build_Trigger|Build]] ===<br /> <br /> Fires when a human player builds structures or units.<br /> <br /> *'''Target''' - The template of the building that will fire this trigger <br /> *'''IsBuilding''' - Set to &quot;1&quot; if the target is a building <br /> *'''Count''' - How many of the target template must be built to fire the trigger (default 1) <br /> <br /> === [[Destruction_Trigger|Destruction]] ===<br /> <br /> Fires when something specific dies.<br /> <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> <br /> === [[Difficulty_Trigger|Difficulty]] ===<br /> <br /> Fires at the beginning of a scenario if the given difficulty was chosen<br /> <br /> *'''Difficulty''' - The given difficulty (0 for Much Easier, up to 4 for Much Harder) <br /> <br /> === [[NamedCreate_Trigger|NamedCreate]] ===<br /> <br /> Fires when a specific unit or building is spawned via a script.<br /> <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> <br /> === [[Research_Trigger|Research]] ===<br /> <br /> Fires when a player researches a Quantum Upgrade<br /> <br /> *'''Player''' - The player doing the research <br /> *'''Target''' - The name of the tech <br /> <br /> === [[Timer_Trigger|Timer]] ===<br /> <br /> Fires after a delay.<br /> <br /> *'''Time -''' Time in seconds after this gets triggered that it takes place. <br /> <br /> === [[Var_Trigger|Var]] ===<br /> <br /> Fires if a variable meets given criteria<br /> <br /> *'''Var''' - The name of the variable to check <br /> *'''Operator''' - What logical operator to use when evaluating the variable (equal to, less than, etc) '''[ == | &gt;= | &lt;= | &gt; | &lt; |&amp;nbsp;!= ]''' <br /> *'''Value''' - The (integer) value to compare the variable against <br /> *''Example: &lt;Trigger Name=&quot;tWeasleyDead&quot; Type=&quot;Var&quot; Var=&quot;vWeasleyDead&quot; Operator=&quot;==&quot; Value=&quot;1&quot; &gt; - this fires when the &quot;vWeasleyDead&quot; variable is equal to 1'' <br /> <br /> === [[ZoneCapture_Trigger|ZoneCapture]] ===<br /> <br /> Fires when a region is captured.<br /> <br /> *'''Owner''' - Player who must capture this region to fire the trigger. <br /> *'''Position''' - Map coordinates of the generator/Nexus.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9599 2018-02-22T11:04:34Z

<p>AlphonsoHornibro: /* Mission Definition */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain.<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &lt;!-- to the front and --&gt; to the end of what you want commented out. <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9598 2018-02-22T11:04:12Z

<p>AlphonsoHornibro: /* Mission Definition */</p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Missions (scripting)|Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === [[Player (scripting)|Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &lt;!-- to the front and --&gt; to the end of what you want commented out. <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9597 2018-02-22T11:03:39Z

<p>AlphonsoHornibro: </p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === [[Mission Definition]] ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === [[Player Definition]] ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === [[Triggers]] ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &lt;!-- to the front and --&gt; to the end of what you want commented out. <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9596 2018-02-22T10:54:24Z

<p>AlphonsoHornibro: </p> <hr /> <div><br /> == Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options. There's a lot of terminology to learn for scripting, and not all of them are listed on this page but links are provided throughout to give you the full set of required terms.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &lt;!-- to the front and --&gt; to the end of what you want commented out. <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9595 2018-02-22T10:52:23Z

<p>AlphonsoHornibro: </p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &lt;!-- to the front and --&gt; to the end of what you want commented out. <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9594 2018-02-22T10:52:07Z

<p>AlphonsoHornibro: </p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> == Commenting Out Code ==<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &lt;!-- to the front and --&gt; to the end of what you want commented out. <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9593 2018-02-22T10:51:45Z

<p>AlphonsoHornibro: </p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> === Commenting Out Code ===<br /> <br /> Commenting out code is very useful to disable certain lines but without deleting them so you can easily place them back on. This is also useful for leaving notes so you remember what you are trying to do or just making it neater and easier to navigate. To comment out a section, add &lt;!-- to the front and --&gt; to the end of what you want commented out. <br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9592 2018-02-22T10:48:23Z

<p>AlphonsoHornibro: /* Fixing Issues */</p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display<br /> *'''Empty Campaign Screen''' - If the campaign screen is empty with no campaigns or scenario missions listed, this means there is a grammar error in one of the scripts which has broken it and made it unable to be ran. You will have to identity the mistake and fix it. For example, having a Trigger without the &gt; on the end or missing a quotation mark can cause this error. Identifying the issue can be time consuming, so it is recommended you make updates in small increments so you know where in the script the cause would be. One strategy to find these mistakes is to comment out entire sections of the script with &lt;!-- on the front and --&gt; on the end, and see if the problem persists. If you have commented out a large portion of the script and then the missions are now showing up, you have narrowed down the cause and you can comment more and more specific sections to location the issue.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9591 2018-02-22T10:44:46Z

<p>AlphonsoHornibro: </p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *'''Consistent Crash''' - Often happening at the start of a scenario, if you have a crash that happens every time it is likely the result of trying to spawn a unit or building with an incorrect name. For example, if the game is trying to spawn PHC_Smarty_System&quot; it will find this building name doesn't exist and result in a crash, due to the internal reference name actually being PHC_Smarties. It's vital you get the correct internal reference names, and not all of them match their in-game display</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Triggers&diff=9590 2018-02-22T10:44:06Z

<p>AlphonsoHornibro: /* Conditional Triggers */</p> <hr /> <div>[[Category:Modding]]<br /> '''Triggers''' are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> == Active vs Inactive ==<br /> <br /> Triggers are &quot;active&quot; by default, meaning they will fire whenever their condition is met. They can be set to Inactive manually in the script.<br /> <br /> Triggers set themselves to Inactive when they fire. This means that if you want something to be repeatable, you need to reactivate it somewhere in the script.<br /> <br /> == Repeating Triggers ==<br /> <br /> Using &lt;ActivateTrigger=&quot;triggername&quot;/&gt; to tell a trigger to activate itself will make it repeatable (if you want something to happen every time the player builds a Dreadnought, for example, or waves of enemies to spawn and attack every 15 seconds).<br /> <br /> == Conditional Triggers ==<br /> <br /> Using the OtherTrigger and NotOtherTrigger arguments is a way to gate your scenario's logic. For purposes of those arguments, a trigger 'counts' '''if it has been activated at least once''' during the game. However, you can't stack multiple Conditional Triggers.<br /> <br /> There is currently no way to &quot;un-activate&quot; a trigger, as far as OtherTrigger and NotOtherTrigger are concerned.<br /> <br /> == Common Trigger Arguments ==<br /> <br /> All triggers share some attributes in common:<br /> <br /> *'''Name''' - Name of the trigger. Required. <br /> *'''Type''' - What type of trigger it is. See below. Required. <br /> *'''Inactive''' - If this trigger is inactive, to activate use the ActivateTrigger option from another Trigger. <br /> *'''OtherTrigger''' - Name of another trigger that must have fired before this one will activate. Use this to set multiple conditions on a trigger occurring. <br /> *'''NotOtherTrigger''' - Inverse of OtherTrigger. If the other trigger has fired this trigger won’t fire. Us this to create branching options in your scenario. <br /> <br /> == Trigger Types ==<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> === [[Area_Trigger|Area]] ===<br /> <br /> Fires when the human player moves a unit into the area.<br /> <br /> *'''Center''' - Map coordinates of the center of the area. Required. <br /> *'''Size''' - Size of the area. <br /> *'''Template''' - Template name of the unit that can trigger this. If you want it to fire if any unit enters the area, do not specify a Template argument. <br /> <br /> === [[Build_Trigger|Build]] ===<br /> <br /> Fires when a human player builds structures or units.<br /> <br /> *'''Target''' - The template of the building that will fire this trigger <br /> *'''IsBuilding''' - Set to &quot;1&quot; if the target is a building <br /> *'''Count''' - How many of the target template must be built to fire the trigger (default 1) <br /> <br /> === [[Destruction_Trigger|Destruction]] ===<br /> <br /> Fires when something specific dies.<br /> <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> <br /> === [[Difficulty_Trigger|Difficulty]] ===<br /> <br /> Fires at the beginning of a scenario if the given difficulty was chosen<br /> <br /> *'''Difficulty''' - The given difficulty (0 for Much Easier, up to 4 for Much Harder) <br /> <br /> === [[NamedCreate_Trigger|NamedCreate]] ===<br /> <br /> Fires when a specific unit or building is spawned via a script.<br /> <br /> *'''Target''' - Name of the script-spawned unit or building. <br /> *'''IsBuilding''' - If this is a building (if not it refers to a unit). <br /> <br /> === [[Research_Trigger|Research]] ===<br /> <br /> Fires when a player researches a Quantum Upgrade<br /> <br /> *'''Player''' - The player doing the research <br /> *'''Target''' - The name of the tech <br /> <br /> === [[Timer_Trigger|Timer]] ===<br /> <br /> Fires after a delay.<br /> <br /> *'''Time -''' Time in seconds after this gets triggered that it takes place. <br /> <br /> === [[Var_Trigger|Var]] ===<br /> <br /> Fires if a variable meets given criteria<br /> <br /> *'''Var''' - The name of the variable to check <br /> *'''Operator''' - What logical operator to use when evaluating the variable (equal to, less than, etc) '''[ == | &gt;= | &lt;= | &gt; | &lt; |&amp;nbsp;!= ]''' <br /> *'''Value''' - The (integer) value to compare the variable against <br /> *''Example: &lt;Trigger Name=&quot;tWeasleyDead&quot; Type=&quot;Var&quot; Var=&quot;vWeasleyDead&quot; Operator=&quot;==&quot; Value=&quot;1&quot; &gt; - this fires when the &quot;vWeasleyDead&quot; variable is equal to 1'' <br /> <br /> === [[ZoneCapture_Trigger|ZoneCapture]] ===<br /> <br /> Fires when a region is captured.<br /> <br /> *'''Owner''' - Player who must capture this region to fire the trigger. <br /> *'''Position''' - Map coordinates of the generator/Nexus.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9589 2018-02-22T10:42:30Z

<p>AlphonsoHornibro: /* Player Definition */</p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined (top of the list), 1 is the next, and so on. Player number has nothing to do with player color.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9588 2018-02-22T10:38:34Z

<p>AlphonsoHornibro: </p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> == Fixing Issues ==<br /> <br /> Many things in the Scenario code can cause issues that result a crash or prevent it from working. Here's a list of some common issues that you may encounter and how to fix them.<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list.</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Dialog&diff=9587 2018-02-22T10:36:04Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Dialog command is used in scripting to display text to create dialog between characters. Here's an example of what dialog choice should look like.<br /> <br /> *'''Icon''' - This is optional, and if left out will not display any icon. The Icon name refers to a hard coded image, which match the in-game display name such as &quot;Samuel&quot;. Currently, Additional portraits can not be added as calling them by game code, but existing portraits can be edited and replaced. The Portrait name refers to a portion of the Assets\UI\Art\New HUD\CharacterPortraits85x113.dds file. <br /> <br /> Portraits are: Mac<br /> Haalee<br /> Vexen<br /> Valen<br /> Artix<br /> Ventrix<br /> Athena<br /> Narrator<br /> Agememnon<br /> Agethon<br /> Nihilon<br /> <br /> *'''Text''' - Refers to a line of text in one of the many .csv files in the Assets\UIText directory. The amount of characters determines duration of the dialog on screen, unless an audio file is played.<br /> *'''Audio''' - This is optional, plays an audio file intended for voice over to match a line of text. The length of the audio file determines the duration the dialog plays. <br /> <br /> Here's an example of what it looks like.<br /> <br /> &lt;Trigger Name=&quot;tIntro_Pan&quot; Type=&quot;Timer&quot; Timer=&quot;0&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Dialog&gt;<br /> &lt;Entry Icon=&quot;Samuel&quot; Text=&quot;Atwater_Intro1&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Samuel_1.wav&quot; /&gt;<br /> &lt;Entry Icon=&quot;Nihilon&quot; Text=&quot;Atwater_Intro2&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Nihilon_1.wav&quot; /&gt;<br /> &lt;Entry Icon=&quot;Nihilon&quot; Text=&quot;Atwater_Intro3&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Nihilon_2.wav&quot; /&gt;<br /> &lt;/Dialog&gt;<br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Dialog&diff=9586 2018-02-22T10:35:33Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Dialog command is used in scripting to display text to create dialog between characters. Here's an example of what dialog choice should look like.<br /> <br /> *'''Icon''' - This is optional, and if left out will not display any icon. The Icon name refers to a hard coded image, which match the in-game display name such as &quot;Samuel&quot;. Currently, Additional portraits can not be added as calling them by game code, but existing portraits can be edited and replaced. The Portrait name refers to a portion of the Assets\UI\Art\New HUD\CharacterPortraits85x113.dds file. <br /> <br /> Portraits are: Mac<br /> Haalee<br /> Vexen<br /> Valen<br /> Artix<br /> Ventrix<br /> Athena<br /> Adrasteia<br /> Agememnon<br /> Agethon<br /> <br /> *'''Text''' - Refers to a line of text in one of the many .csv files in the Assets\UIText directory. The amount of characters determines duration of the dialog on screen, unless an audio file is played.<br /> *'''Audio''' - This is optional, plays an audio file intended for voice over to match a line of text. The length of the audio file determines the duration the dialog plays. <br /> <br /> Here's an example of what it looks like.<br /> <br /> &lt;Trigger Name=&quot;tIntro_Pan&quot; Type=&quot;Timer&quot; Timer=&quot;0&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Dialog&gt;<br /> &lt;Entry Icon=&quot;Samuel&quot; Text=&quot;Atwater_Intro1&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Samuel_1.wav&quot; /&gt;<br /> &lt;Entry Icon=&quot;Nihilon&quot; Text=&quot;Atwater_Intro2&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Nihilon_1.wav&quot; /&gt;<br /> &lt;Entry Icon=&quot;Nihilon&quot; Text=&quot;Atwater_Intro3&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Nihilon_2.wav&quot; /&gt;<br /> &lt;/Dialog&gt;<br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Dialog&diff=9585 2018-02-22T10:35:20Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Dialog command is used in scripting to display text to create dialog between characters. Here's an example of what dialog choice should look like.<br /> <br /> *'''Icon''' - This is optional, and if left out will not display any icon. The Icon name refers to a hard coded image, which match the in-game display name such as &quot;Samuel&quot;. Currently, Additional portraits can not be added as calling them by game code, but existing portraits can be edited and replaced. The Portrait name refers to a portion of the Assets\UI\Art\New HUD\CharacterPortraits85x113.dds file. <br /> <br /> Mac<br /> Haalee<br /> Vexen<br /> Valen<br /> Artix<br /> Ventrix<br /> Athena<br /> Adrasteia<br /> Agememnon<br /> Agethon<br /> <br /> *'''Text''' - Refers to a line of text in one of the many .csv files in the Assets\UIText directory. The amount of characters determines duration of the dialog on screen, unless an audio file is played.<br /> *'''Audio''' - This is optional, plays an audio file intended for voice over to match a line of text. The length of the audio file determines the duration the dialog plays. <br /> <br /> Here's an example of what it looks like.<br /> <br /> &lt;Trigger Name=&quot;tIntro_Pan&quot; Type=&quot;Timer&quot; Timer=&quot;0&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Dialog&gt;<br /> &lt;Entry Icon=&quot;Samuel&quot; Text=&quot;Atwater_Intro1&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Samuel_1.wav&quot; /&gt;<br /> &lt;Entry Icon=&quot;Nihilon&quot; Text=&quot;Atwater_Intro2&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Nihilon_1.wav&quot; /&gt;<br /> &lt;Entry Icon=&quot;Nihilon&quot; Text=&quot;Atwater_Intro3&quot; Audio=&quot;Audio/Campaign/Genesis3_Atwater/Genesis3_Atwater_Nihilon_2.wav&quot; /&gt;<br /> &lt;/Dialog&gt;<br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Scenario_Editor&diff=9584 2018-02-22T10:34:13Z

<p>AlphonsoHornibro: /* Commands */</p> <hr /> <div>== Scripting – Creating Scenarios ==<br /> <br /> [[Scripting|Scripting]] allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and [[Units|units]] the players can use, set up [[Triggers|Triggers]] to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom Scenarios.<br /> <br /> All of this is stored in XML, not code, so you don’t need any special programming tools or experience to use it. Though, it may be confusing at first and take a while to wrap your head around it. The best advice for seeing what is possible is to look through the \Assets\Campaign\ and \Scenario\ directories and seeing how the existing missions are made. Some examples are also included below.<br /> <br /> There are three main elements in Ashes scripting: [[Missions_(scripting)|missions]], [[Player_(scripting)|players]] and [[Triggers|triggers]]. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers are where all the magic happens. Triggers have a lot of elements and options.<br /> <br /> Note that all triggers and arguments are case-sensitive.<br /> <br /> === Mission Definition ===<br /> <br /> First, you set up all the menu-related items (what icons/art to use in the Campaign screen, etc) and global settings like enabling/disabling creeps and hiding terrain. To see the full list of items that can be conifgured, refer to the [[Missions_(scripting)|&lt;Mission&gt; page.]]<br /> <br /> === Player Definition ===<br /> <br /> To do much of anything, you'll need to define [[Player_(scripting)|players]] next. This is done with individual &lt;Player&gt; tags that enable or disable their AI, sets faction, team, and color, etc.<br /> <br /> You'll likely refer to these players later in the script by number, where 0 is the first player defined, 1 is the next, and so on.<br /> <br /> === Triggers ===<br /> <br /> [[Triggers|Triggers]] are what control anything you want to happen while the scenario is being played, from spawning starting base to calling waves of attacking enemies or giving players objectives. There are several types of triggers which activate off of different events.<br /> <br /> === Trigger Types ===<br /> <br /> These are the types of triggers you can use in a script, and any specific arguments they support.<br /> <br /> *'''[[Area_Trigger|Area]]''' - Fires when the human player moves a unit into the area. <br /> <br /> *'''[[Build_Trigger|Build]]''' - Fires when a human player builds structures or units. <br /> <br /> *'''[[Destruction_Trigger|Destruction]]''' - Fires when something specific dies. <br /> <br /> *'''[[Difficulty_Trigger|Difficulty]]''' - Fires at the beginning of a scenario if the given difficulty was chosen <br /> <br /> *'''[[NamedCreate_Trigger|NamedCreate]]''' - Fires when a specific unit or building is spawned via a script. <br /> <br /> *'''[[Research_Trigger|Research]]''' - Fires when a player researches a Quantum Upgrade <br /> <br /> *'''[[Timer_Trigger|Timer]]''' - Fires after a delay. <br /> <br /> *'''[[Var_Trigger|Var]]''' - Fires if a variable meets given criteria <br /> <br /> *'''[[ZoneCapture_Trigger|ZoneCapture]]''' - Fires when a region is captured, is also used for destroying players since their nexus turns into a Turinium Generator. <br /> <br /> &amp;nbsp;<br /> <br /> === Commands ===<br /> <br /> These are the [[Script_Commands|commands]] you can put within a trigger to create gameplay effects.<br /> <br /> For detailed information about how to use this, read the [[Script_Commands|main Commands entry]].<br /> <br /> *'''[[ActivateTrigger|ActivateTrigger]]''' - Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger). <br /> *'''[[AreaIndicator|AreaIndicator]]''' - This places a visible indicator on the map to help the player know where they should go to. <br /> *'''[[AttackAttackMove|AttackAttackMove]]''' - Order an army to move to a specific area, engaging enemies along the way. <br /> *'''[[AttackUnit|AttackUnit]]''' - Order an army to attack a specific script-spawned unit <br /> *'''[[Camera|Camera]]''' - Move the player's view to a specific area. <br /> *'''[[CaptureNearestNext|CaptureNearestNext]]''' - Order an army to capture the nearest neutral or enemy-controlled region <br /> *'''[[CaptureNearest|CaptureNearest]]''' - Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there) <br /> *'''[[ChangeAIDifficulty|ChangeAIDifficulty]]''' - Change an AI player's difficulty setting <br /> *'''[[ChangeAIPersonality|ChangeAIPersonality]]''' - Change an AI player's personality <br /> *'''[[DestroyBuilding|DestroyBuilding]]''' - Destroys a specific script-spawned building. <br /> *'''[[DestroyUnit|DestroyUnit]]''' - Destroys a specific script-spawned unit. <br /> *'''[[Dialog|Dialog]]''' - This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags. <br /> *'''[[Entry|Entry]]''' - The actual text that will be displayed. Use only within &lt;Dialog&gt; tags. <br /> *'''[[EndMission|EndMission]]''' - Use to force a win or loss of the scenario. <br /> *'''[[GrantStuff|GrantStuff]]''' - Give a player free resources <br /> *'''[[GrantTech|GrantTech]]''' - Give a player a free Quantum Upgrade <br /> *'''[[HidePanel|HidePanel]]''' - Hide UI panels <br /> *'''[[LetterBox|LetterBox]]''' - disable commands and go to a cinematic, letterbox view <br /> *'''[[MoveUnit|MoveUnit]]''' - Move an army to a location without stopping to fight <br /> *'''[[Objective|Objective]]''' - Use this to set objective notifications for the player (so they know what to do). <br /> *'''[[Restrict|Restrict]]''' - To block the player from being able to access objects in the game. <br /> *'''[[Reveal|Reveal]]''' - Reveal the fog of war over a location <br /> *'''[[SpawnBuilding|SpawnBuilding]]''' - Places a building on the map. <br /> *'''[[SpawnUnit|SpawnUnit]]''' - Places a unit on the map. <br /> *'''[[Var_Command|Var]]''' - Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> == Position Coordinates ==<br /> <br /> To view map coordinates, ensure you have opted into to a modding build under steam betas which allows you to open the developer tools. Open up the the map in a skirmish and press the ` or HOME key, then select DebugPlayerPanel and Enable Show Mouse Position.<br /> <br /> == Trigger Examples ==<br /> <br /> A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.<br /> <br /> === Send an army to attack ===<br /> <br /> [[File:ModGuide 29.png|frame|center|An attack trigger]]&lt;br /&gt; The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.<br /> <br /> === Reward the player for capturing an area ===<br /> <br /> [[File:ModGuide 30.png|frame|center|A region capture trigger]]&lt;br /&gt; The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.<br /> <br /> This trigger does the following:<br /> <br /> *Checks the Cap_C_Obj objective in the player’s objective list. <br /> *It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0. <br /> *It pops up some dialog for the player. <br /> *It enables the player’s ability to build Metal Extractors. <br /> *It spawns a free Engineer for the player. <br /> *It moves the camera to look at the captured region. <br /> *It adds a new objective for the player (Mex_Built_Obj). <br /> *It gives the player 500 Metal. <br /> *It makes the Cap_C_Trigger trigger active. <br /> <br /> This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;<br /> <br /> &amp;nbsp;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Script_Commands&diff=9583 2018-02-22T10:33:40Z

<p>AlphonsoHornibro: /* GrantTech */</p> <hr /> <div><br /> Commands are used within [[Triggers|triggers]] to create gameplay effects, from revealing locations to spawning attack waves or even changing an AI's difficulty mid-game.<br /> <br /> == List of Commands ==<br /> <br /> === [[ActivateTrigger|ActivateTrigger]] ===<br /> <br /> Activate another trigger (also can be used to activate the trigger it is called from, making a repeating trigger).<br /> <br /> *'''Target''' - This is the name of another trigger that will be set from Inactive to Active. <br /> <br /> === [[AreaIndicator|AreaIndicator]] ===<br /> <br /> This places a visible indicator on the map to help the player know where they should go to.<br /> <br /> *'''Name''' - The name of the area. <br /> *'''Position''' - The center of the area. <br /> *'''Color''' - The color the area indicator is. [ Green | Blue | Red ] <br /> *'''Size''' - How big the area indicator will be. <br /> *'''Duration''' - How long the area indicator should last, -1 means that it lasts forever. <br /> <br /> === [[AttackAttackMove|AttackAttackMove]] ===<br /> <br /> Order an army to move to a specific area, engaging enemies along the way.<br /> <br /> *'''Name''' - The name of the army that will be given the order. <br /> *'''Repeat''' - Whether to repeat the order. Use with multiple AttackAttackMove commands to create a patrol path. <br /> *'''Position''' - Where the army is ordered to move to. <br /> <br /> === [[AttackUnit|AttackUnit]] ===<br /> <br /> Order an army to attack a specific script-spawned unit<br /> <br /> *'''Name''' - The name of the unit to do the attacking <br /> *'''Target''' - The name of the unit to be attacked <br /> <br /> === [[Camera|Camera]] ===<br /> <br /> Move the player's view to a specific area.<br /> <br /> *'''Position''' - Where the camera will be looking. <br /> *'''Snap''' - Set to 1 to move the camera instantly, instead of panning <br /> *'''Speed''' - Scalar for how fast the camera will move, compared to clicking on the minimap. 0.5 for half speed, 2 for double, etc. <br /> *'''Unit''' - Follow a specific script-spawned unit. Do not use Position if you use this. <br /> *'''Building''' - Follow a specific script-spawned building. Do not use Position if you use this. <br /> *'''Save''' - Save the current camera settings. Useful if you want to show the player something and then move the camera back to whatever they were looking at. <br /> *'''Load''' - Load the last saved camera settings. Use with Save. May cause a crash if you haven't previously saved a camera position. <br /> *'''RTP''' - Distance, rotation and pitch of the camera. <br /> **The first number is distance. 1000 is a fairly tight shot, 2500 is a fairly typical gameplay zoom <br /> **Second number is rotation. 0 points the camera north, 90 east, 180 south, 270 west. <br /> **Third number is pitch. 40-50 are typical gameplay angles. 90 would be straight down. Note that anything lower than 40 can cause the engine to load a '''lot''' more terrain and models than it's designed to, so use with caution. <br /> <br /> === [[CaptureNearest|CaptureNearest]] ===<br /> <br /> Order an army to clear its order queue and capture the nearest neutral or enemy-controlled region (note: ordered unit will stop moving if region is captured before it gets there)<br /> <br /> *'''Name''' - The name of the unit to do the capturing <br /> *'''Repeat''' - Whether to repeat the order (indefinitely) <br /> <br /> === [[CaptureNearestNext|CaptureNearestNext]] ===<br /> <br /> Order an army to capture the nearest neutral or enemy-controlled region<br /> <br /> *'''Name''' - The name of the unit to do the capturing <br /> *'''Repeat''' - Whether to repeat the order (indefinitely) <br /> <br /> === [[ChangeAIDifficulty|ChangeAIDifficulty]] ===<br /> <br /> Change an AI player's difficulty setting<br /> <br /> *'''Player''' - The index of the player to change <br /> *'''Difficulty''' - The name of the difficulty to set it to <br /> <br /> === [[ChangeAIPersonality|ChangeAIPersonality]] ===<br /> <br /> Change an AI player's personality<br /> <br /> *'''Player''' - The index of the player to change <br /> *'''Name''' - The name of the personality to set it to (defined in \Assets\GameCore\DefaultPlayerAI.xml) <br /> <br /> === [[DestroyBuilding|DestroyBuilding]] ===<br /> <br /> Destroys a specific script-spawned building.<br /> <br /> *'''Name''' - The name of the building to be destroyed. <br /> <br /> === [[DestroyUnit|DestroyUnit]] ===<br /> <br /> Destroys a specific script-spawned unit.<br /> <br /> *'''Name''' - The name of the unit to be destroyed. <br /> <br /> === [[Dialog|Dialog]] ===<br /> <br /> This creates a popup that can convey information or story to the player. Use with &lt;Entry&gt; tags.<br /> <br /> === [[Entry|Entry]] ===<br /> <br /> The actual text that will be displayed. Use only within &lt;Dialog&gt; tags.<br /> <br /> *'''Text''' - The actual text that is displayed. Corresponds to an entry in a .csv file in \Assets\UIText\ <br /> *'''Icon''' - The icon used with the text popup. Hard-coded to correspond to Ashes characters, and changes the text color to match. <br /> **Mac <br /> **Haalee <br /> **Vexen <br /> **Valen <br /> **Artix <br /> **Ventrix <br /> **Athena <br /> **Adrasteia <br /> **Agememnon <br /> **Agethon <br /> <br /> === [[EndMission|EndMission]] ===<br /> <br /> Use to force a win or loss of the scenario.<br /> <br /> *'''Victory''' - Set to 0 to lose the scenario or 1 to win. <br /> *'''String''' - The text that is displayed. <br /> <br /> === [[GrantStuff|GrantStuff]] ===<br /> <br /> Give a player free resources.<br /> <br /> *'''Player''' - The index of the player to be hooked up <br /> *'''Metal''' - The amount of metal being granted. <br /> *'''Quanta''' - The amount of quanta being granted. <br /> *'''Radioactives''' - The amount of radioactives being granted. <br /> *'''Turinium''' - The amount of victory points being granted. <br /> <br /> === [[GrantTech|GrantTech]] ===<br /> <br /> Give a player a free Quantum Upgrade<br /> <br /> *'''Player''' - The index of the player to be hooked up <br /> *'''Tech''' - The upgrade to grant [ HPs | Weapons | Radar | BuildingHPs | MetalStorage | RadsStorage | NexusHPs ]<br /> <br /> === [[HidePanel|HidePanel]] ===<br /> <br /> Hide UI panels.<br /> <br /> *'''HidePlayer''' - Hide the Player panel <br /> *'''HideRank''' - Hide the Rank panel <br /> *'''HideResource''' - Hide the Resource panel <br /> <br /> === [[LetterBox|LetterBox]] ===<br /> <br /> Disable commands and go to a cinematic, letterbox view.<br /> <br /> *'''Enable''' - 1 to turn letterbox mode on, 0 to turn it off <br /> *'''Snap''' - 1 to immediately go to/from letterbox mode instead of fading in/out <br /> <br /> === [[MoveUnit|MoveUnit]] ===<br /> <br /> Move an army to a location without stopping to fight<br /> <br /> *'''Name''' - Name of the unit to be moved <br /> *'''Position''' - x/y coordinates to move to <br /> *'''Repeat''' - 1 to repeat this command indefinitely. Use with multiple MoveUnit commands to create a patrol path. <br /> *'''Stop''' - 1 to stop the unit <br /> <br /> === [[Objective|Objective]] ===<br /> <br /> Use this to set objective notifications for the player (so they know what to do).<br /> <br /> *'''Name''' - The name of the objective, use this name when checking or hiding it. <br /> *'''Hide''' - If this objective should be hidden or not, usually this means the objective is complete. <br /> *'''String''' - What the objective displays on the screen. <br /> *'''SetCheck''' - If the objective checkbox is checked or not. <br /> <br /> === [[Restrict|Restrict]] ===<br /> <br /> To block the player from being able to access objects in the game.<br /> <br /> *'''Type''' - Unit, Building, Research or Orbital. Whatever type of object that is being restricted. <br /> *'''ID''' - The name of the object being restricted. <br /> *'''Enable''' - Set this to 1 to enable the object. You can use this to restrict something early in the scenario and then enable it later on (for example: when the player accomplishes an objective or after a set amount of time). <br /> <br /> === [[Reveal|Reveal]] ===<br /> <br /> Reveal the fog of war over a location<br /> <br /> *'''Name''' - The name of this reveal (so you can modify it with a later command) <br /> *'''Enable''' - 1 to enable, 0 to disable <br /> *'''Position''' - x/y coordinates of the center of the revealed area <br /> *'''Size''' - Radius of the area to be revealed <br /> *'''RadarSize''' - Use to add a radar component to the reveal. Can be used with Size=&quot;0&quot; to create a radar-only reveal <br /> <br /> === [[SpawnBuilding|SpawnBuilding]] ===<br /> <br /> Places a building on the map.<br /> <br /> *'''Name''' - The name you assign to the building. <br /> *'''Template''' - The name of the building type being created. <br /> *'''Player''' - The player who will own the building. <br /> *'''Position''' - Where the building will be placed. <br /> *'''NoDeath''' - Set this to &quot;1&quot; to make the unit immortal (you can still kill it with a scripted DestroyBuilding command) <br /> <br /> === [[SpawnUnit|SpawnUnit]] ===<br /> <br /> Places a unit on the map.<br /> <br /> *'''Name''' - The name you assign to the unit. <br /> *'''Parent''' - The army the unit will belong to (used to make it easier to issue moves). <br /> *'''Template''' - The type of unit being created. <br /> *'''Player''' - The player that will own the unit. <br /> *'''Position''' - Where the unit will be created. <br /> <br /> === [[Var_Command|Var]] ===<br /> <br /> Set or modify a variable. Tip: Set any variable you want to use to 0 in the initial setup trigger to avoid unpredictable results. ''All values must be integers.''<br /> <br /> *'''Name''' - Name of the variable <br /> *'''Value''' - The value to be used in the operation <br /> *'''Min''' - Minimum value for random functions <br /> *'''Max''' - Maximum value for random functions <br /> *'''Operation''' - Operation to be performed <br /> **&quot;=&quot; or &quot;Set&quot; - set to the value <br /> **&quot;+&quot; or &quot;Add&quot; - add value <br /> **&quot;-&quot; or &quot;Sub&quot; - subtract value <br /> **&quot;Rand&quot; or &quot;SetRand&quot; - set to a random value between Min and Max <br /> **&quot;AddRand&quot; - add a random value between Min and Max <br /> **&quot;SubRand&quot; - subtract a random value between Min and Max <br /> <br /> [[Category:Modding]] [[Category:Commands]]</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9582 2018-02-22T10:32:40Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Objective command is used to display and update the in-game objectives panel in the top right corner. <br /> <br /> Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> Here's an example of what it'd look like:<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9581 2018-02-22T10:32:17Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Objective command is used to display and update the in-game objectives panel in the top right corner. <br /> <br /> Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> Here's an example of what it'd look like:<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9580 2018-02-22T10:31:00Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Objective command is used to display and update the in-game objectives panel in the top right corner. <br /> <br /> Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> Here's an example of what it'd look like:<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> <br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt;<br /> <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9579 2018-02-22T10:30:20Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Objective command is used to display and update the in-game objectives panel in the top right corner. <br /> <br /> Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> Here's an example of what it'd look like:<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9578 2018-02-22T10:30:07Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Objective command is used to display and update the in-game objectives panel in the top right corner. <br /> <br /> Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> Here's an example of what it'd look like:<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9577 2018-02-22T10:29:58Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Objective command is used to display and update the in-game objectives panel in the top right corner. <br /> <br /> Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> Here's an example of what it'd look like:<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9576 2018-02-22T10:29:22Z

<p>AlphonsoHornibro: </p> <hr /> <div>The Objective command is used to display and update the in-game objectives panel in the top right corner. <br /> <br /> Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> Here's an example of what it'd look like:<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9575 2018-02-22T10:27:12Z

<p>AlphonsoHornibro: </p> <hr /> <div>Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9574 2018-02-22T10:27:03Z

<p>AlphonsoHornibro: </p> <hr /> <div>Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9573 2018-02-22T10:26:54Z

<p>AlphonsoHornibro: </p> <hr /> <div>Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: true=box is checked, false=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;<br /> <br /> &lt;Trigger Name=&quot;Dialogue_02d&quot; Type=&quot;Timer&quot; Timer=&quot;1&quot; Inactive=&quot;1&quot; &gt;<br /> &lt;Objective Name=&quot;Mex_Built_Obj&quot; String=&quot;NewTutorial_Obj_Mex&quot; SetCheck=&quot;false&quot; /&gt; <br /> &lt;/Trigger&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=Objective&diff=9572 2018-02-22T10:21:39Z

<p>AlphonsoHornibro: Created page with &quot;Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: 1=box is checked, 0=box is not &lt;Obj...&quot;</p> <hr /> <div>Objective Name: Arbitrary name given to the objective String: String representing an objective name in the mission text CSV file SetCheck: 1=box is checked, 0=box is not <br /> &lt;Objective Name=&quot;ObjEx&quot; String=&quot;Mission5_Objective1A&quot; /&gt; &lt;Objective Name=&quot;ObjEx&quot; SetCheck=&quot;1&quot;/&gt;</div>

AlphonsoHornibro https://wiki.ashesofthesingularity.com/index.php?title=LetterBox&diff=9571 2018-02-22T10:20:50Z

<p>AlphonsoHornibro: Created page with &quot;LetterBox disable commands and goes to a cinematic, letterbox view used to introduce missions. Here&#039;s what it looks like. &lt;LetterBox Enable=&quot;1&quot; Snap=&quot;1&quot; /&gt;&quot;</p> <hr /> <div>LetterBox disable commands and goes to a cinematic, letterbox view used to introduce missions. Here's what it looks like.<br /> <br /> <br /> &lt;LetterBox Enable=&quot;1&quot; Snap=&quot;1&quot; /&gt;</div>

AlphonsoHornibro