Holdfast: Nations At War - User contributions [en]

SDK User Guide

2020-10-10T08:31:04Z

Refleax:

Equipping the community with the ability to design, create and bring to life their very own maps, uniforms and flags within the game. The Holdfast SDK is fully integrated with Steamâs Workshop making the content you create easily accessible.

Refer to the Documentation or Video Guides below to get started.

=Documentation=

Covering over 100 pages worth of information, you will surely find a good use for this User Guide as youâre going around the Holdfast SDK. It takes you through the basic steps to get things started, best practices, working with the level editor, uploading to the Steam workshop, optimisations and more.

You can access it by going to the link below.

[https://docs.google.com/document/d/19jWZBKKFET7oRUFs811jOO2CTvSV0bj2MTLHQJiPQTc View The SDK Documentation]

=Video Guides=

Collection of video guides by Harper simplifying the use of the Holdfast SDK.

[https://youtu.be/Pt2kS5A0yN4 Holdfast SDK Tool Tutorial #1 - Getting Started]

[https://youtu.be/5QNb9F2dwhQ Holdfast SDK Tool Tutorial #2 - Ground Texturing]

[https://youtu.be/22VwJCTfDgM Holdfast SDK Tool Tutorial #3 - Terrain Forming]

[https://youtu.be/A_IdPLIQOZw Holdfast SDK Tool Tutorial #4 - Placing Objects]

[https://youtu.be/WfoZtP2b8gw Holdfast SDK Tool Tutorial #5 - Spawn Points]

[https://youtu.be/8gTDtxuUyVs Holdfast SDK Tool Tutorial #6 - Siege Setup]

[https://youtu.be/kmNnSFWsMr8 Holdfast SDK Tool Tutorial #7 - Conquest Configuration]

[https://youtu.be/YApYSbK2pFY Holdfast SDK Tool Tutorial #8 - Play Testing]

[https://youtu.be/u1__soQShd0 Holdfast SDK Tool Tutorial #9 - Building & Uploading To Steam]

Video guide by Apex detailing uniform editing for the Holdfast SDK.

[https://www.youtube.com/watch?v=fPzU0I5MQls Holdfast SDK Tool Tutorial #1 - Uniform Guide]

2020-05-29T16:10:06Z

Refleax:

SDK User Guide

2020-05-29T14:57:32Z

Refleax:

2020-05-27T19:16:44Z

Refleax:

2019-07-02T17:09:35Z

Refleax: /* Game Core */

== 0.29 ==

===New Game Features===
* Prussian Grenadiers. Clad in red, white and blue, this one is certainly quite the sight to look at. The Grenadier class available to play as part of the Army based selection of units for the Kingdom of Prussia.
* Canyon makes its way back into the game.

===Quality of Life===
* Player based map rotations. Smaller maps like Canyon, for instance, will only come into play when the player count is not at its peak. While the largest of maps like the Grassy, Snowy or Desert Open Plains variants only rotate when the player count is sufficiently high.
:Â» Input the below commands as global configuration settings to define the minimum number of required players for the low, medium or high population settings.
::- population_low_min_players 30
::- population_medium_min_players 50
::- population_high_min_players 100
:Â» Input the below command per map rotation to define on which population setting a particular map should be played on. Setting all of the below values to false will prevent the map from rotating automatically but administrators can still access and rotate to that map using the mapRotation command.
::- population_verylow_playable true or false
::- population_low_playable true or false
::- population_medium_playable true or false
::- population_high_playable true or false
* Players that have most recently spoken through VoIP will now appear at the top of the list in the Round Players âPâ panel so you can more easily find the person youâre looking for.
* You now have the option to mute specific individuals from chat through the Round Players âPâ panel.
* When in spectate mode, you are now able to directly spectate a specific player of your own choosing as long as they are affiliated with your own faction. You can do this by clicking on the eye icon in the Round Players âPâ panel.

===Bug Fixes===
* Solved various issues with Canyon when played on Conquest.

== 0.28 ==
===New Linebattle Maps===
* Ancient Plains
* Snowy Plains 4
* Snowy Plains 5
:Â» Input the following parameters to play these map on your community server: map_name ancientplains, map_name snowyplainsiv or map_name snowyplainsv

===Combat Changes===
* Solved an issue with changing attack directions while using a musket, pike or a flag. Right or left mouse movements are no longer taken into consideration when changing between up and down stabs.

== 0.27 ==
===A New Map===
* Camp Salamanca.
:Â» Input the following parameter to play this map on your community server: map_name campsalamanca
* Revisited the rotation present on the Army Front official servers based on community feedback.
* Players are now able to switch classes as well as the faction they initially joined on the Melee Arena game mode without disconnecting from the server.

===Combat Changes===
* The mechanic which dictates the damage received by a player when struck by a melee weapon has been redesigned to favour consistency. Strikes will now deal a set amount of damage pending on if they land on the upper or lower body.
* Player to player collisions have been improved to reduce instances of players clipping inside one another while staying up close and personal.
* Introduced a preventive measure to reduce instances where players clip inside one another while aiming downwards with a strike.
* Blocking mechanics have undergone a few adjustments to improve their responsiveness.
* Slightly reduced the pace at which players can feint a strike to further aid with blocking responsiveness.
* Right and left swings from sword strikes no longer collide with the terrain.
* Increased the stun timer that disallows a player to commit to another strike after they get hit to favour blocking.

===Game Balance===
* Reduced the rate of fire of rocket artillery by increasing the time it takes to load a rocket by 2 seconds.
* Reduced the blast radius of the rocket.
* Solved an issue which caused the cannon ballâs hitbox to be larger than that of the model itself.
* Reduced the damage done in an area when a round shot hits the terrain or an object on the world map.

===Game Core===
* Performed a minor game engine upgrade.

===Optimisations===
* Client-side optimisations to improve framerate when a lot of players are on screen.
* Server-side optimisations to reduce data throughput.
* Lobby optimisations to reduce data throughput.

===Bug Fixes===
* Solved an instance which caused the map to randomly switch to the first one in rotation in the middle of the match.
* Solved an issue which caused the playerâs ragdoll when killed by a grape shot to animate incorrectly.
* Solved an error that was sometimes being outputted when playing on Tahir Desert.
* Solved an error that was sometimes being outputted when shooting at a rocket launcher with a firearm.
* Solved an issue on the Melee Arena game mode which caused a team to win rounds repeatedly if no players remain in the opposing team.
* Solved an issue which caused a player to always strike upwards if they rotate to the left and strike.
* Solved a server-side issue related to player movement. (Hotfix)

===Quality Of Life===
* Player name plates when having the âShow Player Namesâ options enabled, will now continue to rotate with the player even if the player dies.
* The âShow Player Namesâ option no longer switches back to its default value after closing the game.
* The âEscapeâ menu no longer appears if you minimise the game while in freeflight or spectate mode.
* Flattened out the terrain on Palisade Arena and removed the poles present on the map.
* Removed the trees present on Watchtower Arena to improve visibility when playing.

==0.26==
===Rocket Artillery===
* Intended for long range bombardments, rockets can be relatively inaccurate. Fear not, however, youâll be able to send rockets flying at a relatively fast pace and one of them is bound to hit your intended target.
:Â» Input the following command in your server configuration file to adjust the rocket launcherâs respawn time: artillery_rocketlauncher_respawn_timer 130
:Â» Launchers can be found on most of the current maps including plains maps intended for organised play.
* A New Class. Rocketeer! Staying true to their history, this class is exclusively reserved to the British Empire. They come equipped with a spyglass, a sword and a pistol. Rocketeers also have priority over the use of rocket launchers followed by cannoneers.
* Cannonball Bounce! Round shot fired from field guns will now bounce off the terrain decimating through enemy lines.
* Carriable Ladders! Carry ladders close to a fortâs wall then raise them up to create additional entry points for the assaulting allied infantryman. Carpenters have priority over the use of ladders.

===Bug Fixes===
* Fixed an issue which caused players aiming a mortar to retain some of their playerâs visuals obstructing the camera.
* Fixed an instance were players would join their previously selected server is they pressed the âEnterâ key while searching for a server or changing their name.
* Attempted fix towards an issue which resulted in the rain sounds cutting off.

===Quality Of Life===
* You are now able to auto move rocket launchers, ladders and cannons by pressing the âNumLockâ key.
* You are now able to separately control artillery related audio sounds through the âArtilleryâ audio slider.

==0.25==
===Game Core===
*Performed a minor game engine upgrade.

===Quality of Life===
* You can now connect to a server by pressing the âEnterâ key.
* Players can now display voice phrases in chat. It will come in especially handy for all those fellows leading regiments during events.
:Â» Enable âShouts In Chatâ from the âGameâ settings to display phrases in chat.

===Bug Fixes===
* Solved an issue with a memory leak occurring on the game server after map load.
* Solved an issue with the Naval Battlefield server crashing after long periods of run time.
* Attempted fix towards an issue with weather sounds cutting off.
* Attempted fix towards an issue that caused the musician tunes to cut off during volley fire.
* Solved an issue with the game hanging on exit.
* Solved an issue with the attacking and defending factions being inverted in the scoreboard.
* Solved an issue with loading the moveable field gun while standing in front of its barrel.
* Solved an issue with the private admin chat introduced during the previous update being restricted to the team the player joins.
* Solved an issue with field guns randomly killing friendly players when friendly_fire is enabled.
* Solved an issue with cannonball kills displaying an incorrect kill distance in the kill feed.
* Solved an issue with spacing in the kill feed user interface.
* Solved various exceptions that occurred on the client during map load.
* Solved various exceptions that occurred on the server.
* Attempted fix towards a recurring error that sometimes occurs on the client when a player carries an item.
* Solved an error that was being outputted on the client related to audio.
* Solved an issue with incorrect audio files being assigned to the weather system. Static sounds no more.
:Â» If the weather sounds are slightly too high in volume, you can adjust them through the gameâs 'Audio/Weather' settings.

==0.24==
===Game Core===
* Project Cleanup. Optimised our development workflow as this contributes towards producing content at a faster pace.
:Â» Removed all unused meshes, textures and terrains to lessen the load on our project and reduce wait times.
:Â» Refactored multiple scripts to make them more accessible to the developers.
:Â» Restructured the entire project for the developers to more easily locate particular items.
* Game Engine Upgrade. A necessary step forward before we could deliver on our promise to further optimise the game as this exposes the team to newer technologies that can be utilised towards this effect.

===Optimisations===
* Character Optimisations. One of the major bottlenecks in performance when a lot of players are on screen have received direct optimisations. Players will experience a better framerate on those massive 150 * Player servers pending that they werenât already previously limited by an older GPU.

===Graphical Additions===
* Time of Day & Weather System. Players can now enjoy a much better-looking dynamic skybox and weather system due to changes we had to undergo while performing the game engine upgrade.
:Â» The volumetric clouds introduced with this new time of day and weather system utilise more GPU resources than the one present in the version before this update.
:Â» If youâd like to trade off looks for performance, simply go to your âVideoâ settings and lower down the âSkybox Qualityâ to âMediumâ or âLowâ.
* Additional commands to better control the time of day and weather system have been included. You can find all the commands detailed below.
:Â» rc nature weather preset <Weather Preset> <Transition Time>
::- Weather Preset: Calm, Calm2, Calm3, Calm4, Fog, Fog2, Fog3, Snowy or Storm
::- Transition Time: 5 - 60
:Â» rc nature time timeOfDay <Time>
::- Time: 0 - 24, 13.5 = 1.30 PM
:Â» rc nature time dynamicTime <Input>
::- Input: true or false
:Â» rc nature time dynamicTimeSpeed <Speed Multiplier>
::- Speed Multiplier: 0.01 - 1

===Quality Of Life===
* Admin Chat Channel. Weâve introduced an admin chat channel that is specifically reserved for discussion amongst those with administrative privileges on a particular server.
* Admin Shortcut Commands. Youâre now also able to more easily access some of the most common administrative tools by typing shortcut commands in the admin chat.
* Administrators can broadcast a message by typing â/bcâ in the admin chat channel followed by their desired message: /bc <message>
* Administrators can switch to a map by typing â/mrâ in the admin chat channel followed by a value according to the rotation set in the server configuration file: /mr <map rotation id>
* Made muting functionality more easily accessible through the Round Players âPâ panel.
* Players are no longer able to hide private messages sent by server administrators by toggling the âBroadcasted Messagesâ user interface settings.
* You can now separately control weather sounds through the âWeatherâ slider under âMaster Volumesâ in the Audio settings.

===Bug Fixes===
* Weâve pushed forward a tentative fix for the sudden latency spikes that players sometimes experience on the Naval Battlefield game mode.
* Fixed a bug where the confirmation text was being incorrectly displayed after a particular administrative action was clicked on in the Round Players âPâ panel.
* Fixed a spelling mistake on one of the spawn points present on Fort Imperial.
* Fixed various issues related to naval vessel destruction.
* Fixed an issue where players could go inside one of the props present on Dutch Canals.
* Fixed an issue with one of the bridges on Dutch Canals not being correctly placed.
* Fixed a bug were one of the mortars on Fort Imperial could sometimes incorrectly collide with an invisible object causing it to explode prematurely.
* Fixed a bug that was causing one of the ammo boxes on Fort Winston to become invisible.
* Fixed a bug were players couldnât spawn as a Cannoneer on the Highlands map.
* Fixed various floating props on Ernest Ridge.
* Fixed an issue with players getting stuck underneath the watchtowers on King George.
* Fixed an issue on the Sacred Arena map which sometimes caused players to spawn behind the mapâs border inside the church.
* Players are no longer able to walk on the metal flag poles present on Fort Arena.
* Fixed an issue with incorrect textures being assigned to the Prussian fife.
* Fixed an issue with players floating when interacting with cannons aboard ships or near the coast.
* Fixed an issue with players floating when interacting with the captainâs wheel on the 2-Gun Schooner.

==0.23==
===Bug Fixes===
* Multiple attempted fixes towards spawning related issues on the Naval Battlefield and Coastal Siege game modes.
* Fixed an issue which caused blood effects not to appear when a player was killed by grapeshot.
* Fixed an instance which caused the player to get stuck with a ramrod in hand if they got hit while ramming a cannon.
* Fixed an instance which caused the player to get stuck with a ramrod in hand if a ship sunk while theyâre ramming a cannon.
* Fixed an issue which caused the swivel guns on the 8-Gun Schooner to retain the cooldown timer that was present pre the introduction of the time-based loading and ramming for artillery pieces.
* Fixed an issue which caused the playerâs user interface to disappear after the match ended on the Melee Arena game mode.
* Fixed an issue which caused the gaussian blur present behind the end of match and spawn menu interfaces not to be visible.
* Attempted fix towards an issue which sometimes causes the player to get stuck in an animation if theyâre killed while moving a field gun.
* Fixed an issue which prevented other players from seeing cannons animating while youâre using them.

===Game Balance===
* Increased the damage of the larger variation of the grapeshot.
* Reduced the drop of the larger variation of the grapeshot.
* Prevented the mortarâs barrel from recoiling after firing as it is already increasingly difficult to line up a shot with this particular artillery piece.
* Slightly increased the speed at which a cannon moves and rotates.
* Reduced the health points of wooden palisades found on various maps so they can be destroyed more quickly.
* Reduced the health points of the chevaux-de-frise props found on various maps so they can be destroyed more quickly.

==0.22==
===New Game Features===
* New Artillery Mechanics! Well trained crews will triumph over others as the new artillery mechanics have been designed from the ground up with team-play at the forefront.
:Â» Move field guns on the field of battle. Assist another player to move the gun at a faster pace.
:Â» Cannoneers are able to carry ammo boxes. Itâs extremely convenient to have this present nearby a field gun to use at a momentâs notice.
:Â» You are now required to hold down your âEâ key to load a shot.
:Â» Guns must now be rammed after a shot is loaded.
:Â» Moveable field guns will recoil back once they are fired. You can no longer automatically push the cannon forward on the field guns to encourage team play.
:Â» You are now required to go through the same process of loading and ramming while operating a stationary artillery piece.
* Artillery Respawn. Moveable field guns will respawn back to their initial spawn location after two minutes. They will also be repairable in a future update.
:Â» Server administrators can configure the time it takes for an artillery to respawn after it gets destroyed by inputting the following command in the server configuration file: ::artillery_fieldgun_respawn_timer 130
* Grapeshot! A new artillery shot that is especially effective against infantry.
* A New Class! Cannoneer. The go-to class for dedicated artillerymen. They have a priority over the operation of field guns and indeed all of the other artillery pieces present in the game.
:Â» Cannoneers also have their own chat channel to communicate in.
* Spyglass Overhaul! You are now able to view players at a much greater distance while looking through the spyglass. This will come in especially useful for ranging targets.
* A New Map! Fort Pierre. Make good use of moveable field guns to open multiple entry points for the assaulting infantrymen by pouring led into the wooden palisades.
:Â» Input the following parameter to play this map on your community server: map_name fortpierre.
* Interaction Indicators. Once a player gets close to an interactable object, they will be presented with an icon marking down its location.
:Â» You can disable these indicators from the game options under all the other user interface settings. Look for Interaction Indicators.
* Dutch Canals. This map has received quite the overhaul with bridges being added to create pathways over canals and additional houses and trees to serve as cover. Weâll be re-visiting other maps to improve their playability in future updates.
* Most of the maps present in the game received various iterations to support moveable artillery. A hefty bunch of work!
* Weâve made sure to include two moveable artillery pieces on every map specifically designed for organised play.
:Â» Youâll also find additional stationary artillery pieces present on some of the maps.

===Quality of Life===
* We implemented a system that ensures the order of classes in the spawn menu remains consistent with the exception of the Training Grounds map were classes from both the Navy, Army and Coastal branches are present.
* Changed the font used for all interaction labels in the game so it becomes more readable and added a slight fade to all of the interaction labels.
* Included additional sounds to all artillery pieces.
* The list of official servers available to join in the âJoin Other Serverâ panel has been updated.
* Changed the colour of the recruitment channel to make it more distinguishable from the rest.

===Game Balance===
* Implemented a system that restricts players from loading specific shots in certain artillery pieces. You are no longer able to load round shot in swivel guns. Instead, they can now be loaded with a smaller iteration of the grapeshot.
* Upon firing an artillery piece, the gunâs barrel will slightly recoil. This is being done to further increase the skill gap.
* Youâll now find more ammo boxes on the 8-Gun Schooner. These contain the smaller version of the grapeshot to load swivel guns with.

===Other Additions===
* Included additional spawns near the barn on Highlands when played on the Army Conquest game mode.
* Change the spawn limits for the Garrison Arena map when played on the Army Conquest game mode.

===Optimisations===
* Solved an instance which was causing a dip in framerate when an explosion was caused.
* Optimised various particle effects in the game.

===Bug Fixes===
* Fixed a bug which caused the sound when pushing a cannon forward not to play.
* Fixed a bug which prevented firearm trajectories from showing when a server administrator set the drawFirearmTrajectories to true.
* Fixed a bug which caused players to get stuck in an animation after using a spyglass.
* Fixed a bug which caused players to get stuck looking through a spyglass forcing them to respawn.
* Fixed a bug with the wheels not animating correctly when a cannon is being pushed forward.
* Fixed a bug which caused the particles produced when a shot from a firearm hits a snowy terrain to be not very visible.
* Fixed a bug which caused players to get stuck behind the rowboat passage on King George.
* Fixed a bug which prevented players from using any weapons while walking on one of the rowboats present on King George.
* Fixed a bug on Fort Sallettes which prevented players from going in certain rooms.

==0.21==
===Game Features===
* A New Map. King George.

===Quality Of Life===
* The official server list found in the âJoin Other Serverâ panel has been updated. If you are unable to see servers in the lobby, you can use this to connect to any of the official servers.
* You will now find a link to the official Holdfast Discord in the gameâs âEscapeâ menu. We wanted to make sure that joining the community on there is more easily accessible.
* Re-designed a section to the top right of the main menu that re-directs players to various places were our community resides.

===Game Balance===
* Capturing all flags in the Army Conquest game mode will no longer end the match.
* Re-positioned the spawn points on Snowy Plains 2 for the Army Battlefield game mode.
* Reduced the time it takes before the Army Battlefield and Army Conquest game modes end in the official Army Front rotation from 25 to 20 minutes.
* Reduced the number of reinforcements on the Army Battlefield game mode to balance everything in accordance with the above-mentioned change.
* Re-visited the rotation of the Plains maps in the Army Front rotation so the maps that can more easily encourage line battle engagements to occur are rotated more frequently.

===Bug Fixes===
* Confirmed fix for a bug which reduced firearm accuracy over long periods of server runtime.

==0.20==
===Core Development===
* Holdfast: NaW's underlying game engine has been updated to the latest stable release. Weâve done this in an effort to improve both server and client-side stability.

===Features===
* A dedicated âRecruitmentâ chat channel that regiments (game clans) can use to advertise their own group has been added into the game.
:Â» Playerâs advertising their regiment in the chat channel will be displayed in a different colour to help distinguish them from the rest gathering greater visibility.
:Â» If you arenât too keen on seeing recruitment messages, weâve also included an option that allows you to disable the channel through the âGameâ options.

===Quality of Life Additions===
* The âRoundâ chat has been renamed to âAllâ chat.
* You will now always find chat channels in the same order irrespective of the class you are playing.

===Bug Fixes===
* Fixed a bug which caused all players to become invisible forcing everyone in the match to re-join the server.

Server Configuration

2019-07-02T10:52:17Z

Refleax: /* Naval */

=Override Commands & Server-Side Modding=

Server administrators are able to create and customise their own roleplay scenarios through various server-side configuration settings. [[Server_Configuration#Override Commands & Server-Side Modding|Override commands]] can be used to create a unique experience that is not limited by the usual confines of [[Holdfast: Nations At War|Holdfast: NaWâs]] original gameplay design. Configure limits for classes, define the allowed spawnable classes per spawn point, select the equipment they spawn with, equip weapons from racks, replenish ammunition, spawn various props, interactable objects and artillery pieces per map rotation and more.

Hereâs how you can make use of override commands and any other related commands that can prove useful to help you get started or create your own scenarios.

== Land ==
===Class Limit Override On Spawn Points===

Spawn override commands provide administrators with the ability to define which classes to spawn on which spawn location and their limitations as well. By using the following override, you can also have classes that are only playable on naval and coastal scenarios be present on army-based game modes.

''Note: This will overwrite (not add to!) the classes available at a spawn point.''

[[File:200 Carpenters vs 200 Rifleman.png|thumb|right|Tahir Desert Army Battlefield 200 Carpenters vs 200 Rifleman ]]

;<code>'''spawn_override <Spawn Point> <[[Server_Configuration_Enums#Class|Class]]> <Class Limit>'''</code>

: '''<Spawn Point>''' correlates to the spawn present in the spawn menu for instance Barricade (A) on Spanish Farm. Values are defined as letters for <Spawn Point> A B C D E F G H etc...

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class being added to the spawn point

: '''<Class Limit>''' An integer value between 1 and 255 - Set the number of players allowed to spawn as the specified class

'''Example'''

These commands will give 1 team 200 of the carpenter class and the other team 200 Riflemen:
<pre>
# Override Commands (This is a comment and will be ignored by the game)
spawn_override A Carpenter 200
spawn_override B Rifleman 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Starting Weapon Override===
Make use of the following override command to define the weapons each and every class for a particular faction spawn with. Due to the introduction of weapon racks that allow players to equip weapons irrespective of their class, a particular class can now spawn with multiple different firearm or melee weapon types.

To use this command for yourself it must be added after !map_rotation start and before !map_rotation end in the following format...

;<code>starting_weapons_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Maximum Firearm Weapons> <Maximum Melee Weapons> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]></code>

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the Class you wish to customize

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class you wish to customize

: '''<Maximum Firearm Weapons>''' An integer value between 0 and 50. The Maximum amount of Firearms that the class can possess through either the starting weapons commands or weapon racks.

: '''<Maximum Melee Weapons>''' An integer value between 0 and 50. The Maximum amount of Melee Weapons that the class can possess through either the starting weapon commands or weapon racks.
:: Bayoneted Muskets count both as a firearm and a melee weapon
:: Allowing unarmed combat with fists also counts as a melee weapon

: '''<[[Server_Configuration_Enums#Weapon|Starting Weapon]]>''' - The weapon(s) that the class will spawn with

For multiple weapons add a space then another '''<[[Server_Configuration_Enums#Weapon|Starting Weapon]]>''':
;<code>starting_weapons_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Maximum Firearm Weapons> <Maximum Melee Weapons> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]></code>

'''Example'''

Give the British grenadiers a rifle and give the French grenadiers a rifle, pike & sabre:
<pre># Override Commands (This is a comment and will be ignored by the game)
starting_weapons_override British Grenadier 4 2 BakerRifle
starting_weapons_override French Grenadier 4 3 BakerRifle Pike Sabre
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Firearm Ammo Override===
Use the following override command to configure firearm ammunition related settings as well as limitations. As the functionality for pickable weapons through weapon racks and ammo boxes exists within the game, through these settings we allow you to configure ammunition related settings for each and every weapon based on the class a firearm is being equipped by.

Input the below commands per map rotation in the server configuration file.

<code>firearm_ammo_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Firearm> <Starting Ammo> <Loaded Ammo In Barrel> <Maximum Carryable Ammo></code>

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the Class you wish to customize

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class you wish to customize

: '''<[[Server_Configuration_Enums#Firearm|Firearm]]>''' The type of firearm that you are customizing

: '''<Starting Ammo>''' An integer between 0 and 255 - The amount of ammunition the firearm will start with

: '''<Loaded Ammo>''' An integer defined as a numerical value between 0 and 255 - How much ammunition is preloaded into the firearm for the weapons
:: Using values of 2 and above will act as temporary increase in clip size until the ammunition is drained and a reload is required.

: '''<Maximum Carryable Ammo>''' An integer between 0 and 255 - The maximum amount of ammunition able to be carried for a firearm.
:: This value can be larger than <Starting Ammo> for game-modes that use the ammo box object

'''Example'''

Give the British light infantry two rounds but none in the barrel and give the French light infantry a musket with one loaded round but none in reserve:
<pre># Override Commands (This is a comment and will be ignored by the game)
firearm_ammo_override British LightInfantry Musket 2 0
firearm_ammo_override French LightInfantry Musket 0 1
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Sapper Buildable Defences Limitations===

Configure limitations per buildable object. With this, you can disable explosives, increase the buildable chair limit and more.

It is important to note this command functions similar to an RC command and it will persist through rounds. This means that if you disable explosives on the first map rotation, they will remain disabled on the map rotations following that unless otherwise enabled once more in a subsequent rotation.

Input the below commands per map rotation in the server configuration file.

<code>sappers_buildlimit <[[Server_Configuration_Enums#Emplacement Type|Emplacement Type]]> <[[Server_Configuration_Enums#Attacking Or Defending|Attacking Or Defending]]> <Emplacement Limit></code>

: '''<[[Server_Configuration_Enums#Emplacement Type|Emplacement Type]]>''' The emplacement you wish to set a limitation on

: '''<[[Server_Configuration_Enums#Attacking Or Defending|Attacking Or Defending]]>''' If the limit should apply for the attacking or defending faction

: '''<Emplacement Limit>''' An integer between 0 and 255 - Set a limit on the allowed buildable emplacements

'''Example'''

Disable the use of explosive barrels for the defending faction:
<pre># Sapper Configuration Commands (This is a comment and will be ignored by the game)
sappers_buildlimit ExplosiveBarrel defending 0
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Sapper Buildable Defences Starting Materials===

Define the starting materials for the attacking and defending factions.

Input the below commands per map rotation in the server configuration file.

<pre>sappers_attacking_starting_materials <Material Limit>
sappers_defending_starting_materials <Material Limit>
</pre>

: '''<Material Limit>''' An integer between 0 and 10000 - Set the materials each faction starts with

'''Example'''

Set the starting limit for the attackers to 50 and the defenders to 200:
<pre># Sapper Configuration Commands (This is a comment and will be ignored by the game)
sappers_attacking_starting_materials 50
sappers_defending_starting_materials 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

== Naval ==
===Class Limit Override On Ships===
By using the following override commands, you can define your own selection of classes to spawn on which ship. It also provides you with the option of allowing players to spawn with army-based classes on ships. IE. If youâre looking at allowing players to spawn with the Line Infantry Class on the 13-Gun Brig-Sloop, you can do just that.

Input the below commands per map rotation in the server configuration file.

<code>ships_spawn_detail_override <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Class Limit></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type of which to override the spawn point of

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class being added to the spawn point

: '''<Class Limit>''' An integer value between 1 and 255

'''Example'''

"Only" allow 200 Riflemen for British and French frigates.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
ships_spawn_detail_override Frigate50gun British Rifleman 200
ships_spawn_detail_override Frigate50gun French Rifleman 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Ship Spawning & Custom Ship Presets===

Make use of the commands below to define the ship types to spawn in a particular map rotation. Through the same command, you can also define the number of ships to spawn, for which faction as well as their paint scheme. It works on both the Naval Battlefield, Naval Assault & Coastal Siege game modes. You must make sure to set âships_presetâ index to 37 per map rotation before using the command below. This preset index doesnât contain any ships so you retain further control over the ships you want to spawn. IE. You can spawn in 1 50-Gun Frigate with a yellow and black color scheme for the British faction while having 3 8-Gun Schooners for the French with a random color variation

Input the below commands per map rotation in the server configuration file.

<code>ships_spawn <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <Amount Of Ships> <[[Server_Configuration_Enums#Faction|Faction]]> <Color></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type to spawn

: '''<Amount Of Ships>''' An integer between 0 and 50 - Amount of ships to spawn

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<Color>''' Color is defined as an integer between 0 and 5

'''Example'''

Spawn 1 British frigate and 10 French rocketboats.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
# Set ship_preset to 37 (doesn't spawn any ships)
ships_preset 37
# Spawn ships
ships_spawn Frigate50gun 1 British 0
ships_spawn Rocketboat 10 French 4
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Health Override For Ships===

Administrators can define health points for each and every naval vessel type within the game. This addition could prove useful for organised events or perhaps even the creation of unique scenarios featuring flagships.

Input the below commands per map rotation in the server configuration file.

<code>ships_health_detail_override <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <[[Server_Configuration_Enums#Faction|Faction]]> <Health Points></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type to spawn

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<Health Points>''' An integer value between 0 and 99999 - Health Points of the ship

'''Example'''

Set British frigate HP to 20000 and French frigate HP to 70 because Britannia rules the waves.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
ships_health_detail_override Frigate50gun British 20000
ships_health_detail_override Frigate50gun French 70
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Ship Spacemode===

Be at the forefront of interplanetary travel! By inserting this command per map rotation, you can enable ships to fly. Press the âSpaceâ key to ascend and the âShiftâ key to descend.

Input the below command per map rotation in the server configuration file.

<code>ships_spacemode <True or False></code>

: '''<True or False>''' True enables ships to fly while false is the default gameplay

'''Example'''

Enable ships to fly.
<pre>
# Fun Commands (This is a comment and will be ignored by the game)
ships_spacemode true
</pre>

==Object Override==
===Weapon Racks===
Weapon Racks are interactable objects that can hold specific amounts of weapons. Players can interact with a weapon rack by holding 'E' to take a weapon from the rack and add it to their character's inventory. Taking a weapon depletes the amount left on the rack allowing for a limited supply of weapons if the server host wishes.

;<code>objects_override WeaponRack <Object Position> <Object Rotation> <[[Server_Configuration_Enums#Weapon|Weapon]]> <Number Of Weapons In Rack></code>

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the Weapon Rack will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the Weapon Rack will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

: '''<[[Server_Configuration_Enums#Weapon|Weapon]]>''' The type of weapon that will be on the weapon rack

: '''<Number Of Weapons In Rack>''' An integer value between 0 and 255 - The number of weapons that can be obtained from the rack before its depleted

'''Example'''

Spawn a weapon rack at position (1 2 3) with rotation (7 8 9) with 4 rifles on it:
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override WeaponRack 1 2 3 7 8 9 BakerRifle 4
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Firearm Ammoboxes===

Customizable Ammobox for role-play and custom events. Through this, players can replenish their ammunition.

<code>objects_override firearmammobox <Object Position> <Object Rotation> <[[Server_Configuration_Enums#Firearm|Firearm]]> <Maximum Interactions Until Depletion> <Ammo Given> <Maximum Interactions Allowed Per Player></code>

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the firearmammobox will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the firearmammobox will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

:'''<[[Server_Configuration_Enums#Firearm|Firearm]]>''' Which Firearm will the ammunition box replenish

:'''<Maximum Interactions Until Depletion>''' An integer value between 0 and 255 - The amount of times players can retrieve ammunition from the box

:'''<Ammo Given>''' An integer value between 0 and 255 - The amount ammunition given to a player on each interaction

:'''<Maximum Interactions Allowed Per Player>''' An integer value between 0 and 255 - The Maximum times a specific player may retrieve ammunition from the box
:: Useful to prevent a player from hogging all the ammo

'''Example'''

Spawn a firearm ammobox at position (1 2 3) with rotation (7 8 9) with 20 total rounds depleted at a rate of 2 rounds per usage.
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override firearmammobox 1 2 3 7 8 9 20 2 1
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Artillery & Other Props===
This command allows server hosts to add a massive assortment of objects such as extra artillery equipment, barricades, target dummies and pianos.

<code>objects_override <[[Server_Configuration_Enums#Spawnable_Objects_Enums|Spawnable Object]]> <Object Position> <Object Rotation></code>

:'''<[[Server_Configuration_Enums#Spawnable_Objects_Enums|Spawnable Object]]>''' Object which to spawn

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the object will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the object will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

'''Example'''

Spawn a chair at position (1 2 3) with rotation (7 8 9).
Spawn a 9 Pounder cannon at position (5 6 7) with rotation (9 11 23).
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override Chair1 1 2 3 7 8 9
objects_override CannonFieldGun9Pdr 5 6 7 9 11 23
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

Server Configuration Enums

2019-06-22T00:11:25Z

Refleax: /* Emplacement Type */

Server Configuration Enums

2019-06-21T20:46:32Z

Refleax: /* Class */

Server Configuration Enums

2019-06-21T20:45:41Z

Refleax: /* Class */

Server Configuration

2019-06-21T17:41:19Z

Refleax: /* Sapper Buildable Defences Limitations */

=Override Commands & Server-Side Modding=

Server administrators are able to create and customise their own roleplay scenarios through various server-side configuration settings. [[Server_Configuration#Override Commands & Server-Side Modding|Override commands]] can be used to create a unique experience that is not limited by the usual confines of [[Holdfast: Nations At War|Holdfast: NaWâs]] original gameplay design. Configure limits for classes, define the allowed spawnable classes per spawn point, select the equipment they spawn with, equip weapons from racks, replenish ammunition, spawn various props, interactable objects and artillery pieces per map rotation and more.

Hereâs how you can make use of override commands and any other related commands that can prove useful to help you get started or create your own scenarios.

== Land ==
===Class Limit Override On Spawn Points===

Spawn override commands provide administrators with the ability to define which classes to spawn on which spawn location and their limitations as well. By using the following override, you can also have classes that are only playable on naval and coastal scenarios be present on army-based game modes.

''Note: This will overwrite (not add to!) the classes available at a spawn point.''

[[File:200 Carpenters vs 200 Rifleman.png|thumb|right|Tahir Desert Army Battlefield 200 Carpenters vs 200 Rifleman ]]

;<code>'''spawn_override <Spawn Point> <[[Server_Configuration_Enums#Class|Class]]> <Class Limit>'''</code>

: '''<Spawn Point>''' correlates to the spawn present in the spawn menu for instance Barricade (A) on Spanish Farm. Values are defined as letters for <Spawn Point> A B C D E F G H etc...

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class being added to the spawn point

: '''<Class Limit>''' An integer value between 1 and 255 - Set the number of players allowed to spawn as the specified class

'''Example'''

These commands will give 1 team 200 of the carpenter class and the other team 200 Riflemen:
<pre>
# Override Commands (This is a comment and will be ignored by the game)
spawn_override A Carpenter 200
spawn_override B Rifleman 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Starting Weapon Override===
Make use of the following override command to define the weapons each and every class for a particular faction spawn with. Due to the introduction of weapon racks that allow players to equip weapons irrespective of their class, a particular class can now spawn with multiple different firearm or melee weapon types.

To use this command for yourself it must be added after !map_rotation start and before !map_rotation end in the following format...

;<code>starting_weapons_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Maximum Firearm Weapons> <Maximum Melee Weapons> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]></code>

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the Class you wish to customize

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class you wish to customize

: '''<Maximum Firearm Weapons>''' An integer value between 0 and 50. The Maximum amount of Firearms that the class can possess through either the starting weapons commands or weapon racks.

: '''<Maximum Melee Weapons>''' An integer value between 0 and 50. The Maximum amount of Melee Weapons that the class can possess through either the starting weapon commands or weapon racks.
:: Bayoneted Muskets count both as a firearm and a melee weapon
:: Allowing unarmed combat with fists also counts as a melee weapon

: '''<[[Server_Configuration_Enums#Weapon|Starting Weapon]]>''' - The weapon(s) that the class will spawn with

For multiple weapons add a space then another '''<[[Server_Configuration_Enums#Weapon|Starting Weapon]]>''':
;<code>starting_weapons_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Maximum Firearm Weapons> <Maximum Melee Weapons> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]></code>

'''Example'''

Give the British grenadiers a rifle and give the French grenadiers a rifle, pike & sabre:
<pre># Override Commands (This is a comment and will be ignored by the game)
starting_weapons_override British Grenadier 4 2 BakerRifle
starting_weapons_override French Grenadier 4 3 BakerRifle Pike Sabre
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Firearm Ammo Override===
Use the following override command to configure firearm ammunition related settings as well as limitations. As the functionality for pickable weapons through weapon racks and ammo boxes exists within the game, through these settings we allow you to configure ammunition related settings for each and every weapon based on the class a firearm is being equipped by.

Input the below commands per map rotation in the server configuration file.

<code>firearm_ammo_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Firearm> <Starting Ammo> <Loaded Ammo In Barrel> <Maximum Carryable Ammo></code>

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the Class you wish to customize

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class you wish to customize

: '''<[[Server_Configuration_Enums#Firearm|Firearm]]>''' The type of firearm that you are customizing

: '''<Starting Ammo>''' An integer between 0 and 255 - The amount of ammunition the firearm will start with

: '''<Loaded Ammo>''' An integer defined as a numerical value between 0 and 255 - How much ammunition is preloaded into the firearm for the weapons
:: Using values of 2 and above will act as temporary increase in clip size until the ammunition is drained and a reload is required.

: '''<Maximum Carryable Ammo>''' An integer between 0 and 255 - The maximum amount of ammunition able to be carried for a firearm.
:: This value can be larger than <Starting Ammo> for game-modes that use the ammo box object

'''Example'''

Give the British light infantry two rounds but none in the barrel and give the French light infantry a musket with one loaded round but none in reserve:
<pre># Override Commands (This is a comment and will be ignored by the game)
firearm_ammo_override British LightInfantry Musket 2 0
firearm_ammo_override French LightInfantry Musket 0 1
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Sapper Buildable Defences Limitations===

Configure limitations per buildable object. With this, you can disable explosives, increase the buildable chair limit and more.

It is important to note this command functions similar to an RC command and it will persist through rounds. This means that if you disable explosives on the first map rotation, they will remain disabled on the map rotations following that unless otherwise enabled once more in a subsequent rotation.

Input the below commands per map rotation in the server configuration file.

<code>sappers_buildlimit <[[Server_Configuration_Enums#Emplacement Type|Emplacement Type]]> <[[Server_Configuration_Enums#Attacking Or Defending|Attacking Or Defending]]> <Emplacement Limit></code>

: '''<[[Server_Configuration_Enums#Emplacement Type|Emplacement Type]]>''' The emplacement you wish to set a limitation on

: '''<[[Server_Configuration_Enums#Attacking Or Defending|Attacking Or Defending]]>''' If the limit should apply for the attacking or defending faction

: '''<Emplacement Limit>''' An integer between 0 and 255 - Set a limit on the allowed buildable emplacements

'''Example'''

Disable the use of explosive barrels for the defending faction:
<pre># Sapper Configuration Commands (This is a comment and will be ignored by the game)
sappers_buildlimit ExplosiveBarrel defending 0
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Sapper Buildable Defences Starting Materials===

Define the starting materials for the attacking and defending factions.

Input the below commands per map rotation in the server configuration file.

<pre>sappers_attacking_starting_materials <Material Limit>
sappers_defending_starting_materials <Material Limit>
</pre>

: '''<Material Limit>''' An integer between 0 and 10000 - Set the materials each faction starts with

'''Example'''

Set the starting limit for the attackers to 50 and the defenders to 200:
<pre># Sapper Configuration Commands (This is a comment and will be ignored by the game)
sappers_attacking_starting_materials 50
sappers_defending_starting_materials 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

== Naval ==
===Class Limit Override On Ships===
By using the following override commands, you can define your own selection of classes to spawn on which ship. It also provides you with the option of allowing players to spawn with army-based classes on ships. IE. If youâre looking at allowing players to spawn with the Line Infantry Class on the 13-Gun Brig-Sloop, you can do just that.

Input the below commands per map rotation in the server configuration file.

<code>ships_spawn_detail_override <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Class Limit></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type of which to override the spawn point of

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class being added to the spawn point

: '''<Class Limit>''' An integer value between 1 and 255

'''Example'''

"Only" allow 200 Riflemen for British and French frigates.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
ships_spawn_detail_override Frigate50gun British Rifleman 200
ships_spawn_detail_override Frigate50gun French Rifleman 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Ship Spawning & Custom Ship Presets===

Make use of the commands below to define the ship types to spawn in a particular map rotation. Through the same command, you can also define the number of ships to spawn, for which faction as well as their paint scheme. It works on both the Naval Battlefield, Naval Assault & Coastal Siege game modes. You must make sure to set âships_presetâ index to 37 per map rotation before using the command below. This preset index doesnât contain any ships so you retain further control over the ships you want to spawn. IE. You can spawn in 1 50-Gun Frigate with a yellow and black color scheme for the British faction while having 3 8-Gun Schooners for the French with a random color variation

Input the below commands per map rotation in the server configuration file.

<code>ships_spawn <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <Amount Of Ships> <[[Server_Configuration_Enums#Faction|Faction]]> <Color></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type to spawn

: '''<Amount Of Ships>''' An integer between 0 and 50 - Amount of ships to spawn

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<Color>''' Color is defined as an integer between 0 and 5

'''Example'''

Spawn 1 British frigate and 10 French rocketboats.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
# Set ship_preset to 37 (doesn't spawn any ships)
ships_preset 37
# Spawn ships
ships_spawn Frigate50gun 1 British 0
ships_spawn Rocketboat 10 French 4
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Health Override For Ships===

Administrators can define health points for each and every naval vessel type within the game. This addition could prove useful for organised events or perhaps even the creation of unique scenarios featuring flagships.

Input the below commands per map rotation in the server configuration file.

<code>ships_health_detail_override <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <[[Server_Configuration_Enums#Faction|Faction]]> <Health Points></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type to spawn

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<Health Points>''' An integer value between 0 and 99999 - Health Points of the ship

'''Example'''

Set British frigate HP to 20000 and French frigate HP to 69 because Britannia rules the waves.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
ships_health_detail_override Frigate50gun British 20000
ships_health_detail_override Frigate50gun French 69
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

==Object Override==
===Weapon Racks===
Weapon Racks are interactable objects that can hold specific amounts of weapons. Players can interact with a weapon rack by holding 'E' to take a weapon from the rack and add it to their character's inventory. Taking a weapon depletes the amount left on the rack allowing for a limited supply of weapons if the server host wishes.

;<code>objects_override WeaponRack <Object Position> <Object Rotation> <[[Server_Configuration_Enums#Weapon|Weapon]]> <Number Of Weapons In Rack></code>

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the Weapon Rack will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the Weapon Rack will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

: '''<[[Server_Configuration_Enums#Weapon|Weapon]]>''' The type of weapon that will be on the weapon rack

: '''<Number Of Weapons In Rack>''' An integer value between 0 and 255 - The number of weapons that can be obtained from the rack before its depleted

'''Example'''

Spawn a weapon rack at position (1 2 3) with rotation (7 8 9) with 4 rifles on it:
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override WeaponRack 1 2 3 7 8 9 BakerRifle 4
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Firearm Ammoboxes===

Customizable Ammobox for role-play and custom events. Through this, players can replenish their ammunition.

<code>objects_override firearmammobox <Object Position> <Object Rotation> <[[Server_Configuration_Enums#Firearm|Firearm]]> <Maximum Interactions Until Depletion> <Ammo Given> <Maximum Interactions Allowed Per Player></code>

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the firearmammobox will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the firearmammobox will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

:'''<[[Server_Configuration_Enums#Firearm|Firearm]]>''' Which Firearm will the ammunition box replenish

:'''<Maximum Interactions Until Depletion>''' An integer value between 0 and 255 - The amount of times players can retrieve ammunition from the box

:'''<Ammo Given>''' An integer value between 0 and 255 - The amount ammunition given to a player on each interaction

:'''<Maximum Interactions Allowed Per Player>''' An integer value between 0 and 255 - The Maximum times a specific player may retrieve ammunition from the box
:: Useful to prevent a player from hogging all the ammo

'''Example'''

Spawn a firearm ammobox at position (1 2 3) with rotation (7 8 9) with 20 total rounds depleted at a rate of 2 rounds per usage.
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override firearmammobox 1 2 3 7 8 9 20 2 1
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Artillery & Other Props===
This command allows server hosts to add a massive assortment of objects such as extra artillery equipment, barricades, target dummies and pianos.

<code>objects_override <[[Server_Configuration_Enums#Spawnable_Objects_Enums|Spawnable Object]]> <Object Position> <Object Rotation></code>

:'''<[[Server_Configuration_Enums#Spawnable_Objects_Enums|Spawnable Object]]>''' Object which to spawn

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the object will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the object will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

'''Example'''

Spawn a chair at position (1 2 3) with rotation (7 8 9).
Spawn a 9 Pounder cannon at position (5 6 7) with rotation (9 11 23).
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override Chair1 1 2 3 7 8 9
objects_override CannonFieldGun9Pdr 5 6 7 9 11 23
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

Server Configuration Enums

2019-06-19T14:36:04Z

Refleax: /* Props */

2019-06-14T16:40:12Z

Refleax:

=Override Commands & Server-Side Modding=

Server administrators are able to create and customise their own roleplay scenarios through various server-side configuration settings. [[Server_Configuration#Override Commands & Server-Side Modding|Override commands]] can be used to create a unique experience that is not limited by the usual confines of [[Holdfast: Nations At War|Holdfast: NaWâs]] original gameplay design. Configure limits for classes, define the allowed spawnable classes per spawn point, select the equipment they spawn with, equip weapons from racks, replenish ammunition, spawn various props, interactable objects and artillery pieces per map rotation and more.

Hereâs how you can make use of override commands and any other related commands that can prove useful to help you get started or create your own scenarios.

== Land ==
===Class Limit Override On Spawn Points===

Spawn override commands provide administrators with the ability to define which classes to spawn on which spawn location and their limitations as well. By using the following override, you can also have classes that are only playable on naval and coastal scenarios be present on army-based game modes.

''Note: This will overwrite (not add to!) the classes available at a spawn point.''

[[File:200 Carpenters vs 200 Rifleman.png|thumb|right|Tahir Desert Army Battlefield 200 Carpenters vs 200 Rifleman ]]

;<code>'''spawn_override <Spawn Point> <[[Server_Configuration_Enums#Class|Class]]> <Class Limit>'''</code>

: '''<Spawn Point>''' correlates to the spawn present in the spawn menu for instance Barricade (A) on Spanish Farm. Values are defined as letters for <Spawn Point> A B C D E F G H etc...

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class being added to the spawn point

: '''<Class Limit>''' An integer value between 1 and 255 - Set the number of players allowed to spawn as the specified class

'''Example'''

These commands will give 1 team 200 of the carpenter class and the other team 200 Riflemen:
<pre>
# Override Commands (This is a comment and will be ignored by the game)
spawn_override A Carpenter 200
spawn_override B Rifleman 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Starting Weapon Override===
Make use of the following override command to define the weapons each and every class for a particular faction spawn with. Due to the introduction of weapon racks that allow players to equip weapons irrespective of their class, a particular class can now spawn with multiple different firearm or melee weapon types.

To use this command for yourself it must be added after !map_rotation start and before !map_rotation end in the following format...

;<code>starting_weapons_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Maximum Firearm Weapons> <Maximum Melee Weapons> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]></code>

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the Class you wish to customize

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class you wish to customize

: '''<Maximum Firearm Weapons>''' An integer value between 0 and 50. The Maximum amount of Firearms that the class can possess through either the starting weapons commands or weapon racks.

: '''<Maximum Melee Weapons>''' An integer value between 0 and 50. The Maximum amount of Melee Weapons that the class can possess through either the starting weapon commands or weapon racks.
:: Bayoneted Muskets count both as a firearm and a melee weapon
:: Allowing unarmed combat with fists also counts as a melee weapon

: '''<[[Server_Configuration_Enums#Weapon|Starting Weapon]]>''' - The weapon(s) that the class will spawn with

For multiple weapons add a space then another '''<[[Server_Configuration_Enums#Weapon|Starting Weapon]]>''':
;<code>starting_weapons_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Maximum Firearm Weapons> <Maximum Melee Weapons> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]> <[[Server_Configuration_Enums#Weapon|Starting Weapon]]></code>

'''Example'''

Give the British grenadiers a rifle and give the French grenadiers a rifle, pike & sabre:
<pre># Override Commands (This is a comment and will be ignored by the game)
starting_weapons_override British Grenadier 4 2 BakerRifle
starting_weapons_override French Grenadier 4 3 BakerRifle Pike Sabre
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Firearm Ammo Override===
Use the following override command to configure firearm ammunition related settings as well as limitations. As the functionality for pickable weapons through weapon racks and ammo boxes exists within the game, through these settings we allow you to configure ammunition related settings for each and every weapon based on the class a firearm is being equipped by.

Input the below commands per map rotation in the server configuration file.

<code>firearm_ammo_override <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Firearm> <Starting Ammo> <Loaded Ammo In Barrel> <Maximum Carryable Ammo></code>

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the Class you wish to customize

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class you wish to customize

: '''<[[Server_Configuration_Enums#Firearm|Firearm]]>''' The type of firearm that you are customizing

: '''<Starting Ammo>''' An integer between 0 and 255 - The amount of ammunition the firearm will start with

: '''<Loaded Ammo>''' An integer defined as a numerical value between 0 and 255 - How much ammunition is preloaded into the firearm for the weapons
:: Using values of 2 and above will act as temporary increase in clip size until the ammunition is drained and a reload is required.

: '''<Maximum Carryable Ammo>''' An integer between 0 and 255 - The maximum amount of ammunition able to be carried for a firearm.
:: This value can be larger than <Starting Ammo> for game-modes that use the ammo box object

'''Example'''

Give the British light infantry two rounds but none in the barrel and give the French light infantry a musket with one loaded round but none in reserve:
<pre># Override Commands (This is a comment and will be ignored by the game)
firearm_ammo_override British LightInfantry Musket 2 0
firearm_ammo_override French LightInfantry Musket 0 1
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Sapper Buildable Defences Limitations===

Configure limitations per buildable object. With this, you can disable explosives, increase the buildable chair limit and more.

Input the below commands per map rotation in the server configuration file.

<code>sapper_buildlimit <[[Server_Configuration_Enums#Emplacement Type|Emplacement Type]]> <[[Server_Configuration_Enums#Attacking Or Defending|Attacking Or Defending]]> <Emplacement Limit></code>

: '''<[[Server_Configuration_Enums#Emplacement Type|Emplacement Type]]>''' The emplacement you wish to set a limitation on

: '''<[[Server_Configuration_Enums#Attacking Or Defending|Attacking Or Defending]]>''' If the limit should apply for the attacking or defending faction

: '''<Emplacement Limit>''' An integer between 0 and 255 - Set a limit on the allowed buildable emplacements

'''Example'''

Disable the use of explosive barrels for the defending faction:
<pre># Sapper Configuration Commands (This is a comment and will be ignored by the game)
sapper_buildlimit ExplosiveBarrel defending 0
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Sapper Buildable Defences Starting Materials===

Define the starting materials for the attacking and defending factions.

Input the below commands per map rotation in the server configuration file.

<pre>sappers_attacking_starting_materials <Material Limit>
sappers_defending_starting_materials <Material Limit>
</pre>

: '''<Material Limit>''' An integer between 0 and 10000 - Set the materials each faction starts with

'''Example'''

Set the starting limit for the attackers to 50 and the defenders to 200:
<pre># Sapper Configuration Commands (This is a comment and will be ignored by the game)
sappers_attacking_starting_materials 50
sappers_defending_starting_materials 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

== Naval ==
===Class Limit Override On Ships===
By using the following override commands, you can define your own selection of classes to spawn on which ship. It also provides you with the option of allowing players to spawn with army-based classes on ships. IE. If youâre looking at allowing players to spawn with the Line Infantry Class on the 13-Gun Brig-Sloop, you can do just that.

Input the below commands per map rotation in the server configuration file.

<code>ships_spawn_detail_override <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <[[Server_Configuration_Enums#Faction|Faction]]> <[[Server_Configuration_Enums#Class|Class]]> <Class Limit></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type of which to override the spawn point of

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<[[Server_Configuration_Enums#Class|Class]]>''' The name of the class being added to the spawn point

: '''<Class Limit>''' An integer value between 1 and 255

'''Example'''

"Only" allow 200 Riflemen for British and French frigates.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
ships_spawn_detail_override Frigate50gun British Rifleman 200
ships_spawn_detail_override Frigate50gun French Rifleman 200
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Ship Spawning & Custom Ship Presets===

Make use of the commands below to define the ship types to spawn in a particular map rotation. Through the same command, you can also define the number of ships to spawn, for which faction as well as their paint scheme. It works on both the Naval Battlefield, Naval Assault & Coastal Siege game modes. You must make sure to set âships_presetâ index to 37 per map rotation before using the command below. This preset index doesnât contain any ships so you retain further control over the ships you want to spawn. IE. You can spawn in 1 50-Gun Frigate with a yellow and black color scheme for the British faction while having 3 8-Gun Schooners for the French with a random color variation

Input the below commands per map rotation in the server configuration file.

<code>ships_spawn <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <Amount Of Ships> <[[Server_Configuration_Enums#Faction|Faction]]> <Color></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type to spawn

: '''<Amount Of Ships>''' An integer between 0 and 50 - Amount of ships to spawn

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<Color>''' Color is defined as an integer between 0 and 5

'''Example'''

Spawn 1 British frigate and 10 French rocketboats.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
# Set ship_preset to 37 (doesn't spawn any ships)
ships_preset 37
# Spawn ships
ships_spawn Frigate50gun 1 British 0
ships_spawn Rocketboat 10 French 4
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Health Override For Ships===

Administrators can define health points for each and every naval vessel type within the game. This addition could prove useful for organised events or perhaps even the creation of unique scenarios featuring flagships.

Input the below commands per map rotation in the server configuration file.

<code>ships_health_detail_override <[[Server_Configuration_Enums#Ship Type|Ship Type]]> <[[Server_Configuration_Enums#Faction|Faction]]> <Health Points></code>

: '''<[[Server_Configuration_Enums#Ship Type|Ship Type]]>''' Ship type to spawn

: '''<[[Server_Configuration_Enums#Faction|Faction]]>''' The Faction of the ship

: '''<Health Points>''' An integer value between 0 and 99999 - Health Points of the ship

'''Example'''

Set British frigate HP to 20000 and French frigate HP to 69 because Britannia rules the waves.
<pre>
# Override Commands (This is a comment and will be ignored by the game)
ships_health_detail_override Frigate50gun British 20000
ships_health_detail_override Frigate50gun French 69
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

==Object Override==
===Weapon Racks===
Weapon Racks are interactable objects that can hold specific amounts of weapons. Players can interact with a weapon rack by holding 'E' to take a weapon from the rack and add it to their character's inventory. Taking a weapon depletes the amount left on the rack allowing for a limited supply of weapons if the server host wishes.

;<code>objects_override WeaponRack <Object Position> <Object Rotation> <[[Server_Configuration_Enums#Weapon|Weapon]]> <Number Of Weapons In Rack></code>

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the Weapon Rack will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the Weapon Rack will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

: '''<[[Server_Configuration_Enums#Weapon|Weapon]]>''' The type of weapon that will be on the weapon rack

: '''<Number Of Weapons In Rack>''' An integer value between 0 and 255 - The number of weapons that can be obtained from the rack before its depleted

'''Example'''

Spawn a weapon rack at position (1 2 3) with rotation (7 8 9) with 4 rifles on it:
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override WeaponRack 1 2 3 7 8 9 BakerRifle 4
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Firearm Ammoboxes===

Customizable Ammobox for role-play and custom events. Through this, players can replenish their ammunition.

<code>objects_override firearmammobox <Object Position> <Object Rotation> <[[Server_Configuration_Enums#Firearm|Firearm]]> <Maximum Interactions Until Depletion> <Ammo Given> <Maximum Interactions Allowed Per Player></code>

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the firearmammobox will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the firearmammobox will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

:'''<[[Server_Configuration_Enums#Firearm|Firearm]]>''' Which Firearm will the ammunition box replenish

:'''<Maximum Interactions Until Depletion>''' An integer value between 0 and 255 - The amount of times players can retrieve ammunition from the box

:'''<Ammo Given>''' An integer value between 0 and 255 - The amount ammunition given to a player on each interaction

:'''<Maximum Interactions Allowed Per Player>''' An integer value between 0 and 255 - The Maximum times a specific player may retrieve ammunition from the box
:: Useful to prevent a player from hogging all the ammo

'''Example'''

Spawn a firearm ammobox at position (1 2 3) with rotation (7 8 9) with 20 total rounds depleted at a rate of 2 rounds per usage.
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override firearmammobox 1 2 3 7 8 9 20 2 1
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.

===Artillery and Other Props===
This command allows server hosts to add a massive assortment of objects such as extra artillery equipment, barricades, and pianos.

<code>objects_override <[[Server_Configuration_Enums#Spawnable_Objects_Enums|Spawnable Object]]> <Object Position> <Object Rotation></code>

:'''<[[Server_Configuration_Enums#Spawnable_Objects_Enums|Spawnable Object]]>''' Object which to spawn

:'''<Object Position>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The location of where the object will be spawned onto the map using x, y, and z coordinates
:: Enter <code>get playerPosition</code> into the [[Console|console]] ingame to display your character's position.

:'''<Object Rotation>''' A set of float values in the format x y z = 0.0 0.0 0.0 - The orientation that the object will be rotated when spawned onto the map
:: Enter <code>get playerRotation</code> into the [[Console|console]] ingame to display your character's rotation.

'''Example'''

Spawn a chair at position (1 2 3) with rotation (7 8 9).
Spawn a 9 Pounder cannon at position (5 6 7) with rotation (9 11 23).
<pre># Override Commands (This is a comment and will be ignored by the game)
objects_override Chair1 1 2 3 7 8 9
objects_override CannonFieldGun9Pdr 5 6 7 9 11 23
</pre>

To use this command, it must be added after <code>!map_rotation start</code> and before <code>!map_rotation end</code>.