¶ FUGU - Garrison Units Module
¶ Why was this module made and when to use it?
This module was made to reduce the amount of existing and acting (walking, patroling, spotting) on the server (usually as a result of pre-placing units in 3DEN Editor). Those units have a tendency of putting unnecessary strain on the server and bombs player's FPS, which decreases the quality of the mission as a whole.
This module was meant to be used together with 3DEN Triggers, which would allow a mission maker to create garrisons in buildings if some conditions are met (mostly if the player enters an area). This gives the mission maker the ability to automatically spawn units in buildings only when needed, to both make Zeusing easy and keep performance as good as possible.
The way it works is that every building (with exception of some modded buildings) have certain amount of "positions" inside them. Those positions are detected by script and a certain amount of units is spawned in the building.
¶ Step 1 - Setting up the Composition
First you need to setup the squad and vehicle composition (basically units and vehicles that the script will be using). On the right-hand side of the 3DEN Editor do the following:
- Select
Modules (F5) - Find
FUM - Modules - Select
Setup Compositionmodule - Place the module anywhere on the map
After placing the module down, 2 menus will pop up, one for Squad Composition, the other for Vehicle Composition. Select units you want to use for each designated role and do the same for vehicles. Vehicles are side bound.
When you've finished the setup, double click on the module and do the following:
- Give the module a
variable name(variable name is usually found at the top of the attributes menu) - Squad composition, vehicle composition and side are automatically generated based on your selection
- Use custom loadouts (check this if you want to use custom loadouts instead)
- Custom loadouts for SL, Medic, Rifleman, Fireteam Member 1, Fireteam Member 2, Fireteam Member 3.
If you set the SIDE opposite of the unit FACTION, the units will start killing each other.
¶ Step 2 - Spawning the module
On the right-hand side of the 3DEN Editor do the following:
- Select
Modules (F5) - Find
FUM - Modules - Select
Spawn Unitsmodule - Place the module on the desired spot
Position of the module will be used as the origin point.
¶ Step 2 - Setting up the module
Once placed, you can start setting up the module. The module has an Area around it that defines the Spawn Radius, you can change that using size widget in the 3DEN toolbar. Only buildings within the area of the module will be selected.
Once placed, you can start setting up the module. There are 10 settings that you can change:
- Composition Setup Variable Name - here you need to type in the
variable nameof theSetup Compositionmodule - Behaviour type - this determines the type of behaviour units will have in the building
a) Fixed mode - units will stay in their spot
b) Combat mode - units will stay in their spot until the shooter is within 50 meters of them
c) Loose mode - units are spawned in buildings, but will not stay on their spot and will attempt to move back to default formation - Fill - how many total buildings spots will be filled in percentages (from 0 to 100)
Putting random letters or a minus in Building fill will most likely result in script error.
¶ Step 3 - Placing the trigger
Next, to make the module active, you must place down a trigger that will activate it. To do that do the following:
- Select Triggers (F3)
- Select desired trigger
- Place the trigger on the desired spot
¶ Step 4 - Syncing with the trigger
Now you have to Sync, or connect, the FUGU module with the Trigger. To do that do the following:
- Right-click on the FUGU module
- Select "Connect"
- Select "Sync to"
- Left-click on Trigger
If you have multiple FUGU modules, you can select all of them, then right-click one of them and do the procedure above. This will sync all modules with the trigger at the same time.
If FUGU module is synced with multiple triggers, it will select one of those as it's one and only trigger.
FUGU module will not start if you do not sync it with a trigger.
¶ Step 5 - Setting up the trigger
Now you have to set up the trigger for it to activate the FUGU module under certain conditions. To do that open the trigger settings by double clicking it and then do the following:
- Change the Size radius to fit your spawning needs:
A) X-axis radius
B) Y-axis radius
C) Z-axis radius - Set Activation to AnyPlayer - any player will be able to activate the trigger
- Set Activation Type to Present - present, as in, in a particular place, or within the trigger
- Turn on the Server Only - the trigger will be executed on the server
- Leave Condition as it is - the Condition is used to check if certain conditions are met and when they are, the trigger will be activated. The lone
thisrepresents all conditions we have set in the trigger above (Type, Activation, Activation Type)
It is good practice to have the Trigger Size radius be twice as big (even bigger if you plan on spawning vehicles) as the FUGU spawning radius to prevent players from seeing units pop in.
While it is not an error to leave Server Only off, it is usually a good practice to have it on. Leaving it off means that the trigger will be spawned on every client and it will be executed by every client upon completion.
Deleting
thisin Condition will prevent trigger from activating.
¶ Optional Step - Custom Positions
Here we'll go over the process of setting up custom positions. This can be used if a desired building doesn't have any placement positions (can happen in modded buildings). A custom position will be detected with the Spawn Radius, so if the position is within the radius, it will be selected as a possible spawn position.
To create a custom position do the following:
- Select Objects (F1)
- Select Props (Yellow thing)
- Type
Road Crack (Grass, v5)in search bar - Select the given object under
Signs > Graffiti > Road Crack (Grass, v5) - Place it on a desired spot
Example of placing a building spawn point on the roof:
¶ Optional Step - Custom Loadouts
Now we'll go over how to set up Custom loadouts for FUGU module. The way it works is that Custom loadouts completely override any default faction loadouts the units have. To make the loadouts work you must fill all the Custom Loadout - Role fields with exported loadouts.
First, you must make your own loadouts, so spawn 3-6 units that would represent your common squad composition. Edit them in the ACE Arsenal and when you feel like you're done, do the following for each unit:
- Open ACE Arsenal of Role
- Click EXPORT - this should copy the loadout of the unit into your clipboard
- Close ACE Arsenal of Role
- Open FUGU module
- Delete whatever is currently in Custom Loadout - Role, most likely
[] - Paste the exported loadout in Custom Loadout - Role
- Repeat for each role until you fill up all fields
This is what the finished FUGU module should look like:
Example of CSAT spies dressed in NATO gear inside a building:
Any faction can be used.
Units will keep their skins and voices from the used faction, so you can use that to your advantage if you want your units to be from certain ethnic group.
You don't have to specifically fill all Custom Loadout fields with different loadouts, you can put all fields to be the same, if you feel like players won't notice.
If you leave but one of the Custom Loadout fields empty
[], the custom loadouts will not be used.
Do not put anything else in Custom Loadout fields, as that will result in script error.