Skip to content

takeInventory

(NEW) This feature is valid for Expeditions only.

Overview

The takeInventory substage corresponds to an assignment where the player needs to take a set of different Inventory Items from the particular zone(s).

NOTE: This substage may have multiple target zones that the player can take items from. These zones correspond to records in the zoneToTakeInvFrom list.

Similarly to objectConstruction substage, taking items from a target zone can be tied to some object on the map being "built" and "installed" or, on the contrary, being "dismantled" or hidden. This process can be configured using the Model Building Settings section of this substage. However, it is optional and gathering of items will work without it.

Setup

After selecting the appropriate settings type, the takeInventory section will contain the following settings:

  • zoneToTakeInvFrom list – The list of zone-related assignments corresponding to zones that the player needs to take items from. At least one record in this list is required. If you add multiple records to this list, the player will need to take items from all of these zones, in any order, with the particular items to be taken specified on the per zone basis.

    • [0], [1], [2], etc. – The record of the particular zone-related assignment corresponding to the particular zone that the player needs to take items from.

      • OptionalToPerform – (Optional) Enabling this option will mark this substage as optional. By default, this option is disabled and the substage is required. See Optional Substages for details.

      • uiDesc – The name of the substage that will be displayed in the UI of the game.

      • notification – (Optional) The notification to be displayed after completion of this zone-related assignment of the substage. See Notifications for details.

      • Fake Zones – (Optional) The list of initially possible, but, after exploration, unsuitable zones for the execution of this assignment. See Fake Zones for details.

      • globalZoneId – The target zone from which the specified items should be taken.

      • inventoryToTake – The list of all Inventory Items that need to be taken from this zone. Should contain at least one record.

        • [0], [1], [2], etc. – The record of the particular Inventory Item that needs to be taken from this zone. For every record the following settings are specified:

          • Type (will be renamed to Inventory Type to bring) – The type of Inventory Item that needs to be taken from this zone. One of the predefined types of inventory items should be selected here. For the full list of these types, see Appendix: Types of Inventory Items.

          • Inventory Id to bring (Currently not added, will be added soon) – (Optional) The identifier of the particular Inventory Item that needs to be taken from this zone. For example, Anchor and Removable Anchor have the same Inventory Type to bring and can be distinguished only by their identifiers. The identifier of the custom inventory item can be also specified here, if you want to use it as a linked mod.

            NOTE: For the system, the specified identifier (Inventory Id to bring) of the item will have more priority than its Type (Inventory Type to bring). However, if identifier will be not specified, the necessary item will be selected based on the specified type.

          • Amount – The amount of the specified inventory item that needs to be taken from this zone.

      • radiusSett – (Optional) The radius of the Zone Search Area where you want the player to search for the target zone, if you do not want to give the player its explicit location. See Zone Search Area for details.

      • Model Building Settings – the settings of the model that will change its visual state (e.g., it will be "built", "installed", "dismantled", or hidden) when the specified items will be taken from the target zone. See Model Building Settings for details.