Welcome to the scenario modding guide!

This guide will cover everything to create custom scenarios, including how to setup a basic scenario, how to create quest & dialogs as well as events, parameters and custom scenario specific gameplay adjustments.
This guide will NOT cover asset creation (textures / models / sounds), custom content like buildings or spaceships (please refer to our more general modding guide: Creating mods for Planet S) or the process of setting up a workshop mod through the editor (please also refer to the general guide linked above).

Make sure that you have setup a mod using the editor before you continue!

To start we first have to create a scenario script. Scenario scripts have to be placed the scripts/scenarios folder. The full path world be {PlanetSInstallFolder}/editor/mods/{YourModsName}/scripts/scenarios. We would also recommend you to create a subfolder with the name of your mod to prevent conflicts (e.g. {PlanetSInstallFolder}/editor/mods/{YourModsName}/scripts/scenarios/testMod/). In that folder or any subfolder you need create a lua file, for example testScenario.lua. This script file will contain everything that is relevant for your scenario.

Every scenario script starts of with a registerScenario function:
This function will be automatically called by the game on startup and it wants a lua table with information and the structure of the scenario. In this guide we will refer to this table as the Scenario Table. In this basic example we are defining two of the required fields: "name" and "description". These will be used in scenario menu and to identify the scenario. This should already be enough to get your scenario registered, but the game won't consider it playable yet. That also means it won't show up in the scenario menu yet. It will however show up if you go and create a new creative game. But before you go and check, you first have to either upload your current mod to the workshop and subscribe to it yourself (don't worry other won't see it unless you set it to public) or you can copy your mods folder from the editor/mods folder to the mods folder of the game ({PlanetSInstallFolder}/mods) just make sure that you don't work on those files as they will only be uploaded from the editor mods folder. After you have done that, start the game. In the create menu (creative mode only) under "Game Options" there is a scenario combo box. Your scenario should now show up in that combo box. Make sure that it does before you continue!

That brings us to our next step. To make a scenario playable you also have to specify a savegame and at least one chapter. The savegame can't be just any savegame, it has to one specifically for your scenario. To create one you can use the creative mode by selecting the scenario during world creation.
Then once you are loaded into the game, create a savegame and copy from the saves folder, directly next to your scenario script file.
After that we can specify the savegame in the script as follow:
You can rename the savegame however you want but make sure that it ends with .pss!

