Subscribe to download
Spawn Map-Objects [b41]

Modder's note: I lack the time to update this mod and I have not done mapping for a long time now, I cannot provide support but you can give a look and take the code from this and adapt it to your need if you can make it useful!





While I was working with the map editor, I got frustrated some items could not be placed using it. For instance, barricades and campfires. So we decided with a friend to solve this problem... Once done we decided to make this mod and make it as generic as possible ! This should allow any mapper to use our object-spawning system to make better maps and any modder to upgrade it with ease.


Nothing. This mod should be a dependency mod for any map that uses the Spawn Map-Objects Utility. One you have this mod installed, it should work without needing you to do anything.



This mod will allow you to place items events within the map editor like campfire, tents, wall frames, zombies... Those placeholders will be converted into their working version inside the map once loaded. This means you will be able to place pick-up-able tents, light-able campfires, thumpables wooden and metal structures, break windows, spawn zombies at precise places and even more !


The installation is very simple, once you have subscribed and download this mod, locate it's installation folder :

\Steam_Installation_Folder\steamapps\workshop\content\108600\974718243\mods\SpawnMapObjectsUtil

Once inside the mod folder, you should see a Tiles folder. Open it, and then open the 2x folder. You should see all the placeholders images you will need.

Copy all these .png files to the 2x folder of your Tilezed.

Now, you should be able to use the placeholders via the tilset list. I usually place those on the Furniture layer but it should work on other layers too.



If you want to test the features, check out the building we are using for internal testing : https://rbfi.io/dl.php?key=/0Sol/testmap.tbx

Once your map is finished and you are ready to publish it to the workshop make sure to add this mod to the dependencies of your map. So that it will be prompted to the players to install it with your map.


Of course, here is the list of what you can do with the current version of Spawn Map-Objects Utility.

• Place thumpable walls of all possible quality with adjusted durability (Logs, wood, metal).
  
• Place fences adjusted durability too (Sandbags, wood, metal plates or bars).
  
• Place thumpables and working-properly barricades on windows (1,2,3 or four planks, metal sheet, metal bars)
  
• Place upgradable by player walls frames.
  
• Place weapons, literature, trash and food items on the floor.
  
• Place properly-interactable camping materials (tents, campfires and compost)
  
• Zombies-spawner at specific places (Horde inside a tower away from the city or a lone zombie in a specific room...)
  
• Add water collecting barrels already full of water
  
• Place fishing-nets on your lake or generators in a specific room
  
• Break specific windows on the map (with them still barricadable and full of dangerous shards).
  
• Break and remove glass from windows and keep it barricadeable
  
• Place sheetropes on windows.

We also plan to add more to this list with upcoming updates, things like traps, sound events and such.


As said earlier, we are planning to add more tiles to the placeholders. You can use the blue ones, but if you try to place a red one, it won't work. The red tiles are the not-implemented-yet features. But we kept it so that it will be easier to update once done.

Please do not use the red placeholder tiles.


Even more ! We made functions for you to easily add your own placeholders or remove the default placeholders shipped with the mod. Let me explain.


Once you have created the png of your custom new placeholder, you will need to code the replacement function in lua. To do it, you can write your lua file using this template :

Here are the explanations :

First, you need to implement the method MyPlaceholder.replace(square, tileObject) which will be called for each object found in each square loaded.
This method need to return a Boolean (true or false) to indicate if the method has worked.
If the method return true the program will automatically delete the tile placeholder else it does nothing.

Be careful of the optimisation of this method because it will be called a large number of times and may produce lag. To avoid bad performances, you should not log messages inside the console (do not forget to remove them after use if you do). Also, make sure tile you are currently checking matches your placeholder name unsing the startString method before doing anything complex.

The second step is to register your placeholder in the system with the method SpawnFromPlaceholder.Add(placeholderInfoObj).
The parameter expect one important property :

• name : the name of your object which contains at least the method replace()

This mod allow you to remove unused shipped placeholders to save resources and gain performance.
To remove the placeholders, you can use this snippet :

The method will remove the placeholders listed in the array when the event OnGameStart is fired.

• BarricadePlaceholder
  
• CampingCompostPlaceholder (campfire, tent and compost)
  
• CarpentryAndConstructedPlaceholder (sandbag, barrel, rain collector, lamp)
  
• DroppedFoodItemsPlaceholder
  
• DroppedTrashItemsPlaceholder
  
• DroppedWeaponsItemsPlaceholder
  
• GeneratorPlaceholder
  
• TrapsPlaceholder
  
• WallsPlaceholder
  
• WindowStuffPlaceholder (smash clean window, sheet rope)
  
• ZombiePlaceholder

Workshop ID: 974718243
Mod ID: SpawnMapObjectsUtil