Next we need to specify a chapter. We will dive into chapters in the next section so for now you can just copy & paste this minimal setup:
Now your first scenario should be good to go and the game should consider it playable. Check that by starting the game (don't forget to copy any changed files / reupload) and going into the scenario menu. Your scenario should now be listed there!

Every scenario in Planet S is divided into one or more chapters. A chapter is basically a section of the scenario with its own set of quests, dialogs and parameters. As you might have noticed before, chapters are also defined in the scenario table.
A chapter has to have a name and a set of parameters. The first chapter will also be the one that the scenario will start with. We will go into how to jump to a chapter in the Callbacks & Logic section of this guide.
Here is an example for a scenario with 4 chapters:
Every chapter has its own set of parameters, which brings us to the next subject: Scenario Parameters!

Scenario parameters are a way to configure certain parts of the game or to change the behavior of existing game components. In the example above there are two distinct scenario parameters: DISABLE_TRADER and DISABLE_PIRATES. Both do pretty much exactly what you would expect: DISABLE_TRADER prevents the neutral trader from spawning while the flag is active (He won't spawn in chapter 1 & 2 in this case) and DISABLE_PIRATES prevents the pirates from attacking (Chapter 1 & 3). Keep in mind that you need to enable the pirates during world creation, otherwise this parameter won't make any difference anyways. A full list of all available parameters can be found in the Reference: Scenario Parameters section of this guide.

Quests are the main way to define player objectives on a per chapter basis. Each chapter can have its own list of quests. A quest in Planet S is made up of an ID, name, description and at least one task. The ID is required, the name and description can also be a language key if you want to translate your scenario into different languages but we won't cover that in this guide.
A task is a specific action or goal that the player has to complete and all tasks of a quest have to be completed to fulfill the quest.
Here is an example for a scenario with two quests in the first chapter:
Lets break down how this works:
The first quest requires the player to build 10 worker residences and a city center on any planet they own combined.
The second quest requires the player to build 3 wind parks on any planet they own combined.
Both quests use the task type BuildingPlacedTask which just tracks building placement.
The parameter buildingTypeID specifies which building type to place and the parameter count how many to place. You could leave out these parameters and the task would still work. It would then default to 1 building of any type.
The same goes for other parameters that are not specified here. For this task for example there are parameters to specify the factionID (numerical index of the faction starting at 0, default is also 0), planetID (numerical index of the planet starting at 1, default is undefined), planetTypeID (string ID of the planet type, default is undefined) and tileID (numerical index of the tile on a planet, default is undefined). These params let you specify for example on which planet or type of planet something should be placed, by which faction or even on which tile specifically.
There are a ton of different task types in the game that you can use or combine to create different types of quests. Check Reference: Tasks for more details and a list of all task types.
When starting this scenario you might notice that the quests don't actually start or appear. We will cover that and other progression stuff in the next section.

This section will cover a few different progression related topics:

• Starting a quest
  
• Automatically or manually advancing to the next quest
  
• Tracking progress for inactive quests

Lets start with how to start a quest. By default the game will not start any of the quests in the active chapter and there can also only be one active quest at a time. To show our first quest after starting the scenario we need to tell the game to do exactly that. For that we can use a callback function which will be automatically invoked by the game when the scenario starts: onScenarioStart:
In this callback we are calling the ScenarioManager and telling him to start the quest with the given ID. The game will then start and display the quest.
Note: startQuest will not cancel the currently active quest and will fail instead.
There is also a function to complete a quest: ScenarioManager.completeQuest(questID) and one to cancel the currently active quest: ScenarioManager.cancelActiveQuest().
On top of that you might also want to create gameplay dependent quests which can be done using ScenarioManager.createAndStartQuest(questTable). In that case questTable refers to a lua table with the same structure as any quest in the quests section of a chapter.
There are various other callbacks that you can use to start or cancel quests in different situations then just the start of the scenario and we will go into more detail in Callbacks & Logic.

Next up is advancing to the next quest. By default the game will automatically advance to the next quest in the quests table of a chapter. This behavior can be overwritten:
In this case the first quest (quest_0) will automatically progress to quest_1 on completion, quest_1 on the other hand will not. After quest_1 there will be no active quest so you will have to tigger the next one manually using startQuest or createAndStartQuest.
quest_2 will also automatically progress and start the next quest but in this case not the next in the list but quest_4 instead.

The last progression related topic would be tracking of progress for inactive quests. Why or when do you need that? Lets revisit our first quest example:
Those where the first two quests but with one key difference in the second quests task: earlyCompletePossible = true . What this does is for the task to be completed before the quest has actually started. The problem this solves is that the player might choose to first build wind parks and then the city to complete the first quest. Without this progression flag the player would then have to again build additional 3 wind parks. With this flag the second quest will either complete automatically if the player has already build 3 wind parks or track the progress correctly if the player had already build 1 or 2 wind parks.
Note: This will only work for quests in the active chapter. Tasks for quests in any other chapter will not track any progress.

At the moment our quest descriptions are a bit boring as they only contain plain predefined text. Instead what we would like to have is task progress to be displayed in the description of the quest. For example like this:
This can be done using description elements.
This is definition of the quest from the example image:
In our quest description we can use /n to insert a line break / make the text multi line and we can use % followed by any number between 0 and 9 to insert dynamic quest specific elements into our description. These markers will be replaced by content that is defined in descriptionElements in our quest definition. In this case we are replacing %0 with the progress of our first task and %1 with the progress of our second task.
There are various different description elements that you can use. Each task has a progress and completed element ("taskX.progress", "taskX.completed") but some tasks also have their own special elements. Check References: Tasks for which are available for specific tasks. On top of task elements there is also a quest progress ("quest.progress") and there are also variable set elements but we will cover those later in Saving Progress.

This section will cover more types of callbacks that the scenario system provides as well as how to implement your own scenario logic and how to utilize the event system.
To start of here is a list of available callbacks that you can add to your scenario script:
The callback onQuestEvent is a special one and can be very powerful as it allows you or your scenario to react on stuff based on various different things that can happen in Planet S. There are a ton of different events that are fired when playing the game with all kinds of information attachted to them. You can find a full list in Reference: Events.
Events all have a numerical ID with which you can easily identify which event was just fired. You can compare the incoming eventID parameter with the ID of the event type that you are looking for. You can access each event type ID by adding .ID to the type like this: BuildingPlacedQuestEvent.ID.
To access any data that the event carries you first have to cast the incoming event data to the specific event using the cast function like this: BuildingPlacedQuestEvent.cast(event).
Lets look at to examples for how you might use this system:
This is fairly simple and self-explanatory. We wait for the PiratesSpawnedQuestEvent, which triggers whenever the pirates spawn, by checking the incoming eventID parameter for PiratesSpawnedQuestEvent.ID. Then when the event triggers we start a quest where the player has to defeat those pirates. Pretty simple, right?
Now lets look at a more complex example where we might want to use event data:
In this example we are looking for a ColonyEstablishedQuestEvent which triggers whenever a faction colonizes a previously uncolonized planet. Then we use the event data to filter for a bot faction and a normal / grass planet to be the planet type. Then we trigger a dynamic quest which will ask for the player to take specifically this colony from the bot. We specify the planet by using the planetID of the event which is part of the event data.

So there are plenty of ways to get feedback from the game but what else can we do to react to player behavior or other events?
We have already used some function like startQuest, createAndStartQuest or finishedQuest which are all called on the ScenarioManager. This manager has quite a few more function you can use to perform different things. You can find a full list in Reference: Scenario Manager.
Again here are two more examples for what you can do using the ScenarioManager:
In this example we are looking for the quest from a previous example to be completed. Then we look for the players main planet using ScenarioManager.scenarioGetInterestingPlanetID. This function returns the ID of the most interesting planet with the given constraints. The most interesting planet is the one with the highest economic score. We are looking for a planet owned by faction 0 (the player) and of type "pt_normal". If the player doesn't own a planet of that type the function will fallback to any planet type and then to any faction if the player doesn't own any planet at all.
With that info we grant that planet 50 guns using ScenarioManager.scenarioGiveItemsToPlanet as a reward. On top of that we also gift the player faction 100k credits using ScenarioManager.scenarioAddCredits.

Here is another more complex example:
Here we wait for the player faction to establish any colony using the event system. As soon as that happens we manually trigger the pirates with a custom evil fleet of 3 battle cruisers which specifically target the player faction using ScenarioManager.scenarioTriggerPiratesManuallyFaction. Then we wait for the PiratesRetreatedQuestEvent and check if they were defeated or if they just left because they were successful with their raid. If they were defeated we grant the player a battle cruiser using ScenarioManager.scenarioCreateShipSpace which we spawn outside of the map. We then order it to fly to the players main planet using ScenarioManager.scenarioShipSetTargetPlanet.

Since you can do quite a lot of different custom stuff in scenarios you might also want to store some data or custom progress in the savegame file as global or local variables in the scenario script will not survive a game restart and could even leak into other scenario runs.
As previously mentioned in Quest Descriptions there is something called a variable set which is attached to the scenario state object that is passed into all callbacks as a parameter.
This variable set will be stored into and loaded from the savegame file so its safe to use it as a way to store progress.
Since we have to handle this on the C++ side of the game, its a bit limited in what it can store. For example it can't store lua tables, arrays, maps or strings, just numbers and bools. It basically works like a map or dictionary with key-value pairs.
Again here is an example:
Here we count how many technologies the player has unlocked and give him 50k credits every time he unlocks 5 techologies. We store our progress in the variable set under the name "technologiesUnlocked" and we use an unsigned integer as the data type.
As you can see you can query the existance of a variable using doesVariableExist, add one using addUInt32_t (or addInt32_t, addFloat, addBool), set it using setUint32_t (same for the other three types) and remove it using removeVarible. You can also clear the entire set using clear.
The actual saving and loading will be taken care of by the game just like for the progress of quests, tasks and dialogs.
Also as mentioned before you can also display variable set values in quest descriptions using description elements. They need to be specified as follows: "variableSet.type.variableName", so for our example that would be as follows: "variableSet.uint32_t.technologiesUnlocked".

Next we will cover how to put logic in place so that a scenario can be won or lost and specific victory & defeat conditions / quests.
You as the scenario creator decide when the scenario can be won and when a player might lose. To trigger either you again have to call the Scenario Manager.
Here is an example:
In this case the player will trigger a scenario victory when that faction will construct an exo spaceship. A scenario defeat will be triggered when any explorer of the player faction gets destroyed.
Both outcomes would look like this when triggered:
Victory:
Defeat:
In short: you can trigger a victory or defeat at any point using ScenarioManager.finishScenarioWin or ScenarioManager.finishScenarioLoss. The parameters are the same for both functions and work as follows: The first parameter is a message that will be displayed in the victory / defeat screen, the second parameter defines, if the player should be able to keep playing after the victory / defeat screen. The third and fourth parameter should usually always be set to false. The third one defines if the game should instantly just exit back to the main menu without displaying a victory or defeat screen and the fourth one is just for campaign scenarios and has no impact outside of that.

It would also be nice to have the option to display this information to the player so that its easy to see how to win or lose. Thats what victory and defeat conditions are for. Both are just like quests but you can have multiple active at the same time. This has the nice bonus that you can use the builtin quest tasks and description system to check for these conditions. They are also marked with a special icon in the quest UI:



These victory and defeat conditions can be added or removed using ScenarioManager.addVictoryCondition(questTable), ScenarioManager.addDefeatCondition(questTable), ScenarioManager.removeVictoryCondition(id) and ScenarioManager.removeDefeatCondition(id).
Note: When these get completed, they won't auto trigger a victory or defeat and they will also not trigger the regular onQuestCompleted but the onVictoryConditionCompleted or onDefeatConditionCompleted instead.
Both condition types can also be specified per chapter similar to quests but in a dedicated victoryConditions and defeatConditions table.
Here is the example from above turned into victory and defeat conditions:

In your scenario you might want to tie things together by telling a story. This can be done through dialogs. Dialogs in Planet S are fairly simple as there is no player input or decisions, just characters and text lines. Example:

Dialogs are made up of pages with each page being made up of a character state and a text line. Dialogs are defined on a per chapter basis just like quests, victory and defeat conditions.
Here is an example for a simple dialog:
This is a simple conversation between Hazel and Theo from the campaign. The dialog is made up of three pages. The character expressions are a bit tedious to define so here is a tip: The character expression setups are all predefined in "scripts/scenarioDialogs/character_animations.lua" you can include this using require in your scenario script and use the predefined tables from that.
This is the adjusted script setup:
You can find a full list of predefined character expression setups in Reference: Characters.
Now we can show / start a dialog using ScenarioManager.showDialog(dialogID, cancelActive). You can also hide / cancel any an active dialog using ScenarioManager.hideDialog.

Another thing you might want to do in your scenario is to have custom buildings, spaceships or even planets or a fully custom world type. All of this is already possible with mods. Luckily scenarios scripts have the same capabilities as mod scripts so you can also have a registerSpaceships, registerBuildings or registerWorldTypes (or all other register functions that are available in mod scripts). You can also use your custom world type to create a savegame for your scenario. Just setup everything in the scenario script file, select your scenario in the creative create menu and then you should be able to select any world type from the scenario script.
Quick example:
This will remove the interceptor from the small spaceship yard in the scenario. For more info refer to our other modding guide.

The behavior of bots in scenarios can also be modified using bot profiles. Bot profiles can be set per bot per chapter. There are three different bot profiles: "STANDARD" (the default behavior), "NO_PROGRESS" (the bot will maintain its current setup but it won't build ships, upgrade or expand its cities or attack anyone) and "NO_OFFENSE" (the bot won't build military to attack other bots or players).
Here is an example for how to set a bot profile:

This section covers a couple of tricks that might help you:

• If you have already released your scenario and plan to fix or change something about it keep this in mind: Changing the quest structure / tasks or chapters can break existing scenario savegames. In those cases it makes more sense to copy & paste your existing scenario script and to make these fundamental changes to that script file. Don't forget to add something like a version suffix to the scenario ID and maybe also name. Changes in the logic like in the callbacks are usually fine but that depends on what you are changing.
  
• When you make changes to quests or description elements or chapters during development then keep in mind that these changes might not show up in your testing savegame of your scenario (not the one you created in creative mode but any savegame after actually starting the scenario to test it). So if you don't see your change where you expect it, consider restarting the scenario from scratch though the scenario menu.
  
• Since it can get tedious to replay all parts of your scenario every time you have to restart you can add a trick to skip quests or build your own cheats based on keyboard input. Keep in mind to remove this test code before uploading your scenario or otherwise people might accidentally run into issues or cheat when they don't want to. Here is an example for how to skip the active quest based on a key input (pressing F8 in this case):
  
  AEX:loadLibraries({ "AEX_Platform" }) --Should be at the top of your script file, first line --.... onUpdate = function(scenarioState, world, passedTime) if AEX_InputHandler:wasKeyPressed(InputHandler.KEY_F8) then ScenarioManager.scenarioSkipQuest() end end
  The active quest will be auto completed and trigger onQuestCompleted for that quest. Just know that this might mess with what you are doing in your logic since the player isn't actually completing the tasks.

Description Elements:

• buildingTypeID
  
• factionID
  
• planetID
  
• planetTypeID
  
• count
  
• maxCount

Description Elements:

• newBuildingTypeID
  
• oldBuildingTypeID
  
• factionID
  
• planetID
  
• planetTypeID
  
• count
  
• maxCount

Description Elements:

• buildingTypeID
  
• factionID
  
• planetID
  
• planetTypeID
  
• count
  
• maxCount

Description Elements:

• buildingTypeID
  
• factionID
  
• planetID
  
• planetTypeID
  
• count
  
• maxCount

Description Elements:

• spaceshipTypeID
  
• factionID
  
• spaceshipID
  
• count
  
• maxCount

Description Elements:

• spaceshipTypeID
  
• factionID
  
• spaceshipID
  
• count
  
• maxCount

Description Elements:

• factionID
  
• spaceshipID

Description Elements:

• factionID
  
• planetID
  
• planetTypeID

Description Elements:

• factionID
  
• planetID
  
• planetTypeID

Description Elements:

• newFactionID
  
• oldFactionID
  
• planetID
  
• planetTypeID

Description Elements:

• factionID

Description Elements:

• technologyID
  
• factionID

Description Elements:

• factionID
  
• sourcePlanetID
  
• destinationPlanetID
  
• itemID

Description Elements:

• factionID
  
• activeCount
  
• count

Description Elements:

• factionID
  
• planetID
  
• itemID

Description Elements:

• factionID
  
• planetID
  
• itemID

Description Elements:

• factionID
  
• planetID
  
• planetTypeID
  
• populationID
  
• populationCount

Description Elements:

• factionID
  
• planetID
  
• planetTypeID
  
• itemID
  
• itemCount

Description Elements:

• factionID
  
• moneyAmount

Description Elements:

• factionID
  
• upkeepAmount

Description Elements:

• factionID
  
• planetID
  
• planetTypeID
  
• powerAmount

Description Elements:

• factionID
  
• planetID
  
• planetTypeID
  
• itemID
  
• productionRate

Description Elements:

• factionID
  
• planetID
  
• planetTypeID
  
• itemID

Description Elements:

• factionID
  
• planetID
  
• planetTypeID
  
• count
  
• maxCount

Description Elements:

• factionID
  
• planetID
  
• planetTypeID

Description Elements:

• factionID
  
• count

Description Elements:

• factionID
  
• planetID
  
• score

Description Elements:

• factionID
  
• spaceshipID
  
• damage
  
• maxDamage

Description Elements:

• factionID
  
• spaceshipID
  
• planetID
  
• planetTypeID
  
• timer
  
• maxTimer
  
• timerFormattedSeconds
  
• timerFormattedMinutes

Description Elements:

• factionID
  
• spaceshipID
  
• planetID
  
• planetTypeID
  
• itemID
  
• itemCount

Description Elements:

• duration
  
• time
  
• timeLeft
  
• timeFormattedSeconds
  
• timeFormattedMinutes

Description Elements:

• factionID
  
• spaceshipID
  
• healthPercentage
  
• currentHealthPercentage
  
• healthPercentageTarget

Description Elements:

• factionID
  
• planetIDs
  
• remainingPlanetIDs

Description Elements:

• factionID
  
• planetID
  
• count
  
• maxCount

Description Elements:

• factionID
  
• technologyTypeID

Description Elements:

• factionID0
  
• factionID1

Description Elements:

• factionIDFrom
  
• factionIDTo
  
• planetID
  
• planetTypeID

Description Elements:

• initiatorFactionID
  
• targetFactionID
  
• spaceshipID
  
• planetID
  
• planetTypeID
  
• transactionAmount

Description Elements:

• factionID
  
• spaceshipID
  
• convoyTargetSpaceshipID

Description: Starts a quest
Description: Creates a dynamic quest and starts it
Description: Returns the ID of the currently active quest
Description: Returns whether any quest is currently active
Description: Completes the given quest instantly
Description: Cancels the currently active quest
Description: Instantly progresses to the chapter with the given index
Description: Adds the given victory condition
Description: Returns whether the given victory condition is active
Description: Removes the given victory condition
Description: Adds the given defeat condition
Description: Returns whether the given defeat condition is active
Description: Removes the given defeat condition
Description: Shows the given dialog
Description: Hides the current dialog
Description: Returns whether any dialog is active
Description: Returns the current dialog
Description: Activates the given scenario parameter (See: Reference: Scenario Parameter)
Description: Deactivates the given scenario parameter (See: Reference: Scenario Parameter)
Description: Checks if the given scenario parameter is active or not

Description: Triggers a scenario victory with the given message and parameters. (Note: The parameter campaign can be ignored)
Description: Triggers a scenario defeat with the given message and parameters. (Note: The parameter campaign can be ignored)
Description: Shows a message banner in the top section of the screen with the given message for the given duration. (Only one possible at a time)
Description: Spawns a spaceship in space. The parameter 'executeDirectly' can be relevant if you want to access certain ship stats directly after creating the ship as ships take one game tick to be created with this flag set to false. Returns the ID of the created ship.
Description: Spawns a spaceship in space. The parameter 'executeDirectly' can be relevant if you want to access certain ship stats directly after creating the ship as ships take one game tick to be created with this flag set to false. Returns the ID of the created ship.
Description: Adds the given amount of credits to the bank of the given faction. (Negative values are possible)
Description: Adds the given items to the planet with the given planet ID.
Description: Hides or shows the given spaceship.
Description: Prevents the given item from being traded by blocking the creation of trade entries for that item type.
Description: Reallows the given item from being traded.

Description: Returns the amount of items of the given type on the given planet
Description: Removes all items of the given type from the given planet
Description: Adds the given trade entry to the given planet
Description: Removes the given (matching) trade entry from the given planet
Description: Teleports the given ship to the given planet above the given tile
Description:Teleports the given ship to the given position
Description: Sets the target of the given ship to the given planet tile
Description: Sets the target of the given ship to the given planet
Description: Sets the target of the given ship to the given position (in space)
Description: Set the minimum hitpoints of the given ship to the given amount
Description: Sets the items in the given slot of the given ship
Description: Adds the given items to the inventory of the given ship

Description: Tries to remove the given amount of items from a spaceship. Returns the amount that was actually drawn (<= amount)
Description: Destroys the given spaceship
Description: Sets the diplomatic status between two factions.
Description: Checks if the given position collides with a planet. (Does not check the sun).
Description: Force triggers the neutral trader. (Only works if the scenario parameter to disable the trader is NOT active)
Description: Force triggers an immediate priate attack with the given parameters. (Only works if the scenario parameter to disable the pirates is NOT active and if pirates are enabled in the savegame)
Description: Force triggers an immediate priate attack with the given parameters. (Only works if the scenario parameter to disable the pirates is NOT active and if pirates are enabled in the savegame). 'fleetTable' is a list of spaceship type IDs with the amount to spawn. Example:
Description: Force triggers an immediate priate attack with the given parameters. (Only works if the scenario parameter to disable the pirates is NOT active and if pirates are enabled in the savegame). 'fleetTable' is a list of spaceship type IDs with the amount to spawn. Example:
Description: Removes the given ship from any active pirate fleet. This will cause the ship to not receive any new tasks from the pirate controller.
Description: Changes if the ship is controllable by the player or any bot factions.
Description: Changes if the ship should be invincible or not
Description: Changes if the colony is controllable by the player or any bot factions.
Description: Changes if the colony is invincible or not. An invincible colony is the same as setting all buildings invincible manually.

Description: Removes the invincibility from the military buildings on the given planet
Description: Sets the invincibility of the given building
Description: Returns the tile ID of the (first) spaceship yard on the given planet, if any
Description: Sets the amount of dyson probes for the given faction
Description: Returns the amount of dyson probes of the given faction
Description: Instantly transfers the ownership of a planet to the given faction, if the planet is already colonized a takeover is performed, otherwise a spaceport is placed in order to colonize the planet
Description: Instantly performs a trade between the given neutral trader ship and the given planet
Description: Sets the name of the given ship
Description: Sets whether to show a special mark on the minimap for the given ship (exclamation mark)
Description: Sets whether the given ship should stop automatically attacking enemy ships and buildings
Description: Resets the attack target of the given ship
Description: Returns whether the given faction owns a planet of the given type
Description: Returns the planet with the highest economic score, the search can be filtered by passing the faction ID or a specific planet type
Description: Returns the tile ID of the spaceport on the given planet, if any

Description: Looks for a building of the given type on the given planet and returns its tile ID.
Description: Returns the planet ID of the closest planet to the given one
Description: Checks if the given planet contains a building of the given type.
Description: Places a building of the given type on a planet.
Description: Places a building of the given type on the tile with the given ID.
Description: Destroys the building on the given tile.
Description: Transfers the ownership of a planet to another faction. This will trigger a takeover including its configured implications.
Description: Returns if the neutral trader is currently active.
Description: Automatically builds defense buildings on the given planet.
Description: Returns the ship ID of any active fake trader.
Description: Returns if the pirates are currently active.
Description: Changes the visibility of the given faction in the dyson swarm menu.
Description: Changes the pushing behavior of the given ship (won't be pushed around by other ships if disabled)
Description: Applies a research boost to the given faction. This adds direct research progress to the currently researched technology.

Description: Returns whether the given faction currently researches a technology
Description: Instantly sets the given building to the ruined state
Description: Sets whether the military buildings on the given planet are invincible
Description: Resets the colony war timer of the given planet back to its maximum (30 seconds)
Description: Triggers a bot buildup for the given faction, where the bot quickly (and without respecing construction costs) advances up to the givent target tier
Description: Causes the bot with the given faction ID to wanting to destroy all currently present pirate ships
Description: Sets the bot parameter "militaryFleetFactor" for the given faction, influencing the amount of ships it wants to own (mutliplier, easiest 1.0, harder above)
Description: Sets the bot parameter "colonyOvertakeFleetMultiplier" for the given faction, influencing how many ships the bot requires before daring to attack an enemy planet
Description: Sets the "bot class" of the given ship, determining whether the owning bot uses this ship for attacks
Description: Resets the "bot class" of all ships in the world
Description: Sets the name of the bot with the given faction ID
Description: Causes the bot with the given faction ID to escort the given ship
Description: Causes the bot with the given faction ID to stop escorting the given ship
Description: Causes the bot with the given faction ID to attack the given ship, "allIn" causes the bot to use all its available ships

Description: Aborts any attack by the bot that is currently planned for the given ship
Description: Schedules an the given planet for attack by the bot. The parameter 'instant' will force an instant attack (high priority)
Description: Answers any active proposal between the bot and the given other faction
Description: Creates a notification
Description: Creates a notification with a ship as the target (clicking on the notification will take the player to that ship)
Description: Creates a notification with a planet as the target (clicking on the notification will take the player to that planet)
Description: Creates a notification with a building / tile as the target (clicking on the notification will take the player to that tile)
Description: Forces the given colony to enter war mode by performing an attack on the given tile
Description: Performs a trigger action with the given ID. Triggers can be used in conjunction with TriggerQuestEvent or TriggerTask to track custom actions.

Description: Triggers a quick save
Description: Sets the active bot class to use for attacks or other ship actions
Description: Returns the current attack class of the bot
Description: Spawns a custom tile marker on the given tile
Description: Removes any custom tile marker from the given tile
Description: Clears all custom tile markers from the given planet
Description: Clears all custom tile markers
Description: Creates a diplomatic proposal to improve the diplomatic status between the given two factions
Description: Returns if the given ship is currently traveling
Description: Returns the current hitpoints of the given ship
Description: Returns the max hitpoints of the given ship
Description: Returns the current shieldpoints of the given ship
Description: Returns the max shieldpoints of the given ship
Description: Returns the position of the given planet
Description: Returns the planet type ID of the given planet
Description: Returns if the given ship is within world bounds