# Mission and quest scripting

*Shard of mgsv-modding-pack — generated 2026-08-11. 247 files. Provenance is on every entry as `source:path`.*

How missions, side ops and quests are declared, sequenced and registered.

## TppMissionLibs — mission script libraries

<https://github.com/kapuragu/TppMissionLibs>

### `missionlibs:README.md`

#### TppMissionLibs
 A sorted library of common reusable files for Metal Gear Solid V: The Phantom Pain custom mission creators.

## SOC — mission scripting toolchain

<https://github.com/morbidslinky/SOC>

### `soc:README.md`

#### SOC - SideOp Companion
##### Available For Download at [NexusMods](https://www.nexusmods.com/metalgearsolidvtpp/mods/571) and [GitHub](https://github.com/morbidslinky/SOC/releases)!

**SideOp Companion** is a [.NET 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0/runtime) UI tool, designed to help automate the process of creating custom sideops for Metal Gear Solid V: The Phantom Pain with the goal of improving their accessibility to users with little-to-no background in modding.

##### How-To Guides and Documentation have been moved to [the Wiki](https://github.com/morbidslinky/SOC/wiki)!

![Setup Menu](https://staticdelivery.nexusmods.com/mods/1091/images/571/571-1751712311-1505912002.png)
![Details Menu](https://staticdelivery.nexusmods.com/mods/1091/images/571/571-1751712324-1323580419.png)
![Scripting Menu](https://staticdelivery.nexusmods.com/mods/1091/images/571/571-1751712336-2123589958.png)
![In-Game Screenshot](https://staticdelivery.nexusmods.com/mods/1091/images/571/571-1751712296-1938435557.jpg)

### `soc:SOC/Core/Classes/Common/Coordinates.cs`
<!-- api only -->

```csharp
public class Coordinates
public string ToFox2String()
public string xCoord
public string yCoord
public string zCoord
```

### `soc:SOC/Core/Classes/Common/LoadAreas.cs`
<!-- api only -->

```csharp
public static string[] afgh
public static string[] mafr
public static string[] mtbs
public static bool isAfgh(int locId)
public static bool isMafr(int locId)
public static bool isMtbs(int locId)
```

### `soc:SOC/Core/Classes/Common/NPCBodyInfo.cs`
<!-- api only -->

```csharp
public static class NPCBodyInfo
public static string[] mafrSubTypes
public static string[] afghSubTypes
public static string[] mtbsSubTypes
public static string[] GetRegionSubTypes(int locId)
public static string[] mafrBodies
public static string[] afghBodies
public static string[] mtbsBodies
public static string[] GetRegionBodies(int locId)
public static BodyInfoEntry[] BodyInfoArray
public static BodyInfoEntry GetBodyInfo(string bodyName)
public struct BodyInfoEntry
public string Name
public LuaTableIdentifier gameId
public string partsPath
public string missionPackPath
public bool isFemale
public bool hasface
```

### `soc:SOC/Core/Classes/Common/NPCMtbsInfo.cs`
<!-- api only -->

```csharp
public static class NPCMtbsInfo
public static string[] skills
public static string[] Staff_Type_ID
```

### `soc:SOC/Core/Classes/Common/Quest.cs`
<!-- api only -->

```csharp
public class Quest
public string Version
public SetupDetails SetupDetails
public ObjectsDetails ObjectsDetails
public ScriptDetails ScriptDetails
public static Quest Create()
public static Type[] GetAllDetailTypes()
public bool Save(string fileName)
public bool Load(string fileName)
public static Version GetSOCVersion()
public void RefreshAllStubTexts()
public ChoiceKeyValuesList GetAllObjectsScriptValueSets()
internal void ClearAllObjectsScriptValueSets()
public LocationalDataStub[] GetLocationalStubs()
internal void DisableObjectTypeStub(Type objectType, string reason)
internal void EnableObjectTypeStub(Type objectType)
```

### `soc:SOC/Core/Classes/Common/Rotation.cs`
<!-- api only -->

```csharp
public class Rotation
public void SetRotation(string roty)
public void SetRotation(string x, string y, string z, string w)
public string GetDegreeRotY()
public string GetRadianRotY()
public string ToFox2String()
public string xRot
public string yRot
public string zRot
public string wRot
```

### `soc:SOC/Core/Classes/Common/ScriptDetails.cs`
<!-- api only -->

```csharp
public class ScriptDetails
public List<Script> QStep_Main
public List<LuaTableEntry> VariableDeclarations
public ChoiceKeyValuesList QuestKeyValueSetsCache
public void WriteToXml(string filePath)
public static ScriptDetails LoadFromXml(string filePath)
```

### `soc:SOC/Core/Classes/Common/SetupDetails.cs`
<!-- api only -->

```csharp
public class SetupDetails
public string QuestTitle
public string QuestDesc
public string FpkName
public string QuestNum
public int locationID
public string loadArea
public Coordinates coords
public string radius
public string category
public string CPName
public string reward
public string progressLangID
public string routeName
public List<string> fileRoutes
public void addToAssets(CommonAssetsBuilder assetsBuilder)
internal void GetScriptChoosableValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/BoxShape.cs`
<!-- api only -->

```csharp
public void SetParameter(Fox2EntityClass c)
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/DataSet.cs`
<!-- api only -->

```csharp
public class DataSet
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/GameObject.cs`
<!-- api only -->

```csharp
public void SetParameter(Fox2EntityClass c)
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/GameObjectLocator.cs`
<!-- api only -->

```csharp
public void SetTransform(Fox2EntityClass _transform)
public void SetParameter(Fox2EntityClass _parameters)
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/GeoModuleCondition.cs`
<!-- api only -->

```csharp
public void SetTransform(Fox2EntityClass t)
public void SetcheckCallback(Fox2EntityClass c)
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/GeoTrap.cs`
<!-- api only -->

```csharp
public void SetTransform(Fox2EntityClass t)
public void SetConditional(Fox2EntityClass c)
public void AddShape(Fox2EntityClass s)
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/ScriptBlockScript.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/SphereShape.cs`
<!-- api only -->

```csharp
public void SetParameter(Fox2EntityClass c)
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/StaticModel.cs`
<!-- api only -->

```csharp
public void SetParameter(Fox2EntityClass c)
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TexturePackLoadConditioner.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppAnimalLocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppAnimalParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppBearLocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppBearParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppHeli2LocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppHostage2LocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppHostage2Parameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppPickableLocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppPlacedLocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppSecurityCamera2LocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppSecurityCamera2Parameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppTrapCheckIsPlayerCallbackDataElement.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppUavLocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppUavParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppVehicle2AttachmentData.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppVehicle2BodyData.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppVehicle2LocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppWalkerGear2LocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppWalkerGear2Parameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppWolfLocatorParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/TppWolfParameter.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/EntityClasses/Transform.cs`
<!-- api only -->

```csharp
public override string GetFox2Format()
public override string GetName()
public override Fox2EntityClass GetOwner()
```

### `soc:SOC/Core/Classes/Fox2/Fox2EntityClass.cs`
<!-- api only -->

```csharp
public abstract class Fox2EntityClass
public void SetAddress(uint _address)
public string GetHexAddress()
public abstract Fox2EntityClass GetOwner()
public abstract string GetFox2Format()
public abstract string GetName()
```

### `soc:SOC/Core/Classes/Fox2/Fox2Info.cs`
<!-- api only -->

```csharp
public static class Fox2Info
public const uint
public static string FoxToolPath
public static void CompileFile(string toolArg, string ToolPath)
public enum entityClass
public class QuestEntity
public string name
public int hexAddress
public entityClass className
public object[] details
public class Vehicle2Body
public string vehicleType
public int TypeIndex
public int ImplTypeIndex
public string partsFileName
public class Vehicle2Attachment
public string attachmentType
public int typeCode
public int instanceCount
public string CnpName
```

### `soc:SOC/Core/Classes/GzsTool/Hashing.cs`
<!-- api only -->

```csharp
public static class Hashing
public static ulong ToStr64(string text)
public static string ToStr32(string text)
public static Dictionary<uint, string>
```

### `soc:SOC/Core/Classes/InfiniteHeaven/Position.cs`
<!-- api only -->

```csharp
public struct Position
public Coordinates coords
public Rotation rotation
public class IHLogPositions
public void ParsePositions(string formattedPositions)
public void SetPositions(List<Position> pos)
public List<Position> GetPositions()
public string GetPositionsFormatted()
```

### `soc:SOC/Core/Classes/LangTool/BigEndianBinaryWriter.cs`
<!-- api only -->

```csharp
public class BigEndianBinaryWriter
public override void Write(float value)
public override void Write(ulong value)
public override void Write(long value)
public override void Write(uint value)
public override void Write(int value)
public override void Write(ushort value)
public override void Write(short value)
public override void Write(decimal value)
public override void Write(double value)
```

### `soc:SOC/Core/Classes/LangTool/ExtensionMethods.cs`
<!-- api only -->

```csharp
internal static class ExtensionMethods
internal static string ReadNullTerminatedString(this BinaryReader reader)
internal static void WriteNullTerminatedString(this BinaryWriter writer, string text)
internal static void AlignWrite(this BinaryWriter writer, int alignment, byte data)
```

### `soc:SOC/Core/Classes/LangTool/LangEntry.cs`
<!-- api only -->

```csharp
public class LangEntry
public uint Key
public string LangId
public int Offset
public short Color
public string Value
public bool ShouldSerializeKey()
public void UpdateKey()
```

### `soc:SOC/Core/Classes/LangTool/LangFile.cs`
<!-- api only -->

```csharp
public class LangFile
public List<LangEntry> Entries
public string Endianess
public void Save(string fileName = "test.xml")
public bool Load(string fileName = "test.xml")
public void Write(Stream outputStream)
```

### `soc:SOC/Core/Classes/Lua/Create.cs`
<!-- api only -->

```csharp
internal static class Create
public static LuaBoolean Boolean<Value>(Value boolean)
public static LuaNumber Number<Value>(Value number)
public static LuaNil Nil()
public static LuaVariable Variable<Value>(string name, Value val)
public static LuaVariable Variable(string name)
public static LuaString String(string text)
public static LuaTemplate Template(string text)
public static LuaTable Table<Entry>(params Entry[] entries)
public static LuaTableIdentifier TableIdentifier<Name
public static LuaValue[] Values<Value>(params Value[] values)
public static LuaFunction Function(string template, LuaValue[] populationValues, params string[] parameters)
public static LuaFunction Function(string template, params LuaValue[] populationValues)
public static LuaFunction Function(string template, params string[] parameters)
public static LuaFunction Function(string template)
public static LuaTableEntry FunctionAsTableEntry(string functionName, string[] functionParameters, string functionBody, bool extrude = false)
public static LuaFunctionCall FunctionCall<NameValue
public static LuaFunctionCall FunctionCall<NameValue>(NameValue name, params LuaValue[] args)
public static LuaTableEntry TableEntry<TableKeyValue
public static LuaTableEntry TableEntry<TableValue>(TableValue val, bool extrude = false)
public static LuaValue GetEntryValueType<TableValue>(TableValue val)
```

### `soc:SOC/Core/Classes/Lua/FunctionBuilder.cs`
<!-- api only -->

```csharp
public class LuaFunctionBuilder
public void AppendParameter(params string[] functionParameters)
public void AppendParameter(params LuaVariable[] functionParameters)
public void AppendPlainText(string plainText)
public void AppendLuaValue(LuaValue luaValue)
public void AppendAssignment(LuaVariable LHS, LuaValue RHS)
public void AppendAssignment(LuaTableIdentifier LHS, LuaValue RHS)
public LuaFunction ToFunction()
public LuaTableEntry ToTableEntry(string functionName, bool extrude = false)
public LuaVariable ToVariable(string functionName)
internal abstract class FunctionToken
internal class FunctionTokenPlainText
public string PlainText
internal class FunctionTokenValue
public LuaValue Value
public bool isAssign
internal class FunctionTokenAssignment
public LuaTableEntry Entry
```

### `soc:SOC/Core/Classes/Lua/LuaBoolean.cs`
<!-- api only -->

```csharp
public class LuaBoolean
public override string TokenValue
```

### `soc:SOC/Core/Classes/Lua/LuaFunction.cs`
<!-- api only -->

```csharp
public class LuaFunction
public LuaVariable[] Parameters
public LuaTemplate Body
public string Template
public LuaValue[] PopulationValues
public override string TokenValue
public string GetLuaFunctionValue()
public void WriteToLua(string filename)
public void WriteToXml(string filePath)
public static LuaFunction LoadFromXml(string filePath)
```

### `soc:SOC/Core/Classes/Lua/LuaFunctionCall.cs`
<!-- api only -->

```csharp
public class LuaFunctionCall
public LuaValue[] Arguments
public override string TokenValue
public TemplateRestrictionType EvaluatesTo
public string GetFunctionCall()
```

### `soc:SOC/Core/Classes/Lua/LuaLexer.cs`
<!-- api only -->

```csharp
internal static string FormatIndentions(string unformattedString)
```

### `soc:SOC/Core/Classes/Lua/LuaNil.cs`
<!-- api only -->

```csharp
public class LuaNil
public override string TokenValue
```

### `soc:SOC/Core/Classes/Lua/LuaNumber.cs`
<!-- api only -->

```csharp
public class LuaNumber
public override string TokenValue
```

### `soc:SOC/Core/Classes/Lua/LuaString.cs`
<!-- api only -->

```csharp
public class LuaString
public override string TokenValue
```

### `soc:SOC/Core/Classes/Lua/LuaTable.cs`
<!-- api only -->

```csharp
public class LuaTable
public List<LuaTableEntry> KeyValuePairs
public void Filter(Predicate<LuaTableEntry> match)
public void PrependOrMove(LuaTableEntry newEntry)
public void Add(params LuaTableEntry[] entries)
public void Add(List<LuaTableEntry> entries)
public void AddOrSet(params LuaTableEntry[] entries)
public bool TrySet(LuaTableEntry entry)
public bool TrySet(LuaValue[] nestedTableKeys, LuaValue value, bool extrude = false)
public bool TryAdd(LuaTableEntry entry)
public bool TryMerge(LuaTable mergeTable)
public bool TryAdd(LuaValue[] nestedTableKeys, LuaValue value, bool extrude = false, int depth = 0)
public bool TryGet(LuaValue key, out LuaValue value, out bool isMarkedForExtrusion)
public bool TryGet(LuaValue[] nestedTableKeys, out LuaValue value, out bool isMarkedForExtrusion)
public List<List<LuaValue>> GetTablePaths(bool distinctPaths = false)
public override string TokenValue
public static bool IsValidLuaIdentifier(string key)
public class LuaTableEntry
public LuaValue Key
public LuaValue Value
public bool ExtrudeForAssignmentVariable
public override string ToString()
```

### `soc:SOC/Core/Classes/Lua/LuaTableIdentifier.cs`
<!-- api only -->

```csharp
public class LuaTableIdentifier
public LuaValue[] IdentifierKeys
public TemplateRestrictionType EvaluatesTo
public override string TokenValue
public string GetIdentifier()
public string GetAssignmentLua(LuaVariable identifierVariable)
public bool TryGetAssignedValue(LuaVariable identifierVariable, out LuaValue value, out bool extrude)
```

### `soc:SOC/Core/Classes/Lua/LuaTemplate.cs`
<!-- api only -->

```csharp
public class LuaTemplate
public string Template
public static string GetTemplateRestrictionTypeString(LuaValue v, bool ifVariableIsAssign = false)
internal static bool TryTokenize(string templateString, out List<LuaTemplateToken> tokenList)
public static bool TryGetPlaceholderTokens(string templateString, out List<LuaTemplatePlaceholder> placeholderTokens)
public string Populate(params LuaValue[] populationData)
public abstract class LuaTemplateToken
public class LuaTemplatePlainText
public string PlainText
public class LuaTemplatePlaceholder
public string PlaceholderString
public int Index
public List<LuaValue.TemplateRestrictionType> AllowedTypes
public bool Equals(LuaTemplatePlaceholder other)
public override bool Equals(object obj)
public override int GetHashCode()
public static bool TryParse(string placeholderToken, out LuaTemplatePlaceholder placeholder)
public string Populate(LuaValue[] luaValues)
internal bool TryGetValueString(LuaValue[] luaValues, out string valueString)
internal bool TryGetCorrespondingLuaValueAtIndex(LuaValue[] luaValues, out LuaValue luaValueAtIndex)
public bool Allows(LuaValue value, out string valueString)
```

### `soc:SOC/Core/Classes/Lua/LuaValue.cs`
<!-- api only -->

```csharp
public abstract class LuaValue
public override string ToString()
public bool Matches(object v)
public enum TemplateRestrictionType
```

### `soc:SOC/Core/Classes/Lua/LuaVariable.cs`
<!-- api only -->

```csharp
public class LuaVariable
public override string TokenValue
public string GetVarName()
public string GetAssignmentLua()
public LuaValue GetAssignedValue()
```

### `soc:SOC/Core/Classes/Lua/StrCode32Table.cs`
<!-- api only -->

```csharp
public class StrCode32Table
public void Add(Script subscript)
public void Add(params Script[] subscripts)
public void Add(List<Script> subscripts)
public void AddCommonDefinitions(params LuaTableEntry[] definitionEntries)
public LuaTable ToStrCode32Table(string definitionTableVariableName)
public LuaTable GetStrCode32DefinitionsTable(string definitionTableVariableName)
public LuaTable GetCommonDefinitionsTable()
public class Script
public StrCode32 CodeEvent
public LuaString Identifier
public string Description
public List<Scriptal> Preconditions
public List<Scriptal> Operations
public List<Script> Subscripts
public ScriptNode ConvertToNodeFamily()
public override string ToString()
public void AddSubscripts(params Script[] subscripts)
public LuaFunction ToFunction(string definitionTableVariableName)
public void WriteToXml(string filePath)
public static Script LoadFromXml(string filePath)
public struct StrCode32
public string CodeKey
public LuaValue Message
public string SenderKey
public LuaValue SenderValue
public static readonly string[] DefaultParameters
public const string
public static LuaVariable[] GetDefaultParametersAsVariables()
public override bool Equals(object obj)
public bool Equals(StrCode32 other)
public LuaString ToLuaString()
public class Scriptal
public string Name
public string Version
public string Category
public string EventFunctionTemplate
public ChoiceKeyValuesList EmbeddedChoosables
public List<Choice> Choices
public List<LuaTableEntry> CommonDefinitions
public string ScriptPrefixID
public static Scriptal AlwaysTrue()
public static Scriptal DoNothing()
public LuaFunction Populate()
public bool TryMapChoicesToCorrespondingRuntimeTokens(out int choicesMinusTokens)
public static Scriptal LoadFromXml(string filePath)
internal void SetRespectiveNode(ScriptalNode scriptalNode)
public class ChoiceKeyValues
public string Key
public List<LuaValue> Values
public void Add(LuaValue value)
public class ChoiceKeyValuesList
public List<ChoiceKeyValues> ChoiceKeyValues
public static ChoiceKeyValuesList LoadFromXml(string filePath)
public List<LuaValue> Get(string key)
public bool Has(string key)
internal string[] Keys()
internal void Add(ChoiceKeyValues KeyValuesSet)
public class Choice
public List<string> ChoosableValueSetsFilter
public bool AllowUIEdit
public bool AllowLiteral
public bool AllowUserVariable
public LuaValue Value
public LuaTemplatePlaceholder CorrespondingRuntimeToken
public VariableNode Dependency
public ScriptalNode ParentScriptalNode
public static readonly Color TYPE_MISMATCH_WARNING_COLOR
public event EventHandler<VariableNodeEventArgs>
public string ToShortString()
public void SetVarNodeDependency(VariableNode dependency)
public bool DependencyNameMatches(LuaTableEntry entry)
public void ClearVarNodeDependency(bool notify = true)
public void HighlightTypeMismatch()
public bool NeedsTypeMismatchWarning()
public static bool HasTypeMismatchWarning(TreeNode scriptTreeNode)
public void RefreshValue()
public bool HasPassthrough(UserControl target)
public class VariableNodeEventArgs
public bool Doomed
```

### `soc:SOC/Core/Classes/QuestBuild/BuildManager.cs`
<!-- api only -->

```csharp
internal static bool Build(params Quest[] quests)
public static void ClearFolders(string buildArchivePath, string fpkName)
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/CommonAssetsBuilder.cs`
<!-- api only -->

```csharp
public class CommonAssetsBuilder
public void Build(string buildDir)
public void CopyAssets(string buildDir, string name)
public static void CopyDirectory(string source, string dest)
public static void CopyFile(string source, string dest)
public void AddFPKAssetPath(string fpkAssetPath)
public void AddFPKDAssetPath(string fpkdAssetPath)
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/DefinitionScriptBuilder.cs`
<!-- api only -->

```csharp
public class DefinitionScriptBuilder
public void AddFpkPathToQuestPackList(string packPath)
public void AddToFaceIdList(params LuaValue[] faceIds)
public void AddToBodyIdList(params LuaValue[] bodyIds)
public void SetRandomFaceListIH(string gender, int count)
public void SetHasEnemyHeli(bool hasEnemyHeli)
public void AddToRequestEquipIds(List<string> ids)
public void Build(string definitionLuaFilePath)
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/Fox2Builder.cs`
<!-- api only -->

```csharp
public class Fox2Builder
public void Build(string fox2FilePath)
public static void SetAddresses(List<Fox2EntityClass> entities, uint baseOffset)
public static List<Fox2EntityClass> BuildQuestEntityList(string fpkName, ObjectsDetails objectsDetails)
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/LangBuilder.cs`
<!-- api only -->

```csharp
public static void WriteQuestLangs(string dir, params SetupDetails[] setupDetails)
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder.cs`
<!-- api only -->

```csharp
public class MainScriptBuilder
public Quest Quest
public OnUpdate OnUpdate
public OnAllocate OnAllocate
public Messages Messages
public OnInitialize OnInitialize
public OnTerminate OnTerminate
public QStep_Start QStep_Start
public QStep_Main QStep_Main
public LuaTable QUEST_TABLE
public LuaTable quest_step
public LuaVariable QStep_Main_MessagesDefVariable
public LuaVariable Quest_MessagesDefVariable
public LuaVariable CommonDefinitionsVariable
public void Build(string mainLuaFilePath)
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder/Messages.cs`
<!-- api only -->

```csharp
public class Messages
public const string
public LuaTableEntry Get()
public LuaTable GetMessagesDefs()
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder/OnAllocate.cs`
<!-- api only -->

```csharp
public class OnAllocate
public LuaFunctionBuilder OnActivate
public LuaFunctionBuilder OnDeactivate
public LuaFunctionBuilder OnOutOfAcitveArea
public LuaFunctionBuilder OnTerminate
public LuaTableEntry Get()
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder/OnInitialize.cs`
<!-- api only -->

```csharp
public class OnInitialize
public LuaFunctionBuilder Function
public LuaTableEntry Get()
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder/OnTerminate.cs`
<!-- api only -->

```csharp
public class OnTerminate
public LuaFunctionBuilder Function
public LuaTableEntry Get()
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder/OnUpdate.cs`
<!-- api only -->

```csharp
public class OnUpdate
public LuaFunctionBuilder Function
public LuaTableEntry Get()
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder/QStep_Main.cs`
<!-- api only -->

```csharp
public class QStep_Main
public StrCode32Table StrCode32Table
public LuaFunctionBuilder OnEnterFunction
public LuaFunctionBuilder OnLeaveFunction
public LuaTableEntry Get(string strCode32TableVariableName)
public static class QStep_Main_TargetMessages
public static readonly Script[] allCommonMessages
public static readonly Script[] genericTargetMessages
public static readonly Script[] dormantItemTargetMessages
public static readonly Script[] activeItemTargetMessages
public static readonly Script[] mechaCaptureTargetMessages
public static readonly Script[] mechaNoCaptureTargetMessages
public static readonly Script[] animalTargetMessages
public static class StaticObjectiveFunctions
public static readonly LuaTableEntry IsTargetSetMessageIdForItem
public static readonly LuaTableEntry TallyItemTargets
public static readonly LuaTableEntry IsTargetSetMessageIdForGenericEnemy
public static readonly LuaTableEntry TallyGenericTargets
public static readonly LuaTableEntry IsTargetSetMessageIdForAnimal
public static readonly LuaTableEntry TallyAnimalTargets
public static readonly LuaTableEntry CheckQuestAllTargetDynamicFunction
```

### `soc:SOC/Core/Classes/QuestBuild/Builders/MainScriptBuilder/QStep_Start.cs`
<!-- api only -->

```csharp
public class QStep_Start
public LuaTable Table
public LuaFunctionBuilder OnEnter
public LuaTableEntry Get()
```

### `soc:SOC/Core/Classes/QuestBuild/UpdateNotifsManager.cs`
<!-- api only -->

```csharp
public static string NotifsListPath
public static LangTool.LangFile notificationLangEntries
public static string[] vanillaLangIds
public static string GetLangId(string value)
public static LangTool.LangEntry GetDefaultLangEntry()
public static string GetDisplayNotification(string langId)
public static string[] GetAllDisplayNotifications()
public static string[] GetAllLangIds()
public static void addNotification(string langId, string value)
public static bool isCustomNotification(string langId)
```

### `soc:SOC/Core/Classes/Route/RouteManager.cs`
<!-- api only -->

```csharp
public static class RouteManager
public static string routeNameDictionaryFile
public static string routeAssetsPath
public static Dictionary<uint, string>
public static string GetRouteFileName(string frtName)
public static List<string> GetRouteFileNameList()
public static List<string> GetRouteNames(string frtName)
```

### `soc:SOC/Core/Forms/FormMain.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
```

### `soc:SOC/Core/Forms/FormMain.cs`
<!-- api only -->

```csharp
public partial class FormMain
```

### `soc:SOC/Core/Forms/Pages/DetailsControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
```

### `soc:SOC/Core/Forms/Pages/DetailsControl.cs`
<!-- api only -->

```csharp
public partial class DetailsControl
public void SyncQuestDataToUserInput()
```

### `soc:SOC/Core/Forms/Pages/EmbeddedScriptControl.Designer.cs`
<!-- api only -->

```csharp
internal System.ComponentModel.IContainer components
protected override void Dispose(bool disposing)
internal void InitializeComponent()
internal System.Windows.Forms.SplitContainer splitContainerOuter
internal System.Windows.Forms.SplitContainer splitContainerInner
internal System.Windows.Forms.GroupBox groupBoxPreconditions
internal System.Windows.Forms.ListBox listBoxPreconditions
internal System.Windows.Forms.GroupBox groupBoxActions
internal System.Windows.Forms.ListBox listBoxOperations
internal System.Windows.Forms.GroupBox groupBoxDescription
internal System.Windows.Forms.TextBox textBoxDescription
internal System.Windows.Forms.GroupBox groupBoxTrigger
internal System.Windows.Forms.Label labelStrCode32
internal System.Windows.Forms.ComboBox comboBoxSenderOptions
internal System.Windows.Forms.ComboBox comboBoxCode
internal System.Windows.Forms.Label labelmsg
internal System.Windows.Forms.ComboBox comboBoxMessage
internal System.Windows.Forms.Label labelSenderOptions
internal System.Windows.Forms.TextBox textBoxSendersLiteralStringValue
internal System.Windows.Forms.ComboBox comboBoxSenders
internal System.Windows.Forms.Label labelSenderValue
internal System.Windows.Forms.TextBox textBoxSendersLiteralNumberValue
```

### `soc:SOC/Core/Forms/Pages/EmbeddedScriptControl.cs`
<!-- api only -->

```csharp
public partial class EmbeddedScriptControl
public const string
public UserControl Menu(ScriptNode scriptNode)
public void PopulateScriptalControls()
public void VariableNodeEventPassthroughFunction(object sender, VariableNodeEventArgs e)
public void MoveScriptal(ScriptalNode node, bool up)
```

### `soc:SOC/Core/Forms/Pages/EmbeddedScriptSetControl.Designer.cs`
<!-- api only -->

```csharp
internal System.ComponentModel.IContainer components
protected override void Dispose(bool disposing)
internal void InitializeComponent()
internal System.Windows.Forms.Button buttonImportVariablesScripts
internal System.Windows.Forms.GroupBox groupBoxScriptSet
internal System.Windows.Forms.Button buttonExportVariablesScripts
internal System.Windows.Forms.CheckedListBox checkedListBoxScripts
internal System.Windows.Forms.TextBox textEmptyHint
internal System.Windows.Forms.CheckBox checkBoxDependencies
internal System.Windows.Forms.GroupBox groupBoxScripts
internal System.Windows.Forms.SplitContainer splitContainerOuter
internal System.Windows.Forms.GroupBox groupBoxVariables
internal System.Windows.Forms.CheckedListBox checkedListBoxVariables
```

### `soc:SOC/Core/Forms/Pages/EmbeddedScriptSetControl.cs`
<!-- api only -->

```csharp
public partial class EmbeddedScriptSetControl
public readonly string ScriptExportDir
internal UserControl Menu()
internal void UpdateMenu()
```

### `soc:SOC/Core/Forms/Pages/EmbeddedScriptalControl.Designer.cs`
<!-- api only -->

```csharp
internal System.ComponentModel.IContainer components
protected override void Dispose(bool disposing)
internal void InitializeComponent()
internal System.Windows.Forms.SplitContainer splitContainerScriptal
internal System.Windows.Forms.GroupBox groupBoxScriptalSelect
internal System.Windows.Forms.GroupBox groupBoxDescription
internal System.Windows.Forms.TextBox textBoxDescription
internal System.Windows.Forms.GroupBox groupBoxChoice
internal System.Windows.Forms.ComboBox comboBoxChoiceSet
internal System.Windows.Forms.ComboBox comboBoxPresetChoosables
internal System.Windows.Forms.Label labelTemplate
internal System.Windows.Forms.Label labelChoice
internal System.Windows.Forms.Label labelChoiceSet
internal System.Windows.Forms.Button buttonApplyTemplate
internal System.Windows.Forms.ListBox listBoxChoices
internal System.Windows.Forms.TextBox textBoxChoiceDescription
internal System.Windows.Forms.SplitContainer splitContainer1
internal System.Windows.Forms.GroupBox groupBoxChoicesList
internal System.Windows.Forms.ComboBox comboBoxUserVarNodes
internal System.Windows.Forms.Panel panelBoolean
internal System.Windows.Forms.RadioButton radioButtonFalse
internal System.Windows.Forms.RadioButton radioButtonTrue
internal System.Windows.Forms.TextBox textBoxLiteralNumberValue
internal System.Windows.Forms.TextBox textBoxLiteralStringValue
internal System.Windows.Forms.ComboBox comboBoxScriptalTemplate
internal System.Windows.Forms.Label label1
internal System.Windows.Forms.ComboBox comboBoxTemplateCategory
```

### `soc:SOC/Core/Forms/Pages/EmbeddedScriptalControl.cs`
<!-- api only -->

```csharp
public partial class EmbeddedScriptalControl
public override string ToString()
internal UserControl Menu(ScriptalNode scriptalNode)
internal void UpdateCategoryFilter()
internal static string str(ScriptalType type)
internal Scriptal[] GetTemplates(ScriptalNode scriptalNode)
internal List<FileInfo> GetScriptalTemplates(ScriptalNode scriptalNode)
internal void UpdateVarNodesUI()
public void VariableNodeEventPassthroughFunction(object sender, VariableNodeEventArgs e)
public void RedrawVariableDependencies()
```

### `soc:SOC/Core/Forms/Pages/LocationalDataStub.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.Panel panelStub
public System.Windows.Forms.Label labelStub
public ScrollPassthroughTextBox textBoxCoords
```

### `soc:SOC/Core/Forms/Pages/LocationalDataStub.cs`
<!-- api only -->

```csharp
public partial class LocationalDataStub
internal void DisableStub(string reason)
internal void EnableStub()
public IHLogPositions GetStubLocations()
public void SetStubText(IHLogPositions positions)
public class ScrollPassthroughTextBox
protected override void WndProc(ref Message m)
```

### `soc:SOC/Core/Forms/Pages/ScriptControl.Designer.cs`
<!-- api only -->

```csharp
internal System.ComponentModel.IContainer components
protected override void Dispose(bool disposing)
internal void InitializeComponent()
internal System.Windows.Forms.GroupBox groupBoxVariables
internal DoubleBufferedTreeView treeViewVariables
internal System.Windows.Forms.GroupBox groupBoxScripts
internal System.Windows.Forms.ComboBox comboBoxVarType
internal System.Windows.Forms.TextBox textBoxVarName
internal System.Windows.Forms.TextBox textBoxVarStringValue
internal System.Windows.Forms.Button buttonNewVariable
internal System.Windows.Forms.Button buttonRemoveVariableIdentifier
internal System.Windows.Forms.Button buttonNewIdentifier
internal System.Windows.Forms.TextBox textBoxVarNumberValue
internal System.Windows.Forms.Panel panelScripting
internal System.Windows.Forms.GroupBox groupBoxScriptDetails
internal DoubleBufferedTreeView treeViewScripts
internal System.Windows.Forms.Button buttonNewScript
internal System.Windows.Forms.Button buttonRemoveScript
internal System.Windows.Forms.TextBox textBoxScriptName
internal System.Windows.Forms.SplitContainer splitContainerOuter
internal System.Windows.Forms.SplitContainer splitContainerInner
internal System.Windows.Forms.Panel panelComponentDetails
internal System.Windows.Forms.Button buttonNewOperation
internal System.Windows.Forms.Button buttonNewPrecondition
internal System.Windows.Forms.SplitContainer splitContainerPreconditionOperation
internal System.Windows.Forms.RadioButton radioButtonTrue
internal System.Windows.Forms.RadioButton radioButtonFalse
internal System.Windows.Forms.Panel panelBoolean
internal System.Windows.Forms.Panel panelPlaceholder
internal System.Windows.Forms.ComboBox comboBoxTableAddOptions
internal System.Windows.Forms.Panel panelNewIdentifier
```

### `soc:SOC/Core/Forms/Pages/ScriptControl.ScriptTree.cs`
<!-- api only -->

```csharp
public partial class ScriptControl
internal void Embed(UserControl control)
internal bool IsEmbedded(UserControl control)
public void UnmarkVariableDependencies()
public void SetMenuText(string _groupBoxScriptDetails, string _textBoxScriptName)
public class ScriptTablesRootNode
public Str32TableNode QStep_Main
public bool IsEmpty()
public class Str32TableNode
public override string ToString()
public ScriptNode Add(Script script)
public void Add(ScriptNode scriptNode)
public void Clear()
public void Expand(CodeNode codeNode)
public string GetUniqueScriptName(string baseName, ScriptNode except = null)
public List<ScriptNode> GetScriptNodes()
public void DeleteScriptNode(ScriptNode selectedScriptNode)
public List<Script> ConvertToScripts()
public void MoveScriptNode(ScriptNode scriptNode, StrCode32 newStrCodeEvent)
public class ScriptNode
public LuaString Identifier
public string Description
public ScriptalParentNode PreconditionsParent
public ScriptalParentNode OperationsParent
public ScriptalNode AddPrecondition(Scriptal scriptal)
public ScriptalNode AddOperation(Scriptal scriptal)
public void UpdateNodeText(LuaString identifier = null)
public void UpdateDescription(string description)
public StrCode32 getEvent()
public Str32TableNode GetStrCode32TableNode()
public List<VariableNode> GetAllDependencies()
public List<Choice> GetAllChoicesContainingDependencies()
public Script ConvertToScript()
public void MarkDependencies()
public MessageSenderNode GetMsgSenderNode()
public CodeNode GetCodeNode()
internal void CheckForDependencyWarnings()
public class ScriptalParentNode
public ScriptalType ScriptalType
public List<Scriptal> GetScriptals()
public ScriptNode GetScriptNode()
public enum ScriptalType
public class ScriptalNode
public Scriptal Scriptal
public void Set(Scriptal scriptal)
public void ClearAllVarNodeDependencies()
public StrCode32 GetEvent()
public ScriptalParentNode GetScriptalParentNode()
public class MessageSenderNode
public LuaValue Message
public string SenderKey
public LuaValue Sender
public static string MessageSenderNodeName(LuaValue message, LuaValue sender)
public Str32TableNode GetTableNode()
public class CodeNode
public string CodeKey
public static string CodeNodeName(string code)
```

### `soc:SOC/Core/Forms/Pages/ScriptControl.VariableTree.cs`
<!-- api only -->

```csharp
public partial class ScriptControl
public void RedrawScriptDependents()
internal string GetUniqueVariableName(string baseName)
internal bool VariableNameExists(string baseName, TreeNodeCollection nodes, TreeNode except = null)
public class VariableNode
public LuaTableEntry Entry
public List<Choice> Dependents
public static VariableNode ExtrapolateDefault(LuaTableIdentifier identifier)
public LuaTableEntry GetEntry()
public LuaTableIdentifier ToLuaTableIdentifier()
public static LuaTableIdentifier ConvertToLuaTableIdentifier(LuaTableEntry entry)
public override string ToString()
public void UpdateText()
public void NotifyDependentsOfVariableNodeChange(bool isDoomed)
internal void MarkDependents()
```

### `soc:SOC/Core/Forms/Pages/ScriptControl.cs`
<!-- api only -->

```csharp
public class DoubleBufferedTreeView
protected override CreateParams CreateParams
public partial class ScriptControl
public Quest Quest
public ScriptTablesRootNode ScriptTablesRootNode
public static ChoiceKeyValuesList StrCode32Classes
internal bool _isUpdatingControls
public static readonly Font REGULAR
public static readonly Font BOLD
public static readonly Font UNDERLINE
public static readonly Font UNDERLINE_BOLD
public const string
public void Add(ScriptDetails incomingScriptDetails)
public void AddDefault()
internal void SyncQuestDataToUserInput()
internal void SyncUserInputToQuestData()
internal void UpdateEmbeddedScriptSetDisplay()
```

### `soc:SOC/Core/Forms/Pages/SetupControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.ComboBox comboBoxCategory
public System.Windows.Forms.TextBox textBoxFPKName
public System.Windows.Forms.TextBox textBoxZCoord
public System.Windows.Forms.TextBox textBoxYCoord
public System.Windows.Forms.TextBox textBoxXCoord
public System.Windows.Forms.ComboBox comboBoxRegion
public System.Windows.Forms.TextBox textBoxQuestNum
public System.Windows.Forms.ComboBox comboBoxRadius
public System.Windows.Forms.ComboBox comboBoxReward
public System.Windows.Forms.ComboBox comboBoxLoadArea
public System.Windows.Forms.ComboBox comboBoxProgressNotifs
public System.Windows.Forms.TextBox textBoxQuestDesc
public System.Windows.Forms.TextBox textBoxQuestTitle
public System.Windows.Forms.ComboBox comboBoxCP
public System.Windows.Forms.ComboBox comboBoxRoute
```

### `soc:SOC/Core/Forms/Pages/SetupControl.cs`
<!-- api only -->

```csharp
public partial class SetupControl
public int locationID
public Quest Quest
public bool IsFilled()
public void SyncUserInputToQuestData()
public void refreshNotifsList()
public void refreshRoutesList()
public void UpdateComboBox(ComboBox box, List<string> itemList)
public static void UpdateComboBox(ComboBox box, string[] itemList)
internal void SyncQuestDataToUserInput(bool saveOnly = false)
```

### `soc:SOC/Core/Forms/Pages/WaitingControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
```

### `soc:SOC/Core/Forms/Pages/WaitingControl.cs`
<!-- api only -->

```csharp
public partial class WaitingControl
```

### `soc:SOC/Core/Forms/QuestObjectBox.cs`
<!-- api only -->

```csharp
public abstract class QuestObjectBox
public abstract QuestObject getQuestObject()
```

### `soc:SOC/Core/Forms/formCustomProgressLang.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
```

### `soc:SOC/Core/Forms/formCustomProgressLang.cs`
<!-- api only -->

```csharp
public partial class formCustomProgressLang
```

### `soc:SOC/QuestObjects/ActiveItem/ActiveItem.cs`
<!-- api only -->

```csharp
public class ActiveItem
public int ID
public bool isTarget
public string activeItem
public Position position
public override int GetID()
public override string GetObjectName()
public override Position GetPosition()
public override void SetPosition(Position pos)
```

### `soc:SOC/QuestObjects/ActiveItem/ActiveItemsDetail.cs`
<!-- api only -->

```csharp
public class ActiveItemsDetail
public ActiveItemsMetadata activeItemMetadata
public List<ActiveItem> activeItems
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/ActiveItem/ActiveItemsMetadata.cs`
<!-- api only -->

```csharp
public class ActiveItemsMetadata
public string objectiveType
```

### `soc:SOC/QuestObjects/ActiveItem/ActiveItemsVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position pos, int index)
```

### `soc:SOC/QuestObjects/ActiveItem/Classes/ActiveItemFox2.cs`
<!-- api only -->

```csharp
public static void AddQuestEntities(ActiveItemsDetail detail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/ActiveItem/Classes/ActiveItemLua.cs`
<!-- api only -->

```csharp
internal static void GetMain(ActiveItemsDetail questDetail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(ActiveItemsDetail detail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/ActiveItem/Classes/ActiveItemNames.cs`
<!-- api only -->

```csharp
public static string[] activeItems
```

### `soc:SOC/QuestObjects/ActiveItem/Forms/ActiveItemBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.CheckBox checkBox_target
public System.Windows.Forms.TextBox textBox_wrot
public System.Windows.Forms.TextBox textBox_zrot
public System.Windows.Forms.TextBox textBox_yrot
public System.Windows.Forms.ComboBox comboBox_activeItem
public System.Windows.Forms.TextBox textBox_xrot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
```

### `soc:SOC/QuestObjects/ActiveItem/Forms/ActiveItemBox.cs`
<!-- api only -->

```csharp
public partial class ActiveItemBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/ActiveItem/Forms/ActiveItemControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
public System.Windows.Forms.ComboBox comboBox_ObjType
```

### `soc:SOC/QuestObjects/ActiveItem/Forms/ActiveItemControl.cs`
<!-- api only -->

```csharp
public partial class ActiveItemControl
internal void SetMetadata(ActiveItemsMetadata meta)
```

### `soc:SOC/QuestObjects/Animal/Animal.cs`
<!-- api only -->

```csharp
public class Animal
public override Position GetPosition()
public override void SetPosition(Position pos)
public override int GetID()
public override string GetObjectName()
public bool isTarget
public int ID
public string count
public string animal
public string typeID
public Position position
```

### `soc:SOC/QuestObjects/Animal/AnimalsDetail.cs`
<!-- api only -->

```csharp
public class AnimalsDetail
public AnimalsMetadata animalMetadata
public List<Animal> animals
public override ObjectsMetadata GetMetadata()
public override List<QuestObject>  GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override void AddToAssets(CommonAssetsBuilder assetsBuilder)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Animal/AnimalsMetadata.cs`
<!-- api only -->

```csharp
public class AnimalsMetadata
public string objectiveType
```

### `soc:SOC/QuestObjects/Animal/AnimalsVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position pos, int index)
```

### `soc:SOC/QuestObjects/Animal/Classes/AnimalAssets.cs`
<!-- api only -->

```csharp
internal static void GetAnimalAssets(AnimalsDetail questDetail, CommonAssetsBuilder fileAssets)
```

### `soc:SOC/QuestObjects/Animal/Classes/AnimalFox2.cs`
<!-- api only -->

```csharp
public static void AddQuestEntities(AnimalsDetail detail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/Animal/Classes/AnimalInfo.cs`
<!-- api only -->

```csharp
public static class AnimalInfo
public static string[] animals
public static string[] AnimalTypes
public static string getAnimalCategory(string animalName)
public static string getAnimalType(string animalName)
public static void getAnimalPaths(string animalName, out string partsPath, out string mog, out string mtar,  out string fv2Path)
```

### `soc:SOC/QuestObjects/Animal/Classes/AnimalLua.cs`
<!-- api only -->

```csharp
public static void GetMain(AnimalsDetail detail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(AnimalsDetail detail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Animal/Forms/AnimalBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.ComboBox comboBox_count
public System.Windows.Forms.ComboBox comboBox_typeID
public System.Windows.Forms.ComboBox comboBox_animal
public System.Windows.Forms.CheckBox checkBox_target
public System.Windows.Forms.TextBox textBox_rot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
```

### `soc:SOC/QuestObjects/Animal/Forms/AnimalBox.cs`
<!-- api only -->

```csharp
public partial class AnimalBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/Animal/Forms/AnimalControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
public System.Windows.Forms.ComboBox comboBox_ObjType
```

### `soc:SOC/QuestObjects/Animal/Forms/AnimalControl.cs`
<!-- api only -->

```csharp
public partial class AnimalControl
internal void SetMetadata(AnimalsMetadata meta)
```

### `soc:SOC/QuestObjects/Camera/Camera.cs`
<!-- api only -->

```csharp
public class Camera
public override Position GetPosition()
public override void SetPosition(Position pos)
public override int GetID()
public override string GetObjectName()
public int ID
public bool isTarget
public bool weapon
public Position position
```

### `soc:SOC/QuestObjects/Camera/CamerasDetail.cs`
<!-- api only -->

```csharp
public class CamerasDetail
public CamerasMetadata cameraMetadata
public List<Camera> cameras
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToAssets(CommonAssetsBuilder assetsBuilder)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Camera/CamerasMetadata.cs`
<!-- api only -->

```csharp
public class CamerasMetadata
public string objectiveType
```

### `soc:SOC/QuestObjects/Camera/CamerasVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position pos, int index)
```

### `soc:SOC/QuestObjects/Camera/Classes/CameraAssets.cs`
<!-- api only -->

```csharp
internal static void GetCameraAssets(CamerasDetail questDetail, CommonAssetsBuilder assetsBuilder)
```

### `soc:SOC/QuestObjects/Camera/Classes/CameraFox2.cs`
<!-- api only -->

```csharp
internal static void AddQuestEntities(CamerasDetail detail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/Camera/Classes/CameraLua.cs`
<!-- api only -->

```csharp
internal static void GetMain(CamerasDetail detail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(CamerasDetail detail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Camera/Forms/CameraBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.CheckBox checkBox_weapon
public System.Windows.Forms.CheckBox checkBox_target
public System.Windows.Forms.TextBox textBox_rot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
```

### `soc:SOC/QuestObjects/Camera/Forms/CameraBox.cs`
<!-- api only -->

```csharp
public partial class CameraBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/Camera/Forms/CameraControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
public System.Windows.Forms.ComboBox comboBox_ObjType
```

### `soc:SOC/QuestObjects/Camera/Forms/CameraControl.cs`
<!-- api only -->

```csharp
public partial class CameraControl
public void SetMetadata(CamerasMetadata meta)
```

### `soc:SOC/QuestObjects/Common/ObjectsDetail.cs`
<!-- api only -->

```csharp
public abstract class ObjectsDetail
public abstract List<QuestObject> GetQuestObjects()
public abstract void SetQuestObjects(List<QuestObject> qObjects)
public abstract ObjectsDetailControlPanel GetControlPanel()
public abstract ObjectsMetadata GetMetadata()
public virtual void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public virtual void AddToDefinitionLua(DefinitionScriptBuilder definitionLua)
public virtual void AddToMainLua(MainScriptBuilder mainLua)
public virtual void AddToAssets(CommonAssetsBuilder assetsBuilder)
public virtual void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Common/ObjectsDetailControlPanel.cs`
<!-- api only -->

```csharp
public abstract class ObjectsDetailControlPanel
public UserControl detailControl
public List<ChoiceKeyValues> ScriptValueSets
public FlowLayoutPanel flowPanel
public void RedrawControl(ObjectsDetail detail)
public void RefreshScriptValueSets(ObjectsDetail detail)
public void ShowDetail()
public void HideDetail()
public abstract void DrawMetadata(ObjectsMetadata meta)
public ObjectsDetail GetDetailFromControl()
public IEnumerable<QuestObject> GetQuestObjectsFromControl()
public abstract ObjectsMetadata GetMetadataFromControl()
public abstract void SetDetailsFromSetup(ObjectsDetail detail, SetupDetails setup)
public abstract QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public abstract ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
```

### `soc:SOC/QuestObjects/Common/ObjectsDetailLocational.cs`
<!-- api only -->

```csharp
public abstract class ObjectsDetailLocational
public LocationalDataStub GetStub()
public void RefreshStub()
```

### `soc:SOC/QuestObjects/Common/ObjectsDetailVisualizerLocational.cs`
<!-- api only -->

```csharp
public abstract class ObjectsDetailControlPanelLocational
public LocationalDataStub detailStub
public void DrawStubText(ObjectsDetail detail)
public override void SetDetailsFromSetup(ObjectsDetail detail, SetupDetails setup)
public abstract QuestObject NewQuestObject(Position pos, int index)
```

### `soc:SOC/QuestObjects/Common/ObjectsDetails.cs`
<!-- api only -->

```csharp
public class ObjectsDetails
public List<ObjectsDetail> Details
```

### `soc:SOC/QuestObjects/Common/ObjectsMetadata.cs`
<!-- api only -->

```csharp
public abstract class ObjectsMetadata
```

### `soc:SOC/QuestObjects/Common/QuestObject.cs`
<!-- api only -->

```csharp
public abstract class QuestObject
public abstract Position GetPosition()
public abstract void SetPosition(Position pos)
public abstract int GetID()
public abstract string GetObjectName()
```

### `soc:SOC/QuestObjects/Enemy/Classes/EnemyAssets.cs`
<!-- api only -->

```csharp
public static string enemyAssetsPath
internal static void GetEnemyAssets(EnemiesDetail questDetail, CommonAssetsBuilder assetsBuilder)
```

### `soc:SOC/QuestObjects/Enemy/Classes/EnemyInfo.cs`
<!-- api only -->

```csharp
public struct CP
public string CPname
public string[] CPsoldiers
public string[] CPsoldierRoutes
public string[] CPheliRoutes
public static class EnemyInfo
public const int
public static string getRegion(CP currentCP)
public static CP GetCP(string CPName)
public static string[] GetCPNames(params CP[] regionCPs)
public static string[] GetQuestSoldierNames(string CPName, int locId)
public static string ChooseDistantCP(string currentCP, int locId)
public static CP MtbsCP
public static CP NoneCP
public static string[] powerSetting
public static CP[] AfghCPs
public static CP[] MafrCPs
public static string[] QuestSoldierNames
```

### `soc:SOC/QuestObjects/Enemy/Classes/EnemyLua.cs`
<!-- api only -->

```csharp
public static void GetDefinition(EnemiesDetail detail, DefinitionScriptBuilder definitionLua)
public static void GetMain(EnemiesDetail detail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(EnemiesDetail detail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Enemy/EnemiesDetail.cs`
<!-- api only -->

```csharp
public class EnemiesDetail
public EnemiesMetadata enemyMetadata
public List<Enemy> enemies
public override ObjectsMetadata GetMetadata()
public override ObjectsDetailControlPanel GetControlPanel()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToDefinitionLua(DefinitionScriptBuilder definitionLua)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValueSets)
public override void AddToAssets(CommonAssetsBuilder assetsBuilder)
```

### `soc:SOC/QuestObjects/Enemy/EnemiesDetailVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override void SetDetailsFromSetup(ObjectsDetail detail, SetupDetails setup)
```

### `soc:SOC/QuestObjects/Enemy/EnemiesMetadata.cs`
<!-- api only -->

```csharp
public class EnemiesMetadata
public string objectiveType
public string subtype
```

### `soc:SOC/QuestObjects/Enemy/Enemy.cs`
<!-- api only -->

```csharp
public class Enemy
public string name
public bool spawn
public bool isTarget
public bool balaclava
public bool zombie
public bool armored
public string body
public string cRoute
public string dRoute
public string skill
public string staffType
public string[] powers
public override Position GetPosition()
public override void SetPosition(Position pos)
public override int GetID()
public override string GetObjectName()
```

### `soc:SOC/QuestObjects/Enemy/Forms/EnemyBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupBox_main
public System.Windows.Forms.CheckBox checkBox_target
public System.Windows.Forms.CheckBox checkBox_spawn
public System.Windows.Forms.CheckBox checkBox_balaclava
public System.Windows.Forms.CheckBox checkBox_zombie
public System.Windows.Forms.CheckBox checkBox_armor
public System.Windows.Forms.Label label_body
public System.Windows.Forms.ComboBox comboBox_body
public System.Windows.Forms.ComboBox comboBox_cautionroute
public System.Windows.Forms.Label label_cautionroute
public System.Windows.Forms.ComboBox comboBox_sneakroute
public System.Windows.Forms.Label label_sneakroute
public System.Windows.Forms.ComboBox comboBox_skill
public System.Windows.Forms.Label label_skill
public System.Windows.Forms.ComboBox comboBox_staff
public System.Windows.Forms.Label label_staff
public System.Windows.Forms.ComboBox comboBox_power
public System.Windows.Forms.Button button_removepower
public System.Windows.Forms.Label label_power
public System.Windows.Forms.ListBox listBox_power
public System.Windows.Forms.Button button_SneakToCaution
public System.Windows.Forms.Button button_CautionToSneak
public System.Windows.Forms.Button button_SwapRoutes
```

### `soc:SOC/QuestObjects/Enemy/Forms/EnemyBox.cs`
<!-- api only -->

```csharp
public partial class EnemyBox
public static void ResetFovaCounts()
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/Enemy/Forms/EnemyControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
public System.Windows.Forms.ComboBox comboBox_ObjType
public System.Windows.Forms.ComboBox comboBox_Subtype
```

### `soc:SOC/QuestObjects/Enemy/Forms/EnemyControl.cs`
<!-- api only -->

```csharp
public partial class EnemyControl
internal void SetMetadata(EnemiesMetadata meta, List<string> subtypes)
```

### `soc:SOC/QuestObjects/GeoTrap/Classes/GeoTrapFox2.cs`
<!-- api only -->

```csharp
internal static void AddQuestEntities(GeoTrapsDetail detail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/GeoTrap/Classes/GeoTrapLua.cs`
<!-- api only -->

```csharp
internal static void GetScriptChoosableValueSets(GeoTrapsDetail geoTrapsDetail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/GeoTrap/Forms/GeoTrapBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.ComboBox comboBox_geotrap
public System.Windows.Forms.TextBox textBox_rot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
public System.Windows.Forms.TextBox textBox_zscale
public System.Windows.Forms.TextBox textBox_yscale
public System.Windows.Forms.TextBox textBox_xscale
public System.Windows.Forms.RadioButton radioButton_box
public System.Windows.Forms.RadioButton radioButton_sphere
public System.Windows.Forms.CheckBox checkBoxPlayerOnlyTrigger
```

### `soc:SOC/QuestObjects/GeoTrap/Forms/GeoTrapBox.cs`
<!-- api only -->

```csharp
public partial class GeoTrapBox
public int ID
public bool _controlUpdate
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/GeoTrap/Forms/GeoTrapControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
public System.Windows.Forms.GroupBox groupboxDetail
```

### `soc:SOC/QuestObjects/GeoTrap/Forms/GeoTrapControl.cs`
<!-- api only -->

```csharp
public partial class GeoTrapControl
```

### `soc:SOC/QuestObjects/GeoTrap/GeoTrap.cs`
<!-- api only -->

```csharp
public class GeoTrap
public override Position GetPosition()
public override void SetPosition(Position pos)
public override int GetID()
public override string GetObjectName()
public int ID
public string geoTrap
public bool isPlayerOnlyTrigger
public string type
public string xScale
public string zScale
public string yScale
public Position position
```

### `soc:SOC/QuestObjects/GeoTrap/GeoTrapsDetail.cs`
<!-- api only -->

```csharp
public class GeoTrapsDetail
public GeoTrapsMetadata trapMetadata
public List<GeoTrap> trapShapes
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/GeoTrap/GeoTrapsMetadata.cs`
<!-- api only -->

```csharp
public class GeoTrapsMetadata
```

### `soc:SOC/QuestObjects/GeoTrap/GeoTrapsVisualizer.cs`
<!-- api only -->

```csharp
public class GeoTrapsControlPanel
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position pos, int index)
public void SetPlayerOnlyTriggerForGeoTrap(string geoTrapName, bool isChecked)
public bool GetPlayerOnlyTrigger(string geoTrapName, GeoTrapBox requester)
```

### `soc:SOC/QuestObjects/Helicopter/Classes/HelicopterFox2.cs`
<!-- api only -->

```csharp
internal static void AddQuestEntities(HelicoptersDetail questDetail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/Helicopter/Classes/HelicopterLua.cs`
<!-- api only -->

```csharp
internal static void GetDefinition(HelicoptersDetail questDetail, DefinitionScriptBuilder definitionLua)
internal static void GetMain(HelicoptersDetail questDetail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(HelicoptersDetail detail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Helicopter/Forms/HelicopterBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.ComboBox comboBox_dRoute
public System.Windows.Forms.ComboBox comboBox_class
public System.Windows.Forms.CheckBox checkBox_target
public System.Windows.Forms.ComboBox comboBox_cRoute
public System.Windows.Forms.CheckBox checkBox_spawn
```

### `soc:SOC/QuestObjects/Helicopter/Forms/HelicopterBox.cs`
<!-- api only -->

```csharp
public partial class HelicopterBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/Helicopter/Forms/HelicopterControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.Label label_ObjType
public System.Windows.Forms.ComboBox comboBox_ObjType
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
```

### `soc:SOC/QuestObjects/Helicopter/Forms/HelicopterControl.cs`
<!-- api only -->

```csharp
public partial class HelicopterControl
public void SetMetadata(HelicoptersMetadata meta)
```

### `soc:SOC/QuestObjects/Helicopter/Helicopter.cs`
<!-- api only -->

```csharp
public class Helicopter
public bool isSpawn
public bool isTarget
public int ID
public string dRoute
public string cRoute
public string heliClass
public Position position
public override int GetID()
public override string GetObjectName()
public override Position GetPosition()
public override void SetPosition(Position pos)
```

### `soc:SOC/QuestObjects/Helicopter/HelicopterVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override void SetDetailsFromSetup(ObjectsDetail detail, SetupDetails setup)
```

### `soc:SOC/QuestObjects/Helicopter/HelicoptersDetail.cs`
<!-- api only -->

```csharp
public class HelicoptersDetail
public HelicoptersMetadata helicopterMetadata
public List<Helicopter> helicopters
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToDefinitionLua(DefinitionScriptBuilder definitionLua)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Helicopter/HelicoptersMetadata.cs`
<!-- api only -->

```csharp
public class HelicoptersMetadata
public string objectiveType
```

### `soc:SOC/QuestObjects/Hostage/Classes/HostageFox2.cs`
<!-- api only -->

```csharp
public static void AddQuestEntities(HostagesDetail hDetails, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/Hostage/Classes/HostageLua.cs`
<!-- api only -->

```csharp
public static void GetDefinition(HostagesDetail hostageDetail, DefinitionScriptBuilder definitionLua)
public static void GetMain(HostagesDetail hostageDetail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(HostagesDetail hostagesDetail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Hostage/Forms/HostageBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.ComboBox comboBox_skill
public System.Windows.Forms.ComboBox comboBox_staff
public System.Windows.Forms.ComboBox comboBox_lang
public System.Windows.Forms.ComboBox comboBox_scared
public System.Windows.Forms.CheckBox checkBox_injured
public System.Windows.Forms.CheckBox checkBox_untied
public System.Windows.Forms.CheckBox checkBox_target
public System.Windows.Forms.TextBox textBox_rot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
```

### `soc:SOC/QuestObjects/Hostage/Forms/HostageBox.cs`
<!-- api only -->

```csharp
public partial class HostageBox
public int ID
public override QuestObject getQuestObject()
public void RefreshLanguage(string body)
```

### `soc:SOC/QuestObjects/Hostage/Forms/HostageControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.CheckBox checkBox_intrgt
public System.Windows.Forms.ComboBox comboBox_Body
public System.Windows.Forms.ComboBox comboBox_ObjType
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
```

### `soc:SOC/QuestObjects/Hostage/Forms/HostageControl.cs`
<!-- api only -->

```csharp
public partial class HostageControl
public void SetMetadata(HostageMetadata meta, string[] bodyNames, string cpName)
```

### `soc:SOC/QuestObjects/Hostage/Hostage.cs`
<!-- api only -->

```csharp
public class Hostage
public override string GetObjectName()
public override Position GetPosition()
public override void SetPosition(Position pos)
public override int GetID()
public bool isTarget
public bool isUntied
public bool isInjured
public int ID
public string skill
public string staffType
public string scared
public string language
public Position position
```

### `soc:SOC/QuestObjects/Hostage/HostagesDetail.cs`
<!-- api only -->

```csharp
public class HostagesDetail
public HostageMetadata hostageMetadata
public List<Hostage> hostages
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override void AddToDefinitionLua(DefinitionScriptBuilder definitionLua)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Hostage/HostagesMetadata.cs`
<!-- api only -->

```csharp
public class HostageMetadata
public string objectiveType
public string hostageBodyName
public bool canInterrogate
```

### `soc:SOC/QuestObjects/Hostage/HostagesVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position objectPosition, int objectID)
public override void SetDetailsFromSetup(ObjectsDetail detail, SetupDetails setup)
```

### `soc:SOC/QuestObjects/Item/Classes/ItemFox2.cs`
<!-- api only -->

```csharp
public static void AddQuestEntities(ItemsDetail detail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/Item/Classes/ItemLua.cs`
<!-- api only -->

```csharp
internal static void GetDefinition(ItemsDetail questDetail, DefinitionScriptBuilder definitionLua)
internal static void GetMain(ItemsDetail questDetail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(ItemsDetail detail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Item/Classes/ItemNames.cs`
<!-- api only -->

```csharp
public static string[] itemNames
```

### `soc:SOC/QuestObjects/Item/Forms/ItemBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.TextBox textBox_wrot
public System.Windows.Forms.TextBox textBox_zrot
public System.Windows.Forms.TextBox textBox_yrot
public System.Windows.Forms.ComboBox comboBox_item
public System.Windows.Forms.TextBox textBox_xrot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
public System.Windows.Forms.ComboBox comboBox_count
public System.Windows.Forms.CheckBox checkBox_boxed
public System.Windows.Forms.CheckBox checkBox_target
```

### `soc:SOC/QuestObjects/Item/Forms/ItemBox.cs`
<!-- api only -->

```csharp
public partial class ItemBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/Item/Forms/ItemControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
public System.Windows.Forms.ComboBox comboBox_ObjType
```

### `soc:SOC/QuestObjects/Item/Forms/ItemControl.cs`
<!-- api only -->

```csharp
public partial class ItemControl
internal void SetMetadata(ItemsMetadata meta)
```

### `soc:SOC/QuestObjects/Item/Item.cs`
<!-- api only -->

```csharp
public class Item
public override void SetPosition(Position pos)
public override Position GetPosition()
public override int GetID()
public override string GetObjectName()
public bool isBoxed
public bool isTarget
public int ID
public string count
public string item
public Position position
```

### `soc:SOC/QuestObjects/Item/ItemsDetail.cs`
<!-- api only -->

```csharp
public class ItemsDetail
public ItemsMetadata itemMetadata
public List<Item> items
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override void AddToDefinitionLua(DefinitionScriptBuilder definitionLua)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Item/ItemsMetadata.cs`
<!-- api only -->

```csharp
public class ItemsMetadata
public string objectiveType
```

### `soc:SOC/QuestObjects/Item/ItemsVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position pos, int index)
```

### `soc:SOC/QuestObjects/Model/Classes/ModelAssets.cs`
<!-- api only -->

```csharp
public static string modelAssetsPath
internal static void AddAssets(ModelsDetail questDetail, CommonAssetsBuilder assetsBuilder)
```

### `soc:SOC/QuestObjects/Model/Classes/ModelFox2.cs`
<!-- api only -->

```csharp
internal static void AddQuestEntities(ModelsDetail questDetail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/Model/Forms/ModelBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.TextBox textBox_wrot
public System.Windows.Forms.TextBox textBox_zrot
public System.Windows.Forms.TextBox textBox_yrot
public System.Windows.Forms.ComboBox comboBox_model
public System.Windows.Forms.TextBox textBox_xrot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
public System.Windows.Forms.CheckBox checkBox_collision
```

### `soc:SOC/QuestObjects/Model/Forms/ModelBox.cs`
<!-- api only -->

```csharp
public partial class ModelBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/Model/Forms/ModelControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
```

### `soc:SOC/QuestObjects/Model/Forms/ModelControl.cs`
<!-- api only -->

```csharp
public partial class ModelControl
```

### `soc:SOC/QuestObjects/Model/Model.cs`
<!-- api only -->

```csharp
public class Model
public override Position GetPosition()
public override void SetPosition(Position pos)
public override int GetID()
public override string GetObjectName()
public bool collision
public int ID
public string model
public Position position
```

### `soc:SOC/QuestObjects/Model/ModelsDetail.cs`
<!-- api only -->

```csharp
public class ModelsDetail
public ModelsMetadata modelMetadata
public List<Model> models
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToAssets(CommonAssetsBuilder assetsBuilder)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override ObjectsDetailControlPanel GetControlPanel()
```

### `soc:SOC/QuestObjects/Model/ModelsMetadata.cs`
<!-- api only -->

```csharp
public class ModelsMetadata
```

### `soc:SOC/QuestObjects/Model/ModelsVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position pos, int index)
```

### `soc:SOC/QuestObjects/UAV/Classes/UAVAssets.cs`
<!-- api only -->

```csharp
internal static void GetUAVAssets(UAVsDetail questDetail, CommonAssetsBuilder assetsBuilder)
```

### `soc:SOC/QuestObjects/UAV/Classes/UAVFox2.cs`
<!-- api only -->

```csharp
internal static void AddQuestEntities(UAVsDetail detail, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/UAV/Classes/UAVLua.cs`
<!-- api only -->

```csharp
internal static void GetMain(UAVsDetail detail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(UAVsDetail detail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/UAV/Forms/UAVBox.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.ComboBox comboBox_aRoute
public System.Windows.Forms.ComboBox comboBox_dRoute
public System.Windows.Forms.CheckBox checkBox_target
public System.Windows.Forms.TextBox textBox_rot
public System.Windows.Forms.TextBox textBox_zcoord
public System.Windows.Forms.TextBox textBox_ycoord
public System.Windows.Forms.TextBox textBox_xcoord
public System.Windows.Forms.CheckBox checkBox_docile
public System.Windows.Forms.ComboBox comboBox_defense
public System.Windows.Forms.ComboBox comboBox_weapon
```

### `soc:SOC/QuestObjects/UAV/Forms/UAVBox.cs`
<!-- api only -->

```csharp
public partial class UAVBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/UAV/Forms/UAVControl.Designer.cs`
<!-- api only -->

```csharp
protected override void Dispose(bool disposing)
public System.Windows.Forms.GroupBox groupboxDetail
public System.Windows.Forms.ComboBox comboBox_ObjType
public System.Windows.Forms.FlowLayoutPanel panelQuestBoxes
```

### `soc:SOC/QuestObjects/UAV/Forms/UAVControl.cs`
<!-- api only -->

```csharp
public partial class UAVControl
public void SetMetadata(UAVsMetadata meta)
```

### `soc:SOC/QuestObjects/UAV/UAV.cs`
<!-- api only -->

```csharp
public class UAV
public override Position GetPosition()
public override void SetPosition(Position pos)
public override int GetID()
public override string GetObjectName()
public int ID
public bool isTarget
public bool docile
public string aRoute
public string dRoute
public string weapon
public string defenseGrade
public Position position
```

### `soc:SOC/QuestObjects/UAV/UAVsDetail.cs`
<!-- api only -->

```csharp
public class UAVsDetail
public UAVsMetadata UAVmetadata
public List<UAV> UAVs
public override ObjectsMetadata GetMetadata()
public override List<QuestObject> GetQuestObjects()
public override void SetQuestObjects(List<QuestObject> qObjects)
public override void AddToAssets(CommonAssetsBuilder assetsBuilder)
public override void AddToMainLua(MainScriptBuilder mainLua)
public override void AddToFox2Entities(DataSet dataSet, List<Fox2EntityClass> entityList)
public override ObjectsDetailControlPanel GetControlPanel()
public override void AddToScriptKeyValueSets(ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/UAV/UAVsMetadata.cs`
<!-- api only -->

```csharp
public class UAVsMetadata
public string objectiveType
```

### `soc:SOC/QuestObjects/UAV/UAVsVisualizer.cs`
<!-- api only -->

```csharp
public override void DrawMetadata(ObjectsMetadata meta)
public override ObjectsMetadata GetMetadataFromControl()
public override QuestObjectBox NewQuestObjectBox(QuestObject qObject)
public override ObjectsDetail NewDetail(ObjectsMetadata meta, IEnumerable<QuestObject> qObjects)
public override QuestObject NewQuestObject(Position pos, int index)
public override void SetDetailsFromSetup(ObjectsDetail detail, SetupDetails setup)
```

### `soc:SOC/QuestObjects/Vehicle/Classes/VehicleAssets.cs`
<!-- api only -->

```csharp
internal static void GetVehicleAssets(VehiclesDetail questDetail, CommonAssetsBuilder assetsBuilder)
```

### `soc:SOC/QuestObjects/Vehicle/Classes/VehicleFox2.cs`
<!-- api only -->

```csharp
public static void AddQuestEntities(VehiclesDetail details, DataSet dataSet, List<Fox2EntityClass> entityList)
```

### `soc:SOC/QuestObjects/Vehicle/Classes/VehicleInfo.cs`
<!-- api only -->

```csharp
public static readonly Dictionary<string, string>
public static void GetVehicle2Body(string colloquialName, out string bodyName, out string TypeIndex, out string ImplTypeIndex, out string partsFileName)
public static void GetVehicle2Attachment(string colloquialName, out string attachementName, out string typeCode, out string ImplTypeIndex, out string partsFileName, out string instanceCount, out string CnpName)
```

### `soc:SOC/QuestObjects/Vehicle/Classes/VehicleLua.cs`
<!-- api only -->

```csharp
public static void GetMain(VehiclesDetail detail, MainScriptBuilder mainLua)
internal static void GetScriptChoosableValueSets(VehiclesDetail vehiclesDetail, ChoiceKeyValuesList questKeyValues)
```

### `soc:SOC/QuestObjects/Vehicle/Forms/VehicleBox.cs`
<!-- api only -->

```csharp
public partial class VehicleBox
public int ID
public override QuestObject getQuestObject()
```

### `soc:SOC/QuestObjects/Vehicle/VehiclesMetadata.cs`
<!-- api only -->

```csharp
public class VehiclesMetadata
public string ObjectiveType
```

## MGSV Modding and Research Wiki

<https://github.com/mgsvmoddingwiki/mgsvmoddingwiki.github.io>

### `wiki:wiki/AI/mgs/mgs.md`

##### General Information

![Sahelanthropus art from "The Art of Metal Gear Solid V" (page 110)](/assets/AI/images/mgs/sally art.png){:.thumb .right}

Sahelanthropus, also known as "Sally" is the Metal Gear present on Metal Gear Solid V.<br>

Sahelanthropus contains a vast arsenal, composed by 2 Vulcan guns, multiple guided small missiles, search missiles, a flamethrower, Archaea grenades capable of disabling any vehicle on the nearby area, 2 Archaea blades with different functions, a pile bunker used for precise melee attacks, a Railgun capable of firing nuclear shells and for last, an armor composed of depleted uranium that can be enriched with parasites during self destruction for an powerful nuclear explosion.<br><br>
Each attack varies with the AI being used on it, for example, using hellbound AI, search missiles will act as an independent drone looking for the player and warning Sahelanthropus if they detect the player but on Dominion AI, search missiles will act as guided missiles, unlike small guided missiles they don't follow the player movement, they only fly towards the player location on the moment they lift off.<br><br>

In the game, the guns that Sahelanthropus can use is controled by AI and Battle sequence, for example, the Railgun, Archaea blades and Archaea grenades are not used by Hellbound AI and the weapons that Dominion AI can use is controled by battle sequences<br><br>

There is also an shield that is disabled by default, this shield was meant to be used on "Kingdom of the Flies" but since we never got that, we never got a working shield.<br>The shield is present on Sahelanthropus Main and Static models, there is also colision files for it but the mesh and colision are disabled by the .exe, unlike the Railgun and the Railgun Loader that are disabled only on Hellbound AI, the shield is fully disabled all the time.<br>
![Sahelanthropus with the shield mesh visible](/assets/AI/images/mgs/shln_shield example.png){:.thumb}

Sahelanthropus does have colision with the player, animals, soldiers and vehicles but can only deal damage to animals, vehicles and the player, and no, Sahelanthropus isn't coded to attack anything else besides the player and Huey(?) on Hellbound episode.<br>Funnily enough, if you use soldiers as a human shield while it attacks you with the vulcan guns, it will damage the soldiers and they will fall to the ground heavily wounded but no blood will be present.

- Model Location
    - Main: `/Assets/tpp/mecha/mgs/Scenes/mgs0_main0_def.fmdl`
    - Static: `/Assets/tpp/mecha/mgs/Scenes/mgs0_main0_obj.fmdl`
    - Demos (?): `/Assets/tpp/mecha/mgs/Scenes/mgs0_main0_snd.fmdl`
- Common Pack
	- Pack Name: `MISSION_COMMON_PACK.SAHELAN`
	- Location: `/Assets/tpp/pack/mission2/common/mis_com_sahelan.fpk`
- Sound Package
	- `/Assets/tpp/sound/se_e_mgs.sdf`
- Linked Entities
	- `TppMantis2`
	- `TppSearchMissilePointData`
	- `TppHidePointData`
- Game Object Locator Data
	- Flags: `7`
    - TypeName: `TppSahelan2`
    - Parameters: `TppSahelan2LocatorParameter`
- GameObject File
	- Hellbound AI: `/Assets/tpp/level_asset/chara/mecha/sahelan_afgn_1st.fox2`
	- Dominion AI: `/Assets/tpp/level_asset/chara/mecha/sahelan_afgn.fox2`
- GameObject Data
	- typeName: `TppSahelan2`
	- parameters: `TppSahelan2Parameter`
- connectPointFile
	- Main: `/Assets/tpp/mecha/mgs/Scenes/mgs0_main0_def.fcnp`
- gameRigFile
	- Main: `/Assets/tpp/rig/frig/tpp_sahelan_all.frig`
- helpBoneFile
	- Main: `/Assets/tpp/mecha/mgs/Scenes/mgs0_main0_def.frdv`
- GeomSkeleton
	- Main: `/Assets/tpp/mecha/mgs/Scenes/mgs0_main0_def.gskl`
- FoxTargetDescription (Hitboxes)
	- Main (Target): `/Assets/tpp/parts/mecha/mgs/SahelanTargetDefense.tgt`
	- Damaged Main (TargetEx): `/Assets/tpp/parts/mecha/mgs/SahelanTargetDefenseEx.tgt`
	- Damaged Shield (TargetExShield): `/Assets/tpp/parts/mecha/mgs/SahelanTargetDefenseExShield.tgt`
	- Left Front Parasites/propane? tank (TargetPTLF): `/Assets/tpp/parts/mecha/mgs/SahelanTargetDefensePTLF.tgt`
	- Right Front Parasites/propane? tank (TargetPTRF): `/Assets/tpp/parts/mecha/mgs/SahelanTargetDefensePTRF.tgt`
	- Left Back Parasites/propane? tank (TargetPTLB): `/Assets/tpp/parts/mecha/mgs/SahelanTargetDefensePTLB.tgt`
	- Right Back Parasites/propane? tank (TargetPTRB): `/Assets/tpp/parts/mecha/mgs/SahelanTargetDefensePTRB.tgt`
- Motion Graph File
	- Hellbound AI: `/Assets/tpp/motion/motion_graph/sahelan2/TppSahelan2for1st_layers.mog`
	- Dominion AI: `/Assets/tpp/motion/motion_graph/sahelan2/TppSahelan2_layers.mog`
- Motion Archive File
	- Hellbound AI: `/Assets/tpp/motion/mtar/sahelan2/TppSahelan2for1st_layers.mtar`
	- Dominion AI: `/Assets/tpp/motion/mtar/sahelan2/TppSahelan2_layers.mtar`
- Hellbound AI Effects
	- SwordStick: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk02_s5.vfx`
	- SwordSwing: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01_s5.vfx`
	- BlastMissile: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepexprpg01_s2LG.vfx`
	- DamageSmoke: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsdmgsmk01_s5.vfx`
	- BrokenSmoke: `/Assets/tpp/effect/vfx_data/smoke/fx_tpp_smkmchbrk02_m2LG.vfx`
	- BreakExplosion: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch02_m1LG.vfx`
	- FireFlame: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchatkfir01_m2.vfx`
	- SwordPreEffect: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk03_s5.vfx`
	- MissileMuzzle: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsmslmzf01_s1.vfx`
	- TestRailGunReady: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgmstncrg01_s3.vfx`
	- MantisEffect: `/Assets/tpp/effect/vfx_data/chara/fx_tpp_chamntsmk01_s0LD.vfx`
	- SwordSwingNew: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01c_s5.vfx`
	- RailGunFire: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepbltrgn01_m1.vfx`
	- Search: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrc01_m5.vfx`
	- DeadExplosion: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch03_m2.vfx`
	- PileBunkerStick: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01s_s5.vfx`
	- DeadFloorSmoke: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk03b_m2.vfx`
	- BlastSearchMissile: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expgrnd01_s2LG.vfx`
- Dominion AI Effects
	- SwordStick: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk02_s5.vfx`
	- SwordSwing: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01_s5.vfx`
	- BlastMissile: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepexprpg01_s2LG.vfx`
	- DamageSmoke: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsdmgsmk01_s5.vfx`
	- BrokenSmoke: `/Assets/tpp/effect/vfx_data/smoke/fx_tpp_smkmchbrk02_m2LG.vfx`
	- BreakExplosion: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch02_m1LG.vfx`
	- FireFlame: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchatkfir01_m2.vfx`
	- SwordPreEffect: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk03_s5.vfx`
	- MissileMuzzle: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsmslmzf01_s1.vfx`
	- TestRailGunReady: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgmstncrg01_s3.vfx`
	- MantisEffect: `/Assets/tpp/effect/vfx_data/chara/fx_tpp_chamntsmk01_s0LD.vfx`
	- RailGunFire: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepbltrgn01_m1.vfx`
	- SwordSwingNew: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01c_s5.vfx`
	- Search: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrc01_m5.vfx`
	- ActiveBlade: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep03_m2.vfx`
	- BladeHit: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep06_m2.vfx`
	- GroundFire: `/Assets/tpp/effect/vfx_data/fire/fx_tpp_firvol04b_s1.vfx`
	- DeadExplosion: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch03_m2.vfx`
	- MantisEffectSlow: `/Assets/tpp/effect/vfx_data/chara/fx_tpp_chrmntrip02_s5.vfx`
	- MushiarashiSmoke: `/Assets/tpp/effect/vfx_data/dust/fx_tpp_dstsndstmviw01s_m1.vfx`
- General Effects
	- fx_tpp_expmch01_m1LG: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch01_m1LG.vfx`
	- fx_tpp_expgrnd01_s2LG: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expgrnd01_s2LG.vfx`
	- MgsFootSmokeS: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk01_s5.vfx`
	- MgsFootSmokeM: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk02_m1.vfx`
	- MgsJumpSmokeM: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk03_m2.vfx`
	- MgsJumpSmokeS: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk04_m1.vfx`
	- Seeker: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtldm01_m1.vfx`
	- BladeLaunchL: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep02_m1.vfx`
	- BladeLaunchR: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep02_m1.vfx`
	- SparkActive: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepltb04_s0.vfx`
	- BreakBody: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakBP: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakHead: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakArmR: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakArmL: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakThighR: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakThighL: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakLegR: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakLegL: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakRGun: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakLdr: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- BreakTnk: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx`
	- HeartLight: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtwst01_s6.vfx`
	- PositionLightRed: `/Assets/tpp/effect/vfx_data/flare/fx_tpp_flrcom00_s0LG.vfx`
	- PositionLightBlue: `/Assets/tpp/effect/vfx_data/flare/fx_tpp_flrcom00_s0LG.vfx`
	- MuzzleLamp: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtmzf01_s0.vfx`
	- EyeLamp: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgthed01_s2.vfx`
	- EyeLampSide: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgthed01_s2.vfx`
	- EyeFlare: `/Assets/tpp/effect/vfx_data/flare/fx_tpp_flrlgt20evs_m1LD.vfx`
	- MuzzleFlashR: `/Assets/tpp/effect/vfx_data/muzzle/fx_tpp_mzfhli_s0FG.vfx`
	- MuzzleFlashL: `/Assets/tpp/effect/vfx_data/muzzle/fx_tpp_mzfhli_s0FG.vfx`
	- MgsStomp: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk09_m1.vfx`
	- RailCharge: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepltbrgn01_m1.vfx`
	- DamageSmokeHead: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsdmgsmk01_s5.vfx`
	- HeartLightWeak: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtwst01_s6.vfx`
	- BladeLaunchFinishR: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep02_m1.vfx`
	- BladeLaunchFinishL: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep02_m1.vfx`
	- FinishCharge: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtldm02_m1.vfx`
	- DamageWeak: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsdmgspk01_s5.vfx`
- Geom Colision tag
	- `GEO_COL_A_MISSILE2`
- Attack IDs
	- `ATK_Sahelan_FootStamp`
	- `ATK_Sahelan_RodAttack`
	- `ATK_Sahelan_RodAttackImpact`
	- `ATK_Sahelan_JumpImpact`
	- `ATK_Sahelan_HeadVulcan`
	- `ATK_Sahelan_ParasiteSword`
	- `ATK_Sahelan_SmallMissile`
	- `ATK_Sahelan_MidleMissile`
	- `ATK_Sahelan_AirMine`
	- `ATK_Sahelan_Grenade`
	- `ATK_Sahelan_Flame`
	- `ATK_Sahelan_RailGun`
	- `ATK_Sahelan_PileBunker`
	- `ATK_Sahelan_Stomp`
	- `ATK_Sahelan_RockExplosion`
	- `ATK_Sahelan_TowerBreak`
- Parts Strings
	- `SAHELAN2_PARTS_BODY`
	- `SAHELAN2_PARTS_BP`
	- `SAHELAN2_PARTS_HEAD`
	- `SAHELAN2_PARTS_ARMR`
	- `SAHELAN2_PARTS_ARML`
	- `SAHELAN2_PARTS_THIGHR`
	- `SAHELAN2_PARTS_THIGHL`
	- `SAHELAN2_PARTS_LEGR`
	- `SAHELAN2_PARTS_LEGL`
	- `SAHELAN2_PARTS_RGUN`
	- `SAHELAN2_PARTS_LDR`
	- `SAHELAN2_PARTS_TNK`
	- `SAHELAN2_PARTS_SHIELD`
	- `SAHELAN2_PARTS_PT_LF`
	- `SAHELAN2_PARTS_PT_RF`
	- `SAHELAN2_PARTS_PT_LB`
	- `SAHELAN2_PARTS_PT_RB`
- Route Edge Events
	- `All`
	- `StandWalk`
	- `RunWalk`
	- `RunOnly`
	- `WalkOnly`
	- `JumpOnly` (Scrapped)
	- `JumpWalk`
	- `JumpRun`
- Route Node Events
	- `StandSearch`
	- `SearchMissile` (Scrapped)
	- `StandIdle`
	- `OnTheHill` (Scrapped)
	- `OnBaseRoute`
	- `PileBunker`
	- `BreakSteelTower`
	- `Peep1`
	- `Peep2`
	- `Peep3`
	- `PeepLeft`
	- `PeepRight`

##### Health Points and parts
Sahelanthropus Health Points are managed on the enemy subscript. There is on total 17 parts for Sahelanthropus.<br>
Example of `sahelanLifeTable` from Episode 30:<br>
```lua
Body     = 12000,-- Body
Bp       = 840,  -- ???
Head     = 3000, -- Head
ArmR     = 840,  -- Right Arm
ArmL     = 840,  -- Left Arm
ThighR   = 840,  -- Right Thigh
ThighL   = 840,  -- Left Thigh
LegR     = 840,  -- Right Leg
LegL     = 840,  -- Left Leg
RGun     = 1200, -- RailGun
Ldr      = 840,  -- RailGun Loader
Tnk      = 840,  -- Flame thrower
Shield   = 0,    -- Shield
PTLF     = 96,   -- Left Front Parasite/Propane? Tank
PTRF     = 96,   -- Right Front Parasite/Propane? Tank
PTLB     = 96,   -- Left Back Parasite/Propane? Tank
PTRB     = 96,   -- Right Back Parasite/Propane? Tank
```

![Body](/assets/AI/images/mgs/shln_hp body.png){:.thumb}
![Bp](/assets/AI/images/mgs/shln_hp bp.png){:.thumb}
![Head](/assets/AI/images/mgs/shln_hp head.png){:.thumb}
![ArmR](/assets/AI/images/mgs/shln_hp rarm.png){:.thumb}
![ArmL](/assets/AI/images/mgs/shln_hp larm.png){:.thumb}
![ThighR](/assets/AI/images/mgs/shln_hp rthigh.png){:.thumb}
![ThighL](/assets/AI/images/mgs/shln_hp lthigh.png){:.thumb}
![LegR](/assets/AI/images/mgs/shln_hp rleg.png){:.thumb}
![LegL](/assets/AI/images/mgs/shln_hp lleg.png){:.thumb}
![RGun](/assets/AI/images/mgs/shln_hp railgun.png){:.thumb}
![Ldr](/assets/AI/images/mgs/shln_hp loader.png){:.thumb}
![Tnk](/assets/AI/images/mgs/shln_hp flamet.png){:.thumb}
![Shield](/assets/AI/images/mgs/shln_hp shield.png){:.thumb}
![PTLF](/assets/AI/images/mgs/shln_hp PTLF.png){:.thumb}
![PTRF](/assets/AI/images/mgs/shln_hp PTRF.png){:.thumb}
![PTLB](/assets/AI/images/mgs/shln_hp PTLB.png){:.thumb}
![PTRB](/assets/AI/images/mgs/shln_hp PTRB.png){:.thumb}

>Shield Value Does not matter since the shield is disabled on the .exe<br>
>Only use integer values for Health Points<br>
>Parts names might be case sensitive
{:.important}

##### Stage Types
The Stage type controls what AI is used, if Sahelanthropus is used without an stage type set, it will remain idle, same happens if the user sets an Stage Type that does not exist.<br>
There is 3 types of Stages available to be used:<br><br>
`0` --> HellBound AI -- Used on Episode 12 - HELLBOUND<br>
`1` --> Dominion AI (Normal) -- Used on Episode 31 - SAHELANTHROPUS<br>
`2` --> Dominion AI (Extreme) -- Used on Episode 50 - (EXTREME) SAHELANTHROPUS<br>

> Hellbound AI and Dominion AI are names given by me (retali8), they are not official names for the AIs.
> Internaly, both Ai modes are complex with many other "AIs" being part of them (Ex: RoarAI)
{:.important}

The stage type can be changed with the next lua code:<br>
```lua
this.SetSahelanType = function()
	local gameObjectId = {type="TppSahelan2", group=0, index=0}
	local command = {id="SetStageType", index = 0, }
	GameObject.SendCommand(gameObjectId, command)
end
```
The index value Inside the command variable will determine the stage type
>Setting Sahelanthropus to Index `2` will not change its color to black, that is done by the .exe.<br>
>This command must be used on `sequence` subscript.
{:.important}

##### Route Events

###### Edge Events

Edge Events are used by ```tpp::gm::sahelan::impl::`anonymous_namespace'::RouteAiImpl::GetSpeedWithRouteEventId``` and they seem to control Sahelanthropus speed <br>

**Edge event: `All`** Can return `2` or `3`<br>
**Edge event: `StandWalk`** Returns `2`<br>
**Edge event: `RunWalk`** Can return `2` or `3`<br>
**Edge event: `RunOnly`** Returns `3`<br>
**Edge event: `WalkOnly`** Returns `2`<br>
**Edge event: `JumpWalk`** Returns `2`<br>
**Edge event: `JumpRun`** Returns `3`<br>

There was also a **Edge event: `Jump Only`** but it was scrapped<br>

![GetSpeedWithRouteEventId preview in ghidra (pre-release exe)](/assets/AI/images/mgs/ShlnGetSpeedPreview.webp){:.thumb}

>On Dominion AI, routes are only used for Railgun Jump Attack were Mantis appears, Dominion AI uses navmesh to walk, run and jump<br>
{:.important}

###### Node Events

**Node event: `StandSearch`**<br>
Triggers an animations where Sahelanthropus searches for the player with an spotlight.

**Node event: `SearchMissile`**<br>
Scrapped, does nothing.<br><br>
**Node event: `StandIdle`**<br>
Makes Sahelanthropus Idle facing towards the direction of the node for as long as the duration is set to<br><br>
**Node event: `OnTheHill`**<br>
Scrapped, does nothing.<br><br>
**Node event: `OnBaseRoute`**<br>
Used a lot on Hellbound, what it exactly does is unclear<br><br>
**Node event: `PileBunker`**<br>
Triggers an attack, Sahelanthropus will attack with the pile bunker, it can affect rock gimmicks if its set up properly.

**Node event: `BreakSteelTower`**<br>
Triggers an attack, Sahelanthropus will attack an antenna if the route node and antenna are set up properly.

**Node event: `Peep1`**<br>
**Node event: `Peep2`**<br>
**Node event: `Peep3`**<br>
Triggers a special search animation, all 3 seem to do the same thing

**Node event: `PeepLeft`**<br>
Triggers a animation where Sahelanthropus leans to the left while searching

**Node event: `PeepRight`**<br>
Triggers a animation where Sahelanthropus leans to the right while searching

##### Other Documentation
[Sahelanthropus Visual Effects](/AI/mgs/mgs_vfx)<br>

##### Hellbound Documentation
[Hellbound Debug Functions](/AI/mgs/mgs_hellbound_Debug_Functions)<br>
[Hellbound route assignment](/AI/mgs/mgs_hellroutes)<br>
[Hellbound Search Missiles](/AI/mgs/mgs_hellsearchmissiles)<br>
[Hellbound Heli attack sequence](/AI/mgs/mgs_Hellheli)<br>

##### Dominion Documentation
[Navmesh Params and Flags](/AI/mgs/mgs_nav2_params)<br>
[sahelan Navworld](/AI/mgs/mgs_NavWorld)<br>
[Dominion route assignment](/AI/mgs/mgs_DomRoutes)<br>
[Dominion REX mode](/AI/mgs/mgs_rexmode)<br>

### `wiki:wiki/AI/mgs/mgs_DomRoutes.md`

##### What are routes used for on Dominion AI ?

The Base route for Dominion AI is used for the Mantis jump attack.

>the Boss fight wont work without one base route assigned.
{:.important}

##### How to manage Base Routes for Dominion AI

Unlike Hellbound AI, where routes need to be manually activated with geotraps, routes for Dominion AI are much easier to manage since it only uses one.

###### Managing routes with Foxkit

Start by creating a Routeset on foxkit and inside that routeset create the route, for Dominion AI i recommend you to:
>keep it only for roads and wide areas<br>
>Make sure there is a big space between nodes<br>
>Always remember that Sahelanthropus wont follow the route, it will only use the route nodes as an reference point for the mantis jump attack

As an example, im going to make a route inside Nova Braga Airport like the one bellow:

![The yellow line represents the route](/assets/AI/images/mgs/shln_Domroute.png)

>Use edge event type `Run Walk` for Dominion Base route
{:.important}

After you finish creating the route, export the dataset and make sure it will be loaded on the mission pack

###### Assign a base route on the mission scripts

In order to make the boss fight start without any issue, you need to assign a base route to Sahelanthropus. The base route can be assigned with the next command on the enemy subscript:

```lua
local gameObjectId = {type="TppSahelan2", group=0, index=0}
local command = {id="SetBaseRoute", route="ROUTE NAME HERE"}
GameObject.SendCommand(gameObjectId, command)
```
In this example, im going to be loading one route, one named `rt_shln_Africa_b_0000`, on Nova Braga Airport and it will be assigned on the enemy subscript with the command bellow.

```lua
local gameObjectId = {type="TppSahelan2", group=0, index=0}
local command = {id="SetBaseRoute", route="rt_shln_Africa_b_0000"}
GameObject.SendCommand(gameObjectId, command)
```

During the Boss fight, the assigned route nodes will be used by Sahelanthropus on the Mantis Jump Attack, the order of the nodes does not mater since Sahelanthropus wont follow the route order at all.<br>

Keep in mind that Sahelanthropus will only use the Mantis Jump Attack after the game returns the message `SahelanReturned1stRailGun`, and of course the player needs to be near a route node.

>The route will also be used if the player is on a area without navmesh for Sahelanthropus.

### `wiki:wiki/AI/mgs/mgs_NavWorld.md`

##### Metal Gear Sahelanthropus Navworld

Sahelanthropus Navmesh is loaded on its very own Navworld called `sahelan`<br>This Navworld is limited to only load 2 Navmesh at once, that can be changed by editing `Tpp/start.lua`.<br><br>
Unlike the Navworld Used by Other AIs (excluding the helicopters), `sahelan` Navworld does not contain the next properties:<br>
`maxGraphBounderCount`<br>
`maxTacticalActionCount`<br>
`navigationGraphDynamicLinkContainerInfo`<br>
`segmentGraphDynamicLinkContainerInfo`<br>
`segmentGraphDynamicPortalContainerInfo`<br>
`islandGraphDynamicLinkContainerInfo`<br>

### `wiki:wiki/AI/mgs/mgs_hellbound_Debug_Functions.md`

#### Hellbound AI Debug Functions

There is some debug functions that devs left inside the episode 12 enemy script:<br>
```lua
DEBUG.SetDebugMenuValue("Sahelan2", "ToStopActionRestLifeVal",	100 )
DEBUG.SetDebugMenuValue("Sahelan2", "StompAttackSize",	100 )
DEBUG.SetDebugMenuValue("Sahelan2", "AttackShortRange",  25 )
DEBUG.SetDebugMenuValue("Sahelan2", "LostAlertTime", 20)
DEBUG.SetDebugMenuValue("Sahelan2", "LostPlayerTime", 40 )
DEBUG.SetDebugMenuValue("Sahelan2", "GoToHeliDistanceMin", 120 )
DEBUG.SetDebugMenuValue("Sahelan2", "CloseToTargetLength", 55 )
DEBUG.SetDebugMenuValue("Sahelan2", "LengthForPeepAction", 30 )
DEBUG.SetDebugMenuValue("Sahelan2", "RouteEvToPlayerLength", 40 )
DEBUG.SetDebugMenuValue("Sahelan2", "ReflexTimeOnAlert", 600)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyDiscoveryDist", 35)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyDiscoveryVAngle", 90)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyDiscoveryHAngle", 60)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyNormalDist", 75)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyNormalVAngle", 90)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyNormalHAngle", 50)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyFarDist", 150)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyFarVAngle", 60)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "BodyFarHAngle", 50)
DEBUG.SetDebugMenuValue("Sahelan2 Sight", "NormalToFarSpeed", 30)
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VsHeliMissileSpdRate", 150 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VsHeliSrchMissInterval", 75 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VsHeliSrchMissWaitingTime", 85 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VsHeliLastAttackTime", 400 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunFireMaxTime", 6 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunFireLostTime", 3 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunFireRange", 100 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunFireNumOfOneShot", 5 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunOneShotInterval", 45 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunFireNumOfOneUnit", 3 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunOneUnitInterval", 150 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunOneSetInterval", 300 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunWobbingRate2", 3 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "VulcunImpactRange", 45 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "PileAtkStartWaitTime", 80 )
DEBUG.SetDebugMenuValue("Sahelan2 Weapon", "PileAtkEndWaitTime", 150 )
```

### `wiki:wiki/AI/mgs/mgs_hellheli.md`

TODO

This sequence is very hard to replicate

### `wiki:wiki/AI/mgs/mgs_hellroutes.md`

##### Hellbound Routes

Hellbound AI, unlike Dominion AI, does not use navmesh at all, it uses routes to move around.<br><br>

There is 3 types of routes for Hellbound AI: <br>

**Base Route**: Used by Sahelanthropus if the current Sneak/Caution route is far away<br>
**Sneak Routes**: Used by Sahelanthropus while its on Phase Sneak<br>
**Caution Routes**: Used by Sahelanthropus while its on Phase Caution and Phase Alert<br>

>Hellbound AI was made to operate on small areas only, making it operate on bigger areas is currently very hard since there is a limit of 128 total GeoTraps assigned to it<br>
{:.important}

>You can see the current Sahelanthropus phase by the color of its "eyes", if its blue, Sahelanthropus is on phase sneak, if its orange, Sahelanthropus is on phase caution and if its red, Sahelanthropus is on phase alert.

##### How it works ?

The way routes work on Hellbound AI can be a bit confusing.<br>
To start, on the mission enemy subscript you need to assign 1 base route, 1 sneak route and 1 caution route<br>
they can be assigned with the following code:<br>

Base Route:
```lua
--1st you need to create the function, it can be like the one bellow

this.UpdateSahelanBaseRoute = function( baseRouteName )
	local gameObjectId = {type="TppSahelan2", group=0, index=0}
	local command = {id="SetBaseRoute", route=baseRouteName}
	GameObject.SendCommand(gameObjectId, command)
end

--then you need to call this function with the route you want to use as a base route
--i recommend you to call it on the "SetUpSahelan" function
--it should be something like this

this.UpdateSahelanBaseRoute( "x" )

--replace x with the ID/name of the route that you want to use
```
Caution and Sneak routes:
```lua
--1st you need to create the function, it can be like the one bellow

this.SetSahelanRoute = function( sneakRouteName, cautionRouteName )
	local gameObjectId = {type="TppSahelan2", group=0, index=0}
	local command1 = {id="SetSneakRoute", route=sneakRouteName}
	GameObject.SendCommand(gameObjectId, command1)
end

--then you need to call this function with the routes you want to use as sneak and caution when the mission starts
--i recommend you to call it on the "SetUpSahelan" function
--it should be something like this

this.SetSahelanRoute( "x", "y" )

--replace x with the ID/name of the route that you want to use for sneak
--replace y with the ID/name of the route that you want to use for caution
```

###### How are routes updated while in-game?

While in-game, the routes for Hellbound AI are updated with geotraps.<br>
Every time one geotrap that is assigned to Sahelanthropus is activated by player, the game will check what routes are assigned to the geotrap and update them.

>Updating the base route with Sahelanthropus active is a bad idea.
{:.important}

Caution and Sneak routes:
```lua

--this function can be a bit hard to understand.
this.UpdateSahelanRoute = function( trapName )
	local sahelanRouteTable = this.sahelanRouteTable
	local ignoreTrapList = this.ignoreTrapList

--basically starts by checking if the geotrap that got activated is assigned to ignoreTrapList

--if it is, it checks if SahelanCounter is bigger then SAHELAN_WEAKENING_COUNT
--SahelanCounter starts at 0 and its increased every time Sahelanthropus goes into phase_alert
--SAHELAN_WEAKENING_COUNT is originaly set to 2

--that means if Sahelanthropus goes into phase_alert 3 or more times
--the geotraps present on ignoreTrapList will be igored by it.

--you can modify SAHELAN_WEAKENING_COUNT value to your liking

	for k, ignoreTrap in pairs(ignoreTrapList) do
		if trapName == ignoreTrap and this.SahelanCounter > SAHELAN_WEAKENING_COUNT then
			return
		end
	end

--here it checks if the activated geotrap matches a geotrap assigned on sahelanRouteTable

-- v[1] is sneak route and v[2] is caution route

--this is a fuction that i created since the origianal one updates both sneak and caution
--at the same time for all geotraps assigned

--this function allows you to update either both routes at once or only update the sneak/caution route.
--It requires one route on the dataset called rt_shln_Null, otherwise it wont work

	for k, v in pairs(sahelanRouteTable) do
		--if none are are null, means both have routes assigned, both routes are updated
		if v[1] ~= "rt_shln_Null" and v[2] ~= "rt_shln_Null" then
				if k == trapName then
					this.SetSahelanRoute( v[1], v[2] )
					return
				end
		--if both are null, nothing is done
		elseif v[1] == "rt_shln_Null" and v[2] == "rt_shln_Null" then
				if k == trapName then
					return
				end
		--if caution route is null and sneak is not, only sneak route is updated
		elseif v[1] ~= "rt_shln_Null" and v[2] == "rt_shln_Null" then
			if k == trapName then
					this.SetSahelanSneakRoute(v[1])
					return
			end
		--if caution route is not null and sneak is, only caution route is updated
		elseif v[1] == "rt_shln_Null" and v[2] ~= "rt_shln_Null" then
			if k == trapName then
					this.SetSahelanCautionRoute(v[2])
					return
			end
		else
			InfCore.DebugPrint("this should not happen")
		end

	end
end

--this functions also need to be inside the script since the function above depends on them

--only updates caution route
this.SetSahelanCautionRoute = function( cautionRouteName)
	local gameObjectId = {type="TppSahelan2", group=0, index=0}
	local command1 = {id="SetCautionRoute", route=cautionRouteName}
	GameObject.SendCommand(gameObjectId, command1)
end

--only updates sneak route
this.SetSahelanSneakRoute = function( sneakRouteName)
	local gameObjectId = {type="TppSahelan2", group=0, index=0}
	local command1 = {id="SetSneakRoute", route=sneakRouteName}
	GameObject.SendCommand(gameObjectId, command1)
end

--updates both sneak and caution route
this.SetSahelanRoute = function( sneakRouteName, cautionRouteName )
	local gameObjectId = {type="TppSahelan2", group=0, index=0}
	local command1 = {id="SetSneakRoute", route=sneakRouteName}
	GameObject.SendCommand(gameObjectId, command1)
end

```

###### how are Geotraps assigned to Sahelanthropus ?

>You need to know how Geotraps work and how they are created and managed on Foxkit, im not going to be explaining that here
{:.important}

First you need a dataset with the geotraps you want to use. the geotrap must have the following parameters:<br>

- GeoModuleCondition Params
	- flags: `7`
	- trapCategory:
	- trapPriority: `0`
	- enable: `true`
	- isOnce: `false`
	- isAndCheck: `true`
	- checkFuncNames: `IsPlayer`
	- execFuncNames:
	- checkCallbackDataElements: `TppTrapCheckIsPlayerCallbackDataElement`
		- funcName: `IsPlayer`

Geotrap entity Parameters:
![Make sure the Geotrap Entity is enabled](/assets/AI/images/mgs/hellgeotrap.png)

GeoModuleCondition Parameters:
![](/assets/AI/images/mgs/hellgeotrap_01.png)

TppTrapCheckIsPlayerCallbackDataElement Parameters:
![](/assets/AI/images/mgs/hellgeotrap_02.png)

Geotraps are assigned with Sahelanthropus like showed bellow:
```lua

--1st Create the table for the geotraps
this.sahelanRouteTable = {
	-- to assign the geotrap, you need to add its name + 2 routes
	-- the 1st one will be sneak route and 2nd one will be caution

	--examples:

	--this one will only update sneak route
	trap_shln_RoadToOKB0001 = { "rt_shln_SBtoOKB_s_0015", "rt_shln_Null", },

	--this one will only update caution route
	trap_shln_RoadToOKB0002 = { "rt_shln_Null", "rt_shln_SBtoOKB_c_0020", },

	--this one will update both caution and sneak routes
	trap_shln_area3010 = { "rts_shln_s_3010", "rts_shln_c_3010" },
}
```
>You cant load only 1 route on a Assigned Geotrap, it wont work, using the function i created above with `rt_shln_Null` is just a workaround for that
{:.important}

the name of the geotrap assigned on the script needs to be the name of that geotrap on the dataset
![](/assets/AI/images/mgs/hellgeotrap_03.png)

if everything is done correctly, every time the geotrap is triggered the game will update the routes with the routes assigned to the geotrap.

### `wiki:wiki/AI/mgs/mgs_hellsearchmissiles.md`

##### General Information

![Sahelanthropus Search Missile](/assets/AI/images/mgs/shln_seachmissile.png){:.thumb .right}

Search Missiles used by Sahelanthropus Hellbound have the function to patrol areas defined with Routes, they alert Sahelanthropus if the player is detected with their red laser, Sahelanthropus then heads towards that area to investigate.<br>
Search Missiles are used by Sahelanthropus after it goes from `PHASE_ALERT` to `PHASE_CAUTION` (this is controled by the .exe), Sahelanthropus will always use the closest search missile entities the player position.<br><br>
Unfortunately, the duration that search missiles are active is controlled on the .exe<br>

- Model Location
	- Main: `/Assets/tpp/mecha/mgs/Scenes/mgs0_srcm0_def.fmdl`
- Common Pack
	- Pack Name: `MISSION_COMMON_PACK.SAHELAN`
	- Location: `/Assets/tpp/pack/mission2/common/mis_com_sahelan.fpk`
- TppSearchMissilePointData
	- flag: `7`
	- Type: `0` (`normal` on foxkit)
- connectPointFile
	- Main: `/Assets/tpp/mecha/mgs/Scenes/mgs0_srcm0_def.fcnp`
- GeomSkeleton
	- Main: `/Assets/tpp/mecha/mgs/Scenes/mgs0_srcm0_def.gskl`
- FoxTargetDescription (Hitboxes)
	- Main (Target): `/Assets/tpp/parts/mecha/mgs/SrcmTargetDefense.tgt`
- General Effects
	- TailSmoke: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet02_s3.vfx`
	- BackFire1: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- MoveFireFront1: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- MoveFireBackLeft1: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- MoveFireBackRight1: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- BackFire2: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- BackFire3: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- MoveFireFront2: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- MoveFireBackLeft2: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
	- MoveFireBackRight2: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx`
- Route events
	- Edge event: `All`
	- Node event: `Stand Idle`

##### How to set up Search Missiles for Hellbound AI

In order to make Search Missiles work while using Hellbound AI, you will need routes, `TppSearchMissilePointData` entities on a dataset and of course, link the routes to the dataset entities.<br>
Lets start with the routes.

>For this you need to know how Routesets and routes work, how they are created, managed and loaded on both foxkit and in the game, im not going to explain that here.
{:.important}

###### Routes for Search Missiles

First you need to create the routes you want (the name can be whatever you want but keep in mind that you are going to need it later and please, don't use special characters on the names).<br><br>

The Search Missile will follow the route but the laser will be pointing at random directions(?).<br> The edge event must be `All` and the node event, if you want to use one, must be `Stand Idle`, you can use `Stand Idle` to make it look at an direction during a certain time defined on it. Here is an example of an route for it that covers the Power Plant main building:<br>

![The route its the yellow line](/assets/AI/images/mgs/shln_search_missile_route_example.png)

###### Dataset entity

After you have made all the routes for the search missiles, its time to create an dataset and create the entities for them, the entity that you need to use for search missiles is `TppSearchMissilePointData`.<br>

Each search missile entity can only be linked to 1 route, that means you need one `TppSearchMissilePointData` for each route you want to be used.<br>

On `TppSearchMissilePointData` transform property (`TransformEntity`), make sure that the Scale values are set to `1` (except for `w`, that one should be `0`), the rotation will not matter here and the `transform_translation` must be near the route 1st node like in the example bellow:

![The Search Missile model represents its entity transform_translation values and the route its the yellow line](/assets/AI/images/mgs/shln_searchmissile_entity_translation_example.png)

Now you must be asking yourself "why is it important that the `TransformEntity`  `transform_translation` values need to be near the route 1st node?"<br>

Well its simple, when Sahelanthropus fires the Search Missiles they don't travel to the linked route 1st node, they travel to their entity `TransformEntity` and then follow the route, unless you want the search missile to go trough walls or cliffs etc... make the `TransformEntity`  `transform_translation` values be near the 1st route node.<br>

For this example, both route 1st node and entity will share the same translation (position) values, as you can see in the 2 images bellow:

![In this example, the route 1st node contains this values on its translation (called position on Unity3d)](/assets/AI/images/mgs/shln_searchmissile_entity_translation_example_01.png)

![The entity does have the same translation values](/assets/AI/images/mgs/shln_searchmissile_entity_translation_example_02.png)

After all this is done, the only thing left to do, is link the routes with the entities.

###### Link routes with entities

Routes must be linked on the enemy subscript, the routes are declared with `missileRouteList` and then assigned with the function `SetSahelanMissileRouteList`<br>

`missileRouteList` example:
```lua
this.missileRouteList = {
	"rts_SearchMissile0000",
	"...",
}
```
`SetSahelanMissileRouteList` example:<br>
```lua
this.SetSahelanMissileRouteList = function()
	local routeList = this.missileRouteList
	local gameObjectId = {type="TppSahelan2", group=0, index=0}
	local indexNum = 0
	for k, routeName in pairs(routeList) do
		local command = {id="SetSearchMissileRouteAll", route= routeName, index=indexNum }
		GameObject.SendCommand(gameObjectId, command)
		indexNum = indexNum + 1
	end
end
```

How it works?<br>

its simple, the routes on `missileRouteList` will be linked with the entities on the dataset following their order, the 1st route on the `missileRouteList` will be linked to the 1st `TppSearchMissilePointData` on the dataset and so on.<br>

In this example i want to link the route `rt_SearchMissile_PowePlant_c_0000` with the entity `TppSearchMissilePointData0042`:

![](/assets/AI/images/mgs/shln_searchmissile_entity_translation_example_03.png)

that means that the route will need to be the 43rd on the `missileRouteList` since we want to link it to the 43rd entity on the dataset

![](/assets/AI/images/mgs/shln_searchmissile_entity_translation_example_04.png)

If everything is done correctly, the search missiles will work fine

>Use only 1 dataset to load `TppSearchMissilePointData` entities
{:.important}

### `wiki:wiki/AI/mgs/mgs_nav2_params.md`

##### Navworld / Navmesh Information
###### Navworld Generation Information

- flags: `7`
- resolution: `0.5`
- verticalThreshold: `1.5`
- doesDivideIslandWithSector: `false`
- doesHoleSimplification: `true`
- holeSimplificationConvexThreshold: `10`
- holeSimplificationObbExpandThreshold: `50`
- holeSimplificationObbToAabbThreshold: `10`
- holeSimplificationSmoothingThreshold: `10`
- isHoleSimplificationDoesNotClosePassage: `false`
- holeSimplificationReduceCount: `1`
- doesAdjustSearchSpaceToNavmesh: `false`
- doesGenerateFillNavVolumeInRadius: `true`
- roughGraphFilePath:
- roughGraphFilePtr:
- worldName: `sahelan`
- maxFileSizeInKb: `300`
- parameters: `NavxNavigableParameter`:
	- name: `Human`
	- isDefault: `true`
	- radius: `8`
	- simplificationThreshold: `8`
	- height: `25`
	- maxClimbableAngle: `89`
	- maxStepSize: `4`
	- minArea: `0.4`
- sectorSizeHorizontal: `32`
- tileSizeHorizontal: `640`
- searchSpaceBucketSizeHorizontal: `20`
- collisionAttributes: `Sahelan`
- loadFox2FileListScriptPath:

> `mafr` does not have an entity to define this params and Sahelanthropus works fine
{:.important}

###### Navmesh Information

- flags: `1`
- Path Finding Optimization
	- u4: `0`
	- u5: `0`
	- u6: `0`

##### How to change flags and Path Finding Optimization values

###### Flags

`flags` indicate what type of AI can use the Navmesh, usualy MGSV uses `1249`, that allows Soldiers and Animals to use the navmesh but it does not allow Sahelanthropus to use it.<br>

In order to allow Sahelanthropus to use an navmesh, the `flags` inside the `.nav2` need to be set to `1` <br>
Keep in mind that an .nav2 can contain hundreds of `flags` to edit <br>

While using the 010 editor nav2 template, flags can be found on:<br>
- `NAVWORLD`:
	- Entry type NAVWORLD --> world --> subsection5<br>
- `Section2Entry[0]`:
	- Section2Entry --> Subsection1Entries<br><br>

>In most cases there will be more then one Entry for `NAVWORLD`, `NAVMESH_CHUNK`, `SEGMENT_CHUNK` and `NAVWORLD_SEGMENT_GRAPH`.<br>
>On `Section2Entry` only the 1st entry contains `flags` data.<br>
{:.important}

###### Path Finding Optimization Params
I dont know much about this but Path Finding Optimization Params are important, Sahelanthropus wont walk if the right values are not set on the `.nav2` file.<br>

While using the 010 editor nav2 template, Path Finding Optimization Params can be found on:<br>
- `NAVWORLD_SEGMENT_GRAPH`:
	- Entry type NAVWORLD_SEGMENT_GRAPH --> navWorldSegmentGraph --> Subsection2

>**ONLY CHANGE** `u4`, `u5` and `u6`<br>
>Set those values to `0`
{:.important}

### `wiki:wiki/AI/mgs/mgs_rexmode.md`

##### Rex mode
![Sahelanthropus Rex Mode Art from "The Art of Metal Gear Solid V" (page 111)](/assets/AI/images/mgs/sally_art rex.png){:.thumb .right}

REX mode is the name given to the sequence where Sahelanthropus changes its pose to an pose similar to MG REX to fire its railgun.<br><br>

Rex mode is used on battle sequence 7 and it needs pequod active and firing at Sahelanthropus from an nearby position to be triggered.<br>
Sniping Points for REX mode are easy to manage. It uses `TppHidePointData` dataset entities to define REX Sniping points.

You can add REX sniping points anywhere, even on sky, but make sure there is terrain or a model with collision enabled with Sahelanthropus bellow the Sniping Point Coordinates otherwise it will fall.<br>

###### How to Manage REX sniping points

> Requires Foxkit
{:.important}

As written above, REX sniping points are managed on datasets with `TppHidePointData` entities, for this example im going to use Foxkit to add 1 more REX sniping point on Nova Braga to an already existing dataset.<br>
In this example, i want the sniping point to be on the red cross facing the airport like in the picture bellow:

![](/assets/AI/images/mgs/shlb_rexpoint_example.png)

First thing to is to open the dataset that you are using to manage the REX sniping points, if you dont have one yet, create it.<br>
After that add an `TppHidePointData`, on the Foxkit´s Entity tab, make sure the `type` is set to `Type 1` and create an Transform entity.<br>

![](/assets/AI/images/mgs/shlb_rexpoint_example_02.png)

Now with the `TppHidePointData` Transform entity created you can define the coordinates and rotation for the REX sniping point, in my case, i will place it on the end of the runway facing the airport.

![](/assets/AI/images/mgs/shlb_rexpoint_example_01.png)

>The direction of the blue arrow is the direction that Sahelanthropus will be facing
{:.important}

After you finish adding or deleting the REX sniping points, you can export the dataset and load it on the mission files, everything else will be managed by the game executable file (.exe).

>Use only one dataset to manage REX sniping points<br>
>The game will automatically chose the REX sniping point that Sahelanthropus will use, usually, it chooses one near the player where Sahelanthropus can see the player<br>
>The limit for REX sniping points is currently unknown
{:.important}

##### Rex mode (Mantis Jump Attack)

>This is managed by the routes loaded into the mission, check Dominion Route assignment page
{:.important}

### `wiki:wiki/AI/mgs/mgs_vfx.md`

##### Visual Effects List

###### TppSahelan2Parameter

List of Visual effects loaded in `GameObject -> TppSahelan2Parameter` <br>

Originally loaded in the next two files: <br>
- Hellbound AI: `/Assets/tpp/level_asset/chara/mecha/sahelan_afgn_1st.fox2` <br>
- Dominion AI: `/Assets/tpp/level_asset/chara/mecha/sahelan_afgn.fox2` <br>

Effects: <br>

- `ActiveBlade` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep03_m2.vfx` <br>
Contains Sounds: No <br>

- `BladeHit` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep06_m2.vfx` <br>
Contains Sounds: No <br>

- `BlastMissile` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepexprpg01_s2LG.vfx` <br>
Contains Sounds: Yes <br>

- `BlastSearchMissile` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expgrnd01_s2LG.vfx` <br>
Contains Sounds: Yes <br>

- `BreakExplosion` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch02_m1LG.vfx` <br>
Contains Sounds: Yes <br>

- `BrokenSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/smoke/fx_tpp_smkmchbrk02_m2LG.vfx` <br>
Contains Sounds: Yes <br>

- `DamageSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsdmgsmk01_s5.vfx` <br>
Contains Sounds: No <br>

- `DeadExplosion` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch03_m2.vfx` <br>
Contains Sounds: Yes <br>

- `DeadFloorSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk03b_m2.vfx` <br>
Contains Sounds: No <br>

- `FireFlame` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchatkfir01_m2.vfx` <br>
Contains Sounds: No <br>

- `GroundFire` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/fire/fx_tpp_firvol04b_s1.vfx` <br>
Contains Sounds: No <br>

- `MantisEffect` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/chara/fx_tpp_chamntsmk01_s0LD.vfx` <br>
Contains Sounds: No <br>

- `MantisEffectSlow` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/chara/fx_tpp_chrmntrip02_s5.vfx` <br>
Contains Sounds: No <br>

- `MissileMuzzle` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsmslmzf01_s1.vfx` <br>
Contains Sounds: No <br>

- `MushiarashiSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/dust/fx_tpp_dstsndstmviw01s_m1.vfx` <br>
Contains Sounds: No <br>

- `PileBunkerStick` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01s_s5.vfx` <br>
Contains Sounds: No <br>

- `RailGunFire` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepbltrgn01_m1.vfx` <br>
Contains Sounds: No <br>

- `Search` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrc01_m5.vfx` <br>
Contains Sounds: No <br>

- `SwordPreEffect` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk03_s5.vfx` <br>
Contains Sounds: No <br>

- `SwordStick` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk02_s5.vfx` <br>
Contains Sounds: No <br>

- `SwordSwing` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01_s5.vfx` <br>
Contains Sounds: No <br>

- `SwordSwingNew` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsatk01c_s5.vfx` <br>
Contains Sounds: No <br>

- `TestRailGunReady` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgmstncrg01_s3.vfx` <br>
Contains Sounds: No <br>

>Some of this Effects are exlusive to either Hellbound or Dominion AI modes<br>
{:.important}

###### Parts File

List of Visual effects loaded in `/Assets/tpp/parts/mecha/mgs/mgs0_main0_def.parts` <br>

Effects: <br>

- `BladeLaunchFinishR / BladeLaunchFinishL` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep02_m1.vfx` <br>
Effect Variation Name: `Finish` <br>
Contains Sounds: No <br>

- `BladeLaunchL / BladeLaunchR` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep02_m1.vfx` <br>
Contains Sounds: No <br>

- `Break(BodyPart)` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsbrk01_s5.vfx` <br>
Contains Sounds: No <br>

- `DamageSmokeHead` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsdmgsmk01_s5.vfx` <br>
Contains Sounds: No <br>

- `DamageWeak` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsdmgspk01_s5.vfx` <br>
Contains Sounds: No <br>

- `EyeFlare` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/flare/fx_tpp_flrlgt20evs_m1LD.vfx` <br>
Contains Sounds: No <br>

- `EyeLamp` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgthed01_s2.vfx` <br>
Contains Sounds: No <br>

- `EyeLampSide` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgthed01_s2.vfx` <br>
Effect Variation Name: `Side` <br>
>Despite using `effectVariationName` `Side`, it looks extremely similar to `EyeLamp`<br>
{:.important}

- `FinishCharge` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtldm02_m1.vfx` <br>
Contains Sounds:  <br>

- `fx_tpp_expgrnd01_s2LG` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expgrnd01_s2LG.vfx` <br>
Contains Sounds: Yes <br>

- `fx_tpp_expmch01_m1LG` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmch01_m1LG.vfx` <br>
Contains Sounds: Yes <br>

- `HeartLight` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtwst01_s6.vfx` <br>
Contains Sounds: No <br>

- `HeartLightWeak` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtwst01_s6.vfx` <br>
Contains Sounds: No <br>
Effect Variation Name: `Weak` <br>

- `MgsFootSmokeM` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk02_m1.vfx` <br>
Contains Sounds: No <br>

- `MgsFootSmokeS` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk01_s5.vfx` <br>
Contains Sounds: No <br>

- `MgsJumpSmokeM` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk03_m2.vfx` <br>
Contains Sounds: No <br>

- `MgsJumpSmokeS` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk04_m1.vfx` <br>
Contains Sounds: No <br>

- `MgsStomp` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsfotsmk09_m1.vfx` <br>
Contains Sounds: No <br>

- `MuzzleFlashR / MuzzleFlashL` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/muzzle/fx_tpp_mzfhli_s0FG.vfx` <br>
Effect Variation Name: `Mgs` <br>
Contains Sounds: No <br>

- `MuzzleLamp` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtmzf01_s0.vfx` <br>
Contains Sounds: No <br>

- `PositionLightBlue` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/flare/fx_tpp_flrcom00_s0LG.vfx` <br>
Effect Variation Name: `MechaPositionLightBlue` <br>
Contains Sounds: No <br>

- `PositionLightRed` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/flare/fx_tpp_flrcom00_s0LG.vfx` <br>
Effect Variation Name: `MechaPositionLightRed` <br>
Contains Sounds: No <br>

- `RailCharge` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepltbrgn01_m1.vfx` <br>
Contains Sounds: No <br>

- `Seeker` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgslgtldm01_m1.vfx` <br>
Contains Sounds: No <br>

- `SparkActive` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepltb04_s0.vfx` <br>
Contains Sounds: No <br>

###### "Middle Missile" parts file

List of Visual effects loaded in `/Assets/tpp/parts/mecha/mgs/mgs0_miss0_def.parts` <br>

Effects: <br>

- `Active` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepexprpg01_s2LG.vfx` <br>
Contains Sounds: Yes <br>

- `TailSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsmsljet01_s1.vfx` <br>
Contains Sounds: No <br>

###### "Small Missile" parts file

List of Visual effects loaded in `/Assets/tpp/parts/mecha/mgs/mgs0_miss1_def.parts` <br>

Effects: <br>

- `Active` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/weapon/fx_tpp_wepgreexp01_s2LG.vfx` <br>
Contains Sounds: Yes <br>

- `TailSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsmsljet01_s1.vfx` <br>
Contains Sounds: No <br>

###### "Large Missile" parts file

List of Visual effects loaded in `/Assets/tpp/parts/mecha/mgs/mgs0_miss2_def.parts` <br>

Effects: <br>

- `Active` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/explosion/fx_tpp_expmot00_s8LG.vfx` <br>
Contains Sounds: Yes <br>

- `TailSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgsmsljet01_s1.vfx` <br>
Effect Variation Name: `Large` <br>
Contains Sounds: No <br>

###### "Search Missile" parts file

List of Visual effects loaded in `/Assets/tpp/parts/mecha/mgs/mgs0_srcm0_def_v00.parts` <br>

Effects: <br>

- `BackFire` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx` <br>
Contains Sounds: No <br>

- `MoveFire` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet01_s1.vfx` <br>
Effect Variation Name: `Small` <br>
Contains Sounds: No <br>

- `TailSmoke` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgssrcjet02_s3.vfx` <br>
Contains Sounds: No <br>

###### "Blade" parts file

List of Visual effects loaded in `/Assets/tpp/parts/mecha/mgs/mgs0_msbl0_def.parts` <br>

Effects: <br>

- `Active` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep01_l1.vfx` <br>
Contains Sounds: No <br>

- `ActiveBlade` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep03_m2.vfx` <br>
Contains Sounds: No <br>

- `BladeFinish` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep08_l1.vfx` <br>
????? <br>

- `BladeLaunch` <br>
Vfx path: `/Assets/tpp/effect/vfx_data/mecha/fx_tpp_mchmgswep05_l1.vfx` <br>
Contains Sounds: No <br>

###### Changing the colors of VFX

Some vfx files can have their colors edited by unpacking the .vfx file with [VfxTool](https://github.com/youarebritish/VfxTool) and editing the RBGA values inside the nodes called `FxColorVectorNode`. <br><br>

X = R <br>
Y = G <br>
Z = B <br>
W = Alpha <br><br>

The values are not the traditional 0-255, they are 0-1 instead, you can convert the regular 0-255 values to 0-1 by dividing each color channel value by 255. <br><br>

### `wiki:wiki/Create_a_Custom_Mission.md`

This guide will help you create an empty working mission.  The mission should be packed using [MakeBite](https://www.nexusmods.com/metalgearsolidvtpp/mods/106) (see [this tutorial](/SnakeBite_Mod_Manager/#makebite) on how to use MakeBite).

For a **ready-to-use template** of everything explained on this page download the following zip, which can be used as a base to make any mission.

#### Creating the Mod Folder

There are two main folders for each custom mission, Assets and GameDir (Game Directory).

![Mod Folder Example](/assets/Create_Custom_Mission/Main_Mod_Folders.png)

##### GameDir folder Setup

GameDir will have `lua` files that will act as the heart of our mission, it will add the mission's core "area" pack. In order to support [Infinite Heaven](https://www.nexusmods.com/metalgearsolidvtpp/mods/45) we need to set that lua file in a specific path.

![External Lua Path](/assets/Create_Custom_Mission/GameDir_Path.png)

###### Lua file contents
This is as basic as an external lua can get, below the code, will check what each variable do.

```lua
local this = {}
    this.missionCode = 13000
    this.location = "AFGH"
    this.hideMission = false

    this.packs = function(missionCode)
        --Common packs:
        TppPackList.AddLocationCommonScriptPack(missionCode)
        TppPackList.AddLocationCommonMissionAreaPack(missionCode)

        --Mission pack (has to be last):
        TppPackList.AddMissionPack"/Assets/tpp/pack/mission2/custom_story/FPK_Name_Example.fpk"--The mission's core "area" pack
    end

    this.enableOOB = true --Enable out of bounds system (innerZone, outerZone, hotZone)
    this.missionMapParams={
        --Normal mission area zones as they appear on the iDroid
        --The actual in-game check traps are in .trap files.
        missionArea2 = {
            --Leaving the innerZone will only warn the player that they're leaving
            {
                name="trig_innerZone",
                vertices =
                {
                    Vector3(-58.000,315.000,1764.000),
                    Vector3(-238.000,321.000,2445.000),
                    Vector3(768.000,289.000,2486.000),
                    Vector3(653.000,353.000,1824.000),

                }
            }
            --Leaving the outerZone will actually trigger the mission clear/abort
            --Commented out as it will be be displayed alongside the innerZone otherwise
            --[[
            {
				name="trig_outerZone",
            	--.trap only:
				--minY=-213.1406,maxY=1299.037,
                vertices =
                {
                    Vector3(-58.000,315.000,1764.000),
                    Vector3(-238.000,321.000,2445.000),
                    Vector3(768.000,289.000,2486.000),
                    Vector3(653.000,353.000,1824.000),

                }
			},
			]]
        },
		--Hot zone as it appears on the iDroid
        safetyArea2 = {
			{
				name="trig_hotZone",
				vertices =
				{
                    Vector3(-58.000,315.000,1764.000),
                    Vector3(-238.000,321.000,2445.000),
                    Vector3(768.000,289.000,2486.000),
                    Vector3(653.000,353.000,1824.000),

				},
			},
		},
        missionStartPoint = {
            point = Vector3(418.33,278.22,2261.37),
		},
        heliLandPoint = {
    		{
                point=Vector3(418.33,278.22,2261.37),startPoint=Vector3(418.33,278.22,2261.37),routeId="lz_drp_field_I0000|rt_drp_field_I_0000"
            },
            {
                point=Vector3(141.47,275.51,2353.44),startPoint=Vector3(141.47,275.51,2353.44),routeId="lz_drp_fieldWest_S0000|rt_drp_fiieldWest_S_0000"
            },

		},
        -- Sortie/mission prep screen feature flags
        heliSpaceFlags = {
    		SkipMissionPreparetion = false,   --No sortie prep, like vanilla Mother Base.
    		NoBuddyMenuFromMissionPreparetion = false,    -- No buddy select in the sortie
   			NoVehicleMenuFromMissionPreparetion = false,    -- No vehicle select in the sortie
    		DisableSelectSortieTimeFromMissionPreparetion = false,    -- Only ASAP as deployment time option
  		},
    }

return this
```

###### missionCode

MissionCodes or missionIds are used in MGSV to identify missions in .lua and file names. Main missions fall into 6 main categories in 10k ranges.

    Story: 10k
    Extra: 20k
    Free: 30k
    Heli: 40k
    Online: 50k
    Shows/Select: 60k

The missionCode is seemingly stored as an unsigned short integer, so it runs out at its max value. Hard story missions (extreme, total stealth, subsistence) have a mission code 1k higher than the original mission.

> **Note for mission authors:** Due to how the engine uses missionCodes must be unique for each mission. So if you are creating missions you should make sure you don't conflict with existing ones, and update [this page](/Custom_Missions_List) with the ids you intend to use.

Detailed information about [missionCode](/MissionCodes/)

###### location

A string value location that is a part of the system that represents a map/playspace. For agiven location there may be one or more Missions.

See also [Custom Locations List](/Custom_Locations_List/)

Detailed information about [Locations](/Locations/)

###### hideMission

A boolean value that makes the mission hidden if set to `true`, it can be later opened using `TppStory.SetMissionOpenFlag`. Below is a full example of a module that opens a hidden custom mission.

It checks if that mission with the Uniqe missionCode `13105` has been cleared, if so open the other mission with the missionCode `13106`
```lua
local this = {}

function this.Init(missionTable)
	if TppMission.IsFOBMission(vars.missionCode) then
		return
	end

    if TppStory.IsMissionCleard(13105) then
		TppStory.SetMissionOpenFlag(13106,true)
    else
        TppStory.SetMissionOpenFlag(13106,false)
	end
end

return this
```

Main Vanilla missions can also be checked if it's clear, creating a unique story progression!

###### `this.packs = function(missionCode)`

This function will contain the packs that will be added for the mission.

This is as basic as it can get
```lua
this.packs = function(missionCode)
    --Common packs:
    TppPackList.AddLocationCommonScriptPack(missionCode)--[locationName]_script.fpk
    TppPackList.AddLocationCommonMissionAreaPack(missionCode)--enemies, heli, decoys, etc.

    --Mission pack (has to be last):
    TppPackList.AddMissionPack"/Assets/tpp/pack/mission2/custom_story/FPK_Name_Example.fpk"--The mission's core "area" pack
end
```

###### enableOOB
A boolean value that will enable out of bounds system (innerZone, outerZone, hotZone).

###### missionMapParams

A table that containts other tables that will have information about differnant things like the mission area, mission start point and heli land points.

###### missionArea2
Normal mission area zones as they appear on the iDroid, the actual in-game check traps are in a `.trap` file. Leaving it will **only warn** the player that they're leaving.

More info about [.trap](/TRAP/).

**You can get the coordinates using Infinite heaven by holding the Call Button and the Stance button.**

```lua
 missionArea2 = {
     {
        name="trig_innerZone",
        vertices =
        {
            Vector3(-58.000,315.000,1764.000),
            Vector3(-238.000,321.000,2445.000),
            Vector3(768.000,289.000,2486.000),
            Vector3(653.000,353.000,1824.000),
        }
    }
     --Leaving the outerZone will actually trigger the mission clear/abort
     --Commented out as it will be be displayed alongside the innerZone otherwise
     --[[
     {
		name="trig_outerZone",
         vertices =
         {
            Vector3(-58.000,315.000,1764.000),
            Vector3(-238.000,321.000,2445.000),
            Vector3(768.000,289.000,2486.000),
            Vector3(653.000,353.000,1824.000),
         }
	},
	]]
 },
```

###### safetyArea2
Hot zone as it appears on the iDroid. Remember that this only affects it visually.

**You can get the coordinates using Infinite heaven by holding the Call Button and the Stance button.**

```lua
safetyArea2 = {
	{
		name="trig_hotZone",
		vertices =
		{
            Vector3(-58.000,315.000,1764.000),
            Vector3(-238.000,321.000,2445.000),
            Vector3(768.000,289.000,2486.000),
            Vector3(653.000,353.000,1824.000),
		},
	},
},
```

###### missionStartPoint
It sets where the player spawns if in `Infinite Heaven`, the option to start missions on foot is enabled. It it can take a single `Vector3`.

```lua
missionStartPoint = {
    point = Vector3(141.47,275.51,2353.44),
},
```

###### heliLandPoint
The landing zones that the player can select from the Idroid while in the ACC.

```lua
heliLandPoint = {
	{
        point=Vector3(418.33,278.22,2261.37),startPoint=Vector3(418.33,278.22,2261.37),routeId="lz_drp_field_I0000|rt_drp_field_I_0000"
    },
    {
        point=Vector3(141.47,275.51,2353.44),startPoint=Vector3(141.47,275.51,2353.44),routeId="lz_drp_fieldWest_S0000|rt_drp_fiieldWest_S_
    },
},
```

###### heliSpaceFlags
Sortie/mission prep screen feature flags

```lua
heliSpaceFlags = {
	SkipMissionPreparetion = false,   --No sortie prep, like vanilla Mother Base.
	NoBuddyMenuFromMissionPreparetion = false,    -- No buddy select in the sortie
	NoVehicleMenuFromMissionPreparetion = false,    -- No vehicle select in the sortie
	DisableSelectSortieTimeFromMissionPreparetion = false,    -- Only ASAP as deployment time option
},
```

And that's everything you need to make it work, there are of course tons of other options that you can do. For example setting the `GMP Reward` when the mission is completed, or even how many` Mission Tasks` the mission has, but that of course needs extra steps.

```lua
missionGuaranteeGMP=600000,
```

##### Assets Folder

Assets folder contains... the mission's assets, mainly the `fpk`, and it's pair, the `fpkd`.
if you notice in the `this.packs = function(missionCode)` function, there was something called the `The mission's core "area" pack`.

First will create this, you can set any path you want, but it is recommened to set it in this path `/Assets/tpp/pack/mission2/custom_story/`.
**Note: MakeBite will automaticlly repack any _fpk and _fpkd folders as .fpk and .fpkd, and will overwrite any existing ones**.
![Example](/assets/Create_Custom_Mission/Mission_Core_Pack_Path_Example.png)

The path written in `TppPackList.AddMissionPack` must  match what's in the Assets folder.
So with the example we have above, it *MUST* look like this:
```lua
TppPackList.AddMissionPack"/Assets/tpp/pack/mission2/custom_story/FPK_Name_Example.fpk"
```

###### fpk
The `_fpk` folder  will contain assets, like models, the routes that the GameObjectLocators will take... etc.

###### fpkd
The `_fpkd` folder  will contain data, like fox2, effects and lua files that will controll everything with mission.
More info about that can be found in [Mission Objectives](/Mission_Objectives/) and [Mission Table Subscripts](/Mission_Table_Subscripts/) wiki pages.

### `wiki:wiki/Creating_a_basic_custom_route.md`

This covers the very basics of using the Route Builder in FoxKit,
allowing you to make a basic route that will make a soldier move between
two set points repeatedly. It will not cover opening FoxKit in Unity, or
using source control to access FoxKit. For both of those topics there
are many other tutorials online. It will also not cover creating .mgsv
files in Makebite, or installing them with Snakebite. So proceed under
the assumption that you know how to do those things. In order to create
routes you will need the following tools:

  - [Unity
    Version 2018.3.6f1](https://unity3d.com/get-unity/download/archive)
  - [FoxKit](https://github.com/youarebritish/FoxKit) (Clone the source)
  - [Side Op
    Companion](https://www.nexusmods.com/metalgearsolidvtpp/mods/571)
    (Also install the Infinite Heaven Quick Menu preset that comes with
    this)

The first thing you want to do is launch the game and head to the
location that you want to make a side op in. Once you are there hold
down the call button and press Up on the keyboard to set all of the
enemy soldiers to friendly. Next you will travel to the nearest outpost
or area with enemy troops. Place a marker on one of them and hold the
call button again. This time press Down and the screen will print the
soldier's name, and the nearest CP. Take note of the CP name.
![](/assets/20200423202203%201.jpg){:.thumb width="839px"}

Once you have that information you can proceed to where you would like
to place your route. Navigate to the exact point you would like your
route to begin and face the direction you would like the soldier to be
facing at the beginning of the route. Hold down the Call key and press
the Crouch key. This will print the coordinates of you location and
orientation to ih_log.txt. That file is located in a folder named "mod"
that can be found in the main MGS_TPP folder. Repeat this step for the
second point of your route. You can now exit MGSV.

Open up ih_log.txt in your text editor of choice. Scroll to the bottom
to find some important pieces of information. The first is a line that
contains the quest area you were in when you took your coordinates. Next
to that it will say if it is an acceptable location to place a side op.
Below that information are the coordinates that you took.
![](/assets/Notepad.png){:.thumb width="834px"}

Keep this information open, as you will need it for the remaining steps.
Open up FoxKit in Unity, this may take a moment the first time you open
it. Right click in the hierarchy area. In the menu that appears select
FoxKit -\> Route Set.
![](/assets/Unity1.png){:.thumb width="551px"}

This will create a new game object, as well as open an area where you
can begin to edit your new route. Click the button to create a new route
within your route set. This will create a child object that contains the
route, and the first node for the route nested within it.
![](/assets/Unity2.png){:.thumb width="612px"}

Click on the first node. With the first node open you are able to edit
the coordinates of it under the Local Transform option. Paste in the
first set of coordinates that you took here. IMPORTANT - The X
coordinate should always have the opposite positive or negative value as
the coordinate that you took. So if your taken X coordinate is 100, then
you would enter -100 in Unity. If your taken coordinate is -100, then
you would enter 100 in Unity.
![](/assets/Unity3.png){:.thumb width="572px"}

Once the first value is set, click on the button to create a new node.
![](/assets/Unity4.png){:.thumb width="569px"}

With the new node created and selected, enter the values for the second
set of coordinates that you took. Remember to flip the positive or
negative on the X coordinate.
![](/assets/Unity5.png){:.thumb width="567px"}

Once both coordinates are placed, click on the Parent Route set object
in the Hierarchy, and then click on the button to save your route to a
.frt file. Save it to the Route Assets folder in the SOC Assets folder
that gets installed with SOC.
![](/assets/Unity7.png){:.thumb width="610px"}

Open up SOC to create a new sideop. Enter in a file name for it, an
unique Quest Number for it, set the location to the map the route is
meant for, place coordinates for the general area that the route is in
and then choose the correct Quest Area (found in ih_log.txt), the
correct Quest CP (this was found from the tagged soldier in game) and
then select your route file. Fill Radius, Quest Category, and Rank to
whatever you wish. ![](/assets/SOC1.png){:.thumb width="540px"}

Fill out the Flavor text fields and then press the button to proceed to
the next part of SOC. ![](/assets/SOC2.png){:.thumb width="804px"}

Spawn a sol_quest enemy, assign him to your custom route and then press
the button to build your side op.

In order for your custom route's name to appear in the 'Sneak Route' and
'Caution Route' drop down menu, you will need to add it to SOC's route
dictionary, otherwise it will appear as a string of numbers, as below:
![](/assets/SOC3.png){:.thumb .legacy-small width="372px"}

You will need to copy the name of your route, in this example the route
is called **rt_RouteSet_c_0000** and paste it in to the
**route_name_dictionary.txt** file located in your SideOp Companion
folder. The file path for this will be: SideOp Companion
\[folder\]\\SOCassets\\ToolAssets\\**route_name_dictionary**

Once you have saved this text file the names of your created routes will
appear as you named them in Fox Kit when building your SideOp

Once built, create the .mgsv file from the SideOp Build folder that SOC
creates, and then install it. Run the game and go to your custom side op
to see the fruits of your labor\!
![](/assets/Game.png){:.thumb width="832px"}

### `wiki:wiki/Custom_Locations_List.md`

Custom / Addon Locations for Metal Gear Solid V: The Phantom Pain.

See [Locations](/Locations) for vanilla locationIds. [Infinite Heaven](/Infinite_Heaven) is required to add them to the game, and requires a Mission set in the location to use them.

> **Note for location authors:** Due to how the engine uses locationId must be unique for each mission. So if you are creating locations you should make sure you don't conflict with existing ones, and update this page with the ids you intend to use.

| locationCode | locationName | Author               | Name / Link
| ------------ | ------------ | -------------------- | ----------------------------------------------------- |
| 40           | gntn         | KJP,caplagrobin      | [US Naval Prison Facility](https://www.nexusmods.com/metalgearsolidvtpp/mods/978)
| 62           | dese         | Ventos               | [Desert Base](https://www.nexusmods.com/metalgearsolidvtpp/mods/1237)
| 101          | afc0         | KJPLA,tinmantex      | [Jade Forest](https://www.nexusmods.com/metalgearsolidvtpp/mods/1239)
| 102          | afn0         | KJPLA,tinmantex      | [Red Fortress](https://www.nexusmods.com/metalgearsolidvtpp/mods/1271)
| 103          | afda         | KJPLA,tinmantex      | [Gray Rampart](https://www.nexusmods.com/metalgearsolidvtpp/mods/1251)
| 104          | afc1         | KJPLA,tinmantex      | [Amber Station](https://www.nexusmods.com/metalgearsolidvtpp/mods/1246)
| 105          |              |                      | mgo maps
| 111-115      |              |                      | mgo dlc maps
| 120          | smpl         | caplagrobin          | Sample empty map
| 139          | UNSA         | retali8              | [Test Area for NPCs](https://github.com/TheHuntingParty/TPP-sahelanthropus) / [Vehicles](https://www.nexusmods.com/metalgearsolidvtpp/mods/1750)
| 140          | EXPL         | retali8              | [expl sample map](https://github.com/TheHuntingParty/EXPL-MAP-TPP)
| 141          | SHDV         | retali8              | [Empty Black dome](https://github.com/TheHuntingParty/Tpp_Shln_BossEvents)

### `wiki:wiki/Custom_Missions_List.md`

Custom / Addon Missions for Metal Gear Solid V: The Phantom Pain.

See [MissionCodes](/MissionCodes#sequence-mission-codes) for vanilla missionCodes. [Infinite Heaven](/Infinite_Heaven) is required to add them to the game.

> **Note for mission authors:** Due to how the engine uses missionCodes must be unique for each mission. So if you are creating missions you should make sure you don't conflict with existing ones, and update this page with the ids you intend to use.

| missionCode | Location | Author          | Name / Link
| ----------- | -------- | --------------- | --------------------------------------------------------------------------- |
| N/A         | afgh     | Ventos          | [Small Ruins](https://www.nexusmods.com/metalgearsolidvtpp/mods/753)
| N/A         | afgh     | Ventos          | [Unknown Place](https://www.nexusmods.com/metalgearsolidvtpp/mods/1237)
| 13000       | mafr     | CapLagRobin     | [TGS 2014 SPECIAL MISSION](https://www.nexusmods.com/metalgearsolidvtpp/mods/918)
| 13001       | afgh     | CapLagRobin     | [The Phantom Pain (E3 Version)](https://www.nexusmods.com/metalgearsolidvtpp/mods/1245)
| 13002       | mafr     | CapLagRobin     | [Secure the Hidden Tape](https://www.nexusmods.com/metalgearsolidvtpp/mods/1665)
| 13005       | afgh     | Ventos          | [Yellow Asset](https://www.nexusmods.com/metalgearsolidvtpp/mods/929)
| 13050       | shdv     | retali8         | [Sahelanthropus test mission](https://github.com/TheHuntingParty/Tpp_Shln_BossEvents)
| 13100       | afgh     | Yazed0071       | [Secure the hidden tape (yet again)](https://www.nexusmods.com/metalgearsolidvtpp/mods/1888)
| 13101       | mafr     | Yazed0071       | [Nuclear Network](https://www.nexusmods.com/metalgearsolidvtpp/mods/1783)
| 13102       | mafr     | Yazed0071       | [Whispers](https://www.nexusmods.com/metalgearsolidvtpp/mods/1820)
| 13103       | gntn     | Yazed0071       | [SECURE THE CLASSIFIED TAPE](https://www.nexusmods.com/metalgearsolidvtpp/mods/1836)
| 13104       | gntn     | Yazed0071       | [[SUBSISTENCE] SECURE THE CLASSIFIED TAPE](https://www.nexusmods.com/metalgearsolidvtpp/mods/1836)
| 13500       | UNSA     | retali8         | [expl map](https://github.com/TheHuntingParty/EXPL-MAP-TPP) / [MG - Sahe test area](https://github.com/TheHuntingParty/TPP-sahelanthropus) / [Sahe Demo](https://www.nexusmods.com/metalgearsolidvtpp/mods/1750)
| 30040       | gntn     | KJP,caplagrobin | [US Naval Prison Facility](https://www.nexusmods.com/metalgearsolidvtpp/mods/978)
| 30062       | dese     | Ventos          | [Desert Base Free Roam](https://www.nexusmods.com/metalgearsolidvtpp/mods/1237)
| 33001       | afc0     | KJPLA,tinmantex | [Jade Forest Free Roam](https://www.nexusmods.com/metalgearsolidvtpp/mods/1239)
| 33002       | afn0     | KJPLA,tinmantex | [Red Fortress Free Roam](https://www.nexusmods.com/metalgearsolidvtpp/mods/1271)
| 33003       | afda     | KJPLA,tinmantex | [Gray Rampart Free Roam](https://www.nexusmods.com/metalgearsolidvtpp/mods/1251)
| 33004       | afc1     | KJPLA,tinmantex | [Amber Station Free Roam](https://www.nexusmods.com/metalgearsolidvtpp/mods/1246)

### `wiki:wiki/Custom_Side-Ops_List.md`

Custom / Addon Side-Ops / Quests created for Metal Gear Solid V: The Phantom Pain.

See [MissionCodes](/MissionCodes#side-op-ids) for vanilla questIds. [Infinite Heaven](/Infinite_Heaven) is required to add custom side-ops to the game.

> **Note for side-op authors:** Due to how the engine uses questIds must be unique for each sideop. So if you are creating sideops you should make sure you don't conflict with existing ones, and update this page with the ids you intend to use.
>
> A table [at the bottom](#side-ops-with-conflicting-ids) lists side-ops with conflicting IDs.

| questId                    | Author          | Location    | Total ops | Name / Link
| -------------------------- | --------------- | ----------- | :-------: | --------------------------------------------------------------------------- |
| q30100-q30102              | tinmantex       | mtbs        | 3         | [MB Animals](https://www.nexusmods.com/metalgearsolidvtpp/mods/45)
| q30103                     | tinmantex       |             | 1         | IH sideop addon example
| q30104-q30153              | morbidslinky    |             | 50        | [Sideops Expansion Pack](https://www.nexusmods.com/metalgearsolidvtpp/mods/464)
| q30154                     | morbidslinky    |             | 1         | Reserved
| q30155                     | tinmantex       | mafr        | 1         | Blackfoot Down
| q30156-q30199              | darkhaven       |             | 43        | Reserved
| q30200                     | tinmantex       | gntn        | 1         | [gntn sideop test](https://www.nexusmods.com/metalgearsolidvtpp/mods/45)
| q30201-q30202              | tinmantex       |             | 2         | Reserved
| q30203                     | tinmantex       | afc0        | 1         | [Jade Forest Rescue](https://www.nexusmods.com/metalgearsolidvtpp/mods/1239)
| q30204                     | tinmantex       | afc1        | 1         | [Amber Station Rescue](https://www.nexusmods.com/metalgearsolidvtpp/mods/1246)
| q30205                     | tinmantex       | afda        | 1         | [Gray Rampart Rescue](https://www.nexusmods.com/metalgearsolidvtpp/mods/1251)
| q30206-q30209              | tinmantex       |             | 4         | Reserved
| q30210                     | tinmantex       | mtbs        | 1         | [Medical Pln2 Shooting Practice](https://www.nexusmods.com/metalgearsolidvtpp/mods/45)
| q30211-q30299              | tinmantex       |             | 88        | Reserved
| q30300-q30304              | CapLagRobin     | afgh, mafr  | 5         | [Side Op Demo Tape](https://www.nexusmods.com/metalgearsolidvtpp/mods/650)
| q30305                     | CapLagRobin     |             | 1         | [LA Ops - SABOTAGE](https://www.nexusmods.com/metalgearsolidvtpp/mods/1781)
| q30306-q30311              | CapLagRobin     | mafr, afgh  | 6         | [Side Op Demo Tape](https://www.nexusmods.com/metalgearsolidvtpp/mods/650)
| q30312                     | CapLagRobin     | mafr        | 1         | [Prisoner Extraction 7780](https://www.nexusmods.com/metalgearsolidvtpp/mods/725)
| q30313-q30314              | CapLagRobin     | mafr, afgh  | 2         | [Side Op Demo Tape](https://www.nexusmods.com/metalgearsolidvtpp/mods/650)
| q30315                     | CapLagRobin     |             | 1         | [LA Ops - COMM CONTROL](https://www.nexusmods.com/metalgearsolidvtpp/mods/1781)
| q30316-q30317              | CapLagRobin     | afgh        | 2         | [XOF Ops 1-2 ](https://www.nexusmods.com/metalgearsolidvtpp/mods/718)
| q30318                     | CapLagRobin     |             | 1         | Reserved
| q30319-q30320              | CapLagRobin     | mafr, afgh  | 2         | [XOF Ops 3-4](https://www.nexusmods.com/metalgearsolidvtpp/mods/718)
| q30321                     | CapLagRobin     |             | 1         | Reserved
| q30322                     | CapLagRobin     | mafr        | 1         | [XOF Ops 5](https://www.nexusmods.com/metalgearsolidvtpp/mods/718)
| q30323                     | CapLagRobin     |             | 1         | Reserved
| q30324                     | CapLagRobin     | mafr        | 1         | [PW Rescue](https://www.nexusmods.com/metalgearsolidvtpp/mods/824)
| q30325-q30330              | CapLagRobin     | afgh        | 5         | [\[REVENGE\] Supply Demolition 01-05](https://www.nexusmods.com/metalgearsolidvtpp/mods/1357)
| q30331-q30333              | CapLagRobin     | mafr, afgh  | 3         | [XOF Ops 6-8](https://www.nexusmods.com/metalgearsolidvtpp/mods/718)
| q30334-q30336              | CapLagRobin     | mtbs        | 3         | [Driver's Ed](https://www.nexusmods.com/metalgearsolidvtpp/mods/1434)
| q30337-q30339              | CapLagRobin     | ssav        | 3         | [Forsaken Ruins](https://www.nexusmods.com/metalgearsolidvtpp/mods/1618)
| q30340-q30349              | CapLagRobin     | gntn        | 10        | [U.S. Naval Prison Facility (00)](https://www.nexusmods.com/metalgearsolidvtpp/mods/978)
| q30350-q30359              | morbidslinky    |             | 10        | [Sideops companion examples](https://www.nexusmods.com/metalgearsolidvtpp/mods/571) (Only as SOC XML)
| q30400-q30409              | CountFuzzball   |             | 10        | [Motherbase Recruitment Drive](https://www.nexusmods.com/metalgearsolidvtpp/mods/940)
| q30410                     | CountFuzzball   |             | 1         | [Ez Gunsmiths](https://www.nexusmods.com/metalgearsolidvtpp/mods/940)
| q30411-q30449              | CountFuzzball   |             |           | Reserved
| q30450-q30499              | Your401kPlan    |             |           | Reserved
| q30500-q30509              | hsronacse       |             |           | Reserved
| q30510-q30599              | Mekehl          |             | 2         | [Reserved](https://www.nexusmods.com/users/126198548?tab=user+files)
| q30600-q30611              | amars464        |             | 12        | [Missions Sans Frontieres](https://www.nexusmods.com/metalgearsolidvtpp/mods/721)
| q30612                     | amars464        |             |           | Reserved
| q30613-q30620              | amars464        |             | 8         | [Skill Challenge SideOps](https://www.nexusmods.com/metalgearsolidvtpp/mods/1121)
| q30621-q30629              | amars464        |             | 6         | [Operation Extrude](https://www.nexusmods.com/metalgearsolidvtpp/mods/1190)
| q30622                     | amars464        |             |           | Reserved
| q30630-q30699              | amars464        |             |           | Reserved
| q30700-q30750              | WaffleOleg      |             | 51        | Waffle's SideOps
| q30651-q30652              | Nonebit         |             |           | Reserved
| q30753-q31068              |                 |             |           | **Free**
| q31069-q31086              | jackwall        |             | 18        | [Diamond Girls](https://www.nexusmods.com/metalgearsolidvtpp/mods/582)
| q31087-q31099              | jackwall        |             |           | Reserved
| q31100-q3102               | Adam_Online     |             | 3         | [Tales From Motherbase 1-3](https://www.nexusmods.com/metalgearsolidvtpp/mods/764)
| q31103-q31149              | Adam_Online     |             |           | Reserved
| q31150                     | Adam_Online     |             | 1         | [TFMB - Caught In The Crossfire](https://www.nexusmods.com/metalgearsolidvtpp/mods/1257)
| q31151-q31199              | Adam_Online     |             |           | Reserved
| q31200-q31211              | To4oo4/Tora     |             | 12        | [Tora's Sideop Pack 01](https://www.nexusmods.com/metalgearsolidvtpp/mods/1506/)
| q31212-q31230              | To4oo4/Tora     |             | 19        | Tora's Sideop Pack 02
| q31231-q31250              | To4oo4/Tora     |             | 20        | Tora's Sideop Pack 03
| q31251-q35600              |                 |             |           | Reserved
| q35648-q34651              | Ventos          |             | 4         | [Boss Sheep ](https://www.nexusmods.com/metalgearsolidvtpp/mods/624)
| q36660-q36677              | Ventos          |             | 12        | [Quest Sand - Side Ops](https://www.nexusmods.com/metalgearsolidvtpp/mods/643)
| q36678-q36760              | Ventos          |             |           | Reserved
| q36761                     | young_sn0w      |             | 1         | [Snow's Prisoner Rescue 01](https://www.nexusmods.com/metalgearsolidvtpp/mods/1087)
| q36770-q37209              |                 |             |           | **Free**
| q37210-q37214              | TaliKnight      |             | 5         | [Knight Heaven](https://www.nexusmods.com/metalgearsolidvtpp/mods/1219)
| q37215-q37249              | TaliKnight      |             |           | Reserved
| q37250-q39007, q39009      |                 |             |           | **Free**
| q39008                     | mgsvfan11122    |             |           | Reserved
| q39010                     | KJP / Base game |             |           | NOTE: Max questId for this block

##### Side-Ops with conflicting IDs

List of ops using previously reserved/used questId(s).

| questId                    | Author          | Location    | Total ops | Name / Link
| -------------------------- | --------------- | ----------- | :-------: | -------------------------------------------------------------------------------------------------------- |
| q30103                     | TaliKnight      |             | 1         | [Guantanamo Sheep](https://www.nexusmods.com/metalgearsolidvtpp/mods/1193)
| q30117                     | Your401kPlan    |             | 1         | [Operation R.Y.A.N Ep2](https://www.nexusmods.com/metalgearsolidvtpp/mods/1084)
| q30121                     | GekiritZ        |             | 1         | [Female Prisoner Roundup](https://www.nexusmods.com/metalgearsolidvtpp/mods/578)
| q30160                     | Your401kPlan    |             | 1         | [Operation R.Y.A.N Ep2](https://www.nexusmods.com/metalgearsolidvtpp/mods/1084)
| q30200                     | Your401kPlan    |             | 1         | [Operation R.Y.A.N](https://www.nexusmods.com/metalgearsolidvtpp/mods/1084)
| q30200-q30204              | morbidslinky    |             | 5         | [Sideops companion examples](https://www.nexusmods.com/metalgearsolidvtpp/mods/571) (Only as SOC XML)
| q30351                     | Your401kPlan    |             | 1         | [Operation R.Y.A.N Ep2](https://www.nexusmods.com/metalgearsolidvtpp/mods/1084)
| q30351-q30352              | SuperNark       |             | 2         | [Boss Operations](https://www.nexusmods.com/metalgearsolidvtpp/mods/1464)
| q30355                     | Henriquemaster  |             | 1         | [Easy farm girls](https://www.nexusmods.com/metalgearsolidvtpp/mods/576)
| q30400-q30403              | MgSolidus       |             |           | Doesn’t seem to have published them?
| q36675                     | Ventos          |             | 1         | [Nuclear Quest](https://www.nexusmods.com/metalgearsolidvtpp/mods/814)
| q36677                     | Ventos          |             | 1         | [Extract the Engineer](https://www.nexusmods.com/metalgearsolidvtpp/mods/845)

### `wiki:wiki/Custom_weapons.md`

This tutorial will show you how to import/port custom weapon models to
MGSV:TPP.

**Tools Needed:**

3ds Max

Fmdl Studio

Photoshop (or any other image editing software)

File Proliferator

Fcnp Tool

Fv2 Tool

**Skills Needed:**

Basic 3ds Max knowledge

Basic MGSV modding knowledge

##### Getting Your Model Ready in 3ds Max

Import the gun you want to port into 3ds max. and use fmdl studio to
export the gun model you want to replace as an .fbx.
![](/assets/1.jpg){:.center .thumb width="552px"} If you have your gun
model ready, import the fbx file of the original weapon and start
scaling your custom weapon so it fits the original one.
![](/assets/2.jpg){:.center .thumb width="414px"} Try to keep the area's
circled in red to somewhat match the vanilla gun, if it's not possible
no worries as this can be edited.

Now we are gonna rig the gun so moving parts actually move in-game.

Make sure no vertices on your custom model are selected and next select
all vertices on the vanilla weapon.
![](/assets/3.jpg){:.center .thumb width="404px"} Now attach the vanilla
weapon to the custom one and delete the selected vertices.

The old weapon will be deleted now and the new one is rigged, however we
still need to edit the skin weights.

Select your model and click on the skin modifier, click on edit
envelopes and also the checkbox ''vertices''.
![](/assets/4.png){:.center .thumb width="417px"} Select all the vertices
on your weapon and make sure you have select the root bone
(SKL_000_ROOT) in the skin modifier.

Then drag up the abs .effect untill the max (1.0) and the vertices all
turn red. ![](/assets/5.jpg){:.center .thumb width="415px"} Your whole
gun is rigged to the root bone now, next we will rig the moving parts.

In this case we will rig the slide first, so in the skin modifier select
the slide bone (SKL_001_SLIDE).

To make this easier also click the select element checkbox.
![](/assets/6.jpg){:.center .thumb width="319px"} Now select all the
parts of the gun that should move when the slide bone moves.

The whole element will be selected now, drag up the abs. effect again to
the max. ![](/assets/7.jpg){:.center .thumb width="411px"} The silde
should be red now as the picture above.

No continue to do this for all parts (hammer/trigger...)

If you want your weapon to have a rail system that apears/dissapears
when you select attachments do the same as with the gun itself.

Deselect all vertices on your custom model and select them all on the
vanilla one, attach them and delete the selected vertices.

The rail should be automatically rigged to the root bone.

Continue to do this if you have a model that uses multiple meshes.

Now if you have rigged the whole gun we are gonna make life easier be
already naming our meshes.

All main gun parts should be named MESH_ROOT, the rail parts
MESH_RAIL_OPTION_IV.

This is important or else the rail won't go away if you don't use
attachments. ![](/assets/8.jpg){:.center .thumb width="388px"} Now select
all objects in the scene and export them as an .fbx file, don't close
3ds Max yet.

Now you can make your textures ready for the fox engine, just as you
would normally.

Weapons use bsm/ nrm/ srm/ mtm but also special camo bsm and lbm
textures for the camo patterns you can apply ingame.

An easy way to make these camo textures is by using 3ds max viewport
canvas.

Apply the base texture to your model in 3ds max, then select all
elements that you want to have painted with camo and detach them.

Go to tools/viewport canvas and click it.
![](/assets/9.jpg){:.center .thumb width="631px"}

A panel should apear with option, set the paint color to white and click
on the brush icon.

Now you can paint your gun parts white in the viewport.
![](/assets/10.jpg){:.center .thumb width="407px"}

When you have painted all parts, click the brush icon again and save the
file as an .psd.

Now open that .psd file with photoshop and you should have an channel
with the white painted parts.

Paste the white parts over your base texture (a copy of it).
![](/assets/11.jpg){:.center .thumb width="463px"}

Now save this as your camo bsm texture.

You can edit the white parts to have more details, wear,scratches
anything.

Now paint the base texture completly black and save the result as your
camo lbm texture. ![](/assets/12.jpg){:.center .thumb width="471px"}

Now that we have all textures ready we can import the new .fbx into fmdl
studio and also import the gun you want to replace.

Drag all materials over from the vanilla to the custom one and delete
the vanilla gun.

Now this part will be a bit different then usual, in the texture part
only asign the normal map and leave the others be.
![](/assets/13.jpg){:.center .thumb width="453px"}

Make sure you have set up your fmdl parameters and export the model as
you would with any fmdl.
![](/assets/14.jpg){:.center .thumb width="389px"}

Now you need to find the specific weapons .fcnp and .fv2 files

The fcnp file should be in the same location as the .fmdl.

The .fv2 files should be assets/tpp/fova/weapon

Now drag your fcnp file onto the fcnp tool and open the xml file it
generates.

Load a attachment into fmdl studio together with your custom weapon.

Move the attachment to where you want it attached to the gun and copy
the coordinates from it into the xml file.
![](/assets/15.jpg){:.center .thumb width="383px"}
![](/assets/16.jpg){:.center .thumb width="471px"}

Now when you have all attachments done save the xml file and drag it
over the fcnp tool again.

This method will also be used to align the iron sights but this has to
be done by just trying to get the right values as you can set those in
fmdl studio.

Now open the fv2 files with the fv2 tool and edit the texture paths to
your custom textures in the external files tab.
![](/assets/17.jpg){:.center .thumb width="378px"}

Do this for all 3 the fv2 files, main is base colors/cam is for the camo
overlay/clv is for the solid color camos.

When the fv2 files are done you can use file proliferator to make your
files ready for in the game.

Be sure to also put your .ftex files in the right folder.

Make a .mgsv file with make bite and install with snake bite and test
your weapon.

I will also include a video
[here](https://www.youtube.com/watch?v=x5pYG-x6ctg) made by TrikzMe with
some help from me on how to do this, although the video doesn't cover
everything.

### `wiki:wiki/MissionCodes.md`

##### Overview

MissionCodes or missionIds are used in MGSV to identify missions in .lua
and file names. Main missions fall into 6 main categories in 10k ranges.

  - Story: 10k
  - Extra: 20k
  - Free: 30k
  - Heli: 40k
  - Online: 50k
  - Shows/Select: 60k

The missionCode is seemingly stored as an unsigned short integer, so it
runs out at its max value. Hard story missions (extreme, total stealth,
subsistence) have a mission code 1k higher than the original mission.

##### Specific mission codes

See also [Custom Missions List](/Custom_Missions_List "wikilink")

###### System mission codes

  - 1 : Init
  - 5 : Title

###### Free mission codes

  - 30010: Northern Kabul, Afghanistan
  - 30020: Angola-Zaire Border Region, Central Africa
  - 30040: U.S. Naval Prison Facility, Cuba *(only in asset_version.txt)*
  - 30050: Mother Base, Seychelles Waters
  - 30051: Mother Base MissionPackLabel "DemoStage" *(Not used as an
    actual mission code)*
  - 30150: Mother Base, Seychelles Waters - Animal Conservation Platform
  - 30250: Mother Base, Seychelles Waters - Quarantine Facility Interior

###### ACC mission codes

  - 40010: Northern Kabul, Afghanistan
  - 40020: Angola-Zaire Border Region, Central Africa
  - 40050: Mother Base, Seychelles Waters
  - 40060: Helispace *(This and the location HLSP don't exist in the
    game's data except for several mentions)*

###### Online

  - 50050: FOB
  - 50055: FOB *(Seemingly not used as an actual mission code, but used
    in the name of additional files for 50050.)*

###### Shows/Select

  - 60000 : Select
  - 64000 : LevelDesignerBlockTestStage *(only in asset_version.txt)*
  - 64001
  - 64002
  - 64003
  - 64004
  - 64005
  - 64006 : All above, ditto
  - 65020 : E3 2014, Afghanistan
  - 65030 : E3 2014, Mother Base
  - 65040 : E3 2014 *(only in asset_version.txt)*
  - 65050 : E3 2014, Mother Base *(asset_version.txt mentions UAVs)*
  - 65060 : TGS 2014, Africa
  - 65400 : E3 2014 *(only in asset_version.txt)*
  - 65401
  - 65402
  - 65404
  - 65405
  - 65406
  - 65407
  - 65408
  - 65409
  - 65410
  - 65411
  - 65412
  - 65413 : All above, ditto
  - 65414 : gamescom 2014
  - 65415 : TGS 2014, Mother Base demo
  - 65416 : TGS 2014, Mother Base demo

##### Sequence mission codes

###### The Phantom Pain main ops

From TppUIBootInit.lua \>
TppUiCommand.RegistMissionEpisodeNo(missionCode,episodeNumber)

  - 10010 : PROLOGUE: AWAKENING
  - 10020 : Episode 1 - PHANTOM LIMBS
  - 10030 : Episode 2 - DIAMOND DOGS
  - 10036 : Episode 3 - A HERO'S WAY
  - 10043 : Episode 4 - C2W
  - 10033 : Episode 5 - OVER THE FENCE
  - 10040 : Episode 6 - WHERE DO THE BEES SLEEP?
  - 10041 : Episode 7 - RED BRASS
  - 10044 : Episode 8 - OCCUPATION FORCES
  - 10054 : Episode 9 - BACKUP, BACK DOWN
  - 10052 : Episode 10 - ANGEL WITH BROKEN WINGS
  - 10050 : Episode 11 - CLOAKED IN SILENCE
  - 10070 : Episode 12 - HELLBOUND
  - 10080 : Episode 13 - PITCH DARK
  - 10086 : Episode 14 - LINGUA FRANCA
  - 10082 : Episode 15 - FOOTPRINTS OF PHANTOMS
  - 10090 : Episode 16 - TRAITORS' CARAVAN
  - 10091 : Episode 17 - RESCUE THE INTEL AGENTS
  - 10100 : Episode 18 - BLOOD RUNS DEEP
  - 10195 : Episode 19 - ON THE TRAIL
  - 10110 : Episode 20 - VOICES
  - 10121 : Episode 21 - THE WAR ECONOMY
  - 10115 : Episode 22 - RETAKE THE PLATFORM
  - 10120 : Episode 23 - THE WHITE MAMBA
  - 10085 : Episode 24 - CLOSE CONTACT
  - 10200 : Episode 25 - AIM TRUE, YE VENGEFUL
  - 10211 : Episode 26 - HUNTING DOWN
  - 10081 : Episode 27 - ROOT CAUSE
  - 10130 : Episode 28 - CODE TALKER
  - 10140 : Episode 29 - METALLIC ARCHAEA
  - 10150 : Episode 30 - SKULL FACE
  - 10151 : Episode 31 - SAHELANTHROPUS
  - 10045 : Episode 32 - TO KNOW TOO MUCH
  - 11043 : Episode 33 - \[SUBSISTENCE\] C2W
  - 11054 : Episode 34 - \[EXTREME\] BACKUP, BACK DOWN
  - 10093 : Episode 35 - CURSED LEGACY
  - 11082 : Episode 36 - \[TOTAL STEALTH\] FOOTPRINTS OF PHANTOMS
  - 11090 : Episode 37 - \[EXTREME\] TRAITORS' CARAVAN
  - 10156 : Episode 38 - EXTRAORDINARY
  - 11033 : Episode 39 - \[TOTAL STEALTH\] OVER THE FENCE
  - 11050 : Episode 40 - \[EXTREME\] CLOAKED IN SILENCE
  - 10171 : Episode 41 - PROXY WAR WITHOUT END
  - 11140 : Episode 42 - \[EXTREME\] METALLIC ARCHAEA
  - 10240 : Episode 43 - SHINING LIGHTS, EVEN IN DEATH
  - 11080 : Episode 44 - \[TOTAL STEALTH\] PITCH DARK
  - 10260 : Episode 45 - A QUIET EXIT
  - 10280 : Episode 46 - TRUTH: THE MAN WHO SOLD THE WORLD
  - 11121 : Episode 47 - \[TOTAL STEALTH\] THE WAR ECONOMY
  - 11130 : Episode 48 - \[EXTREME\] CODE TALKER
  - 11044 : Episode 49 - \[SUBSISTENCE\] OCCUPATION FORCES
  - 11151 : Episode 50 - \[EXTREME\] SAHELANTHROPUS

###### "Missing" Missions

  - 10230: - KINGDOM OF THE FLIES - *(No substantial assets exist at all
    in TPP, not even any langids) *Set in its own eponymous and also
    missing map, *FLYK*.
  - 10034: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Afghanistan. Featured *enemyBase*, *field*, *fieldhillEast* and *village*.
  - 10042: - Featured *commFacility*, *enemyBase*, *slopedTown* and *village* in Afghanistan.
  - 10046: - Featured *tent* in Afghanistan.
  - 10060: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Afghanistan.
  - 10083
  - 10084: - Featured *outland* in Middle Africa.
  - 10092
  - 10101
  - 10122
  - 10123: - Featured "fort" in Afghanistan.
  - 10145: - Featured "sovietBase" in Afghanistan.
  - 10151: - In the final game, Episode 31: SAHELANTHROPUS. In asset_version.txt's "mission" folder, featured *banana*, *flowStation*, *outland*, *savannah* and *swamp* in Africa.
  - 10152
  - 10153: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Afghanistan.
  - 10154: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Africa. Featured *lab*.
  - 10155
  - 10160: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Africa. Cassette tapes relating to the child soldiers escaping also bear this mission code in their names. Featured *flowStation*, *banana* and *outland*.
  - 10161
  - 10162: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Africa. Featured *savannah*.
  - 10163
  - 10164: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Afghanistan.
  - 10165: - Featured *tent* in Afghanistan.
  - 10170: - Featured *diamond*, *diamondSouth*, *hill*, *hillNorth* and *swamp* in Africa.
  - 10180
  - 10181
  - 10182: - Featured *citadel* in Afghanistan.
  - 10190: - Cassette tapes relating to Huey's exile bear this mission
    code in their names.
  - 10191: - Featured *outland* and *pfCamp* in Africa.
  - 10192
  - 10193
  - 10194: - Featured *enemyBase* in Afghanistan.
  - 10198
  - 10199: - TppDefine.LOCATION_HAVE_MISSION_LIST sets it in Afghanistan. Featured *fort*.
  - 10201: - Featured *banana* and *savannah* in Africa.
  - 10203
  - 10204
  - 10205
  - 10206
  - 10207
  - 10208
  - 10210: - Featured *hill* in Africa.
  - 10220
  - 10250
  - 10270
  - 10290
  - 10300
  - 10310

###### "Missing" Replay Missions

  - 11041: - \[EXTREME\] RED BRASS *(No actual UI title exists.
    Launching the mission via Infinite Heaven works. This applies to
    almost all of the following missing number Extreme missions.)*
  - 11085: - \[EXTREME\] CLOSE CONTACT
  - 11036: - \[EXTREME\] A HERO'S WAY
  - 11091: - \[EXTREME\] RESCUE THE INTEL AGENTS
  - 11195: - \[EXTREME\] ON THE TRAIL
  - 11211: - \[EXTREME\] HUNTING DOWN
  - 11200: - \[EXTREME\] AIM TRUE, YE VENGEFUL
  - 11171: - \[EXTREME\] PROXY WAR WITHOUT END
  - 11115: - \[EXTREME\] RETAKE THE PLATFORM *(Unlike the other missing
    number Extreme missions, is broken - spawns no enemies, among other
    bugs. Caused by the lack of a mention in a function in TppPackList)*
  - 11052: - \[EXTREME\] ANGEL WITH BROKEN WINGS

<!-- end list -->

  - 11070: - \[???\] HELLBOUND - *(This and the following missions only
    have orphaned mentions by missionCode in scripts and don't have
    enough data to be played via Infinite Heaven) *Mentioned in
    TppStory.lua.
  - 11100: - \[???\] BLOOD RUNS DEEP - Mentioned in TppStory.lua.
  - 11110: - \[???\] VOICES - Mentioned in TppStory.lua.
  - 11150: - \[???\] SKULL FACE - Mentioned in TppStory.lua.
  - 11230: - \[???\] KINGDOM OF THE FLIES - Mentioned in TppStory.lua.
  - 11240: - \[???\] SHINING LIGHTS, EVEN IN DEATH - Mentioned in
    TppStory.lua.
  - 11260: - \[???\] A QUIET EXIT - Mentioned in TppStory.lua.
  - 11280: - \[???\] TRUTH: THE MAN WHO SOLD THE WORLD - Mentioned in
    TppStory.lua.

###### Ground Zeroes/Extra

  - 20000: Title Screen
  - 20001: Installation Screen
  - 20010: GROUND ZEROES
  - 20015: GROUND ZEROES Ending
  - 20020: Eliminate the Renegade Threat
  - 20030: Classified Intel Acquisition
  - 20040: Intel Operative Rescue
  - 20050: Destroy the Anti-Air Emplacements
  - 20060: Déjà-Vu
  - 20070: Jamais Vu

###### "Missing" Missions

  - 20090: Featured *village* in Afghanistan.
  - 20101: Featured *swampWest* in Africa.
  - 20110: Featured *lab* in Africa.
  - 20120: Featured *swamp* in Africa.
  - 20130: Featured *diamond* in Africa.
  - 20155: Featured *pfCamp* in Africa.
  - 20210: Featured *lab* in Africa.
  - 20510: KJP LA 2013 demo.
  - 20520: TGS (?)
  - 20530
  - 20540: Had *guantanamo* vehicles.
  - 20550

###### Survive Missions

  - 10010: Prologue
  - 10035: First battle with The Lord of Dust
  - 10050: Battle against Seth
  - 10060: Ending

##### Side Ops/Quests

Sideops also have numeric ids separate from missionCodes. Side ops fall
into 9 main categories in 10k ranges.

  - Infantry extraction/elimination: 10k
  - Rescue: 20k
  - Animal: 30k
  - MB or container: 40k
  - Vehicle elimination: 50k
  - Mines or keyitem: 60k
  - Wandering Puppets: 70k
  - Wandering MSF soldier: 80k
  - Story or Gunsmith: 90k

##### Side Op ids

See also: [Custom Side-Ops List](/Custom_Side-Ops_List "wikilink")

From tpp_quest.eng.lng2 \> name_\[q\]questId LangId format (e.g.
name_q10010)

###### Infantry extraction/elimination

  - 10010 : Extract the Highly-Skilled Soldier 01
  - 10020 : Extract the Highly-Skilled Soldier 02
  - 10080 : Extract the Highly-Skilled Soldier 03
  - 10050 : Extract the Highly-Skilled Soldier 04
  - 10040 : Extract the Highly-Skilled Soldier 05
  - 10060 : Extract the Highly-Skilled Soldier 06
  - 10200 : Extract the Highly-Skilled Soldier 07
  - 10100 : Extract the Highly-Skilled Soldier 08
  - 10300 : Extract the Highly-Skilled Soldier 09
  - 10500 : Extract the Highly-Skilled Soldier 10
  - 10400 : Extract the Highly-Skilled Soldier 11
  - 10600 : Extract the Highly-Skilled Soldier 12
  - 10030 : Extract the Highly-Skilled Soldier 13
  - 10070 : Extract the Highly-Skilled Soldier 14
  - 10700 : Extract the Highly-Skilled Soldier 15
  - 10090 : Extract the Highly-Skilled Soldier 16

<!-- end list -->

  - 11010 : Eliminate the Heavy Infantry 01
  - 11020 : Eliminate the Heavy Infantry 02
  - 11030 : Eliminate the Heavy Infantry 03
  - 11040 : Eliminate the Heavy Infantry 04
  - 11400 : Eliminate the Heavy Infantry 05
  - 11200 : Eliminate the Heavy Infantry 06
  - 11080 : Eliminate the Heavy Infantry 07
  - 11060 : Eliminate the Heavy Infantry 08
  - 11090 : Eliminate the Heavy Infantry 09
  - 11600 : Eliminate the Heavy Infantry 10
  - 11050 : Eliminate the Heavy Infantry 11
  - 11500 : Eliminate the Heavy Infantry 12
  - 11300 : Eliminate the Heavy Infantry 13
  - 11700 : Eliminate the Heavy Infantry 14
  - 11070 : Eliminate the Heavy Infantry 15
  - 11100 : Eliminate the Heavy Infantry 16

<!-- end list -->

  - 19010 : Extract Interpreter (Russian)
  - 19011 : Extract Interpreter (Afrikaans)
  - 19012 : Extract Interpreter (Kikongo)
  - 19013 : Extract Interpreter (Pashto)

###### Rescue

  - 20015 : Unlucky Dog 01
  - 20085 : Unlucky Dog 02
  - 20205 : Unlucky Dog 03
  - 20705 : Unlucky Dog 04
  - 20095 : Unlucky Dog 05

<!-- end list -->

  - 20065 : Prisoner Extraction 01
  - 20025 : Prisoner Extraction 02
  - 20075 : Prisoner Extraction 03
  - 20805 : Prisoner Extraction 04
  - 20905 : Prisoner Extraction 05
  - 20305 : Prisoner Extraction 06
  - 20035 : Prisoner Extraction 07
  - 23005 : Prisoner Extraction 08
  - 20045 : Prisoner Extraction 09
  - 21005 : Prisoner Extraction 10
  - 20105 : Prisoner Extraction 11
  - 24005 : Prisoner Extraction 12
  - 20505 : Prisoner Extraction 13
  - 20605 : Prisoner Extraction 14
  - 25005 : Prisoner Extraction 15
  - 27005 : Prisoner Extraction 16
  - 26005 : Prisoner Extraction 17
  - 20055 : Prisoner Extraction 18
  - 22005 : Prisoner Extraction 19
  - 20405 : Prisoner Extraction 20

<!-- end list -->

  - 20913 : Search for the Escaped Children 01
  - 20914 : Search for the Escaped Children 02
  - 20912 : Search for the Escaped Children 03
  - 20910 : Search for the Escaped Children 04
  - 20911 : Search for the Escaped Children 05

###### Animal extraction

  - 30010 : Extract the Little Lost Sheep
  - 39010 : Capture the Legendary Brown Bear
  - 39011 : Capture the Legendary Ibis
  - 39012 : Capture the Legendary Jackal

###### Target practice or container extraction

  - 40010 : Extract Materials Containers

<!-- end list -->

  - 42010 : Target Practice (Command Platform)
  - 42020 : Target Practice (R\&D Platform)
  - 42030 : Target Practice (Support Unit Platform)
  - 42040 : Target Practice (Base Development Platform)
  - 42050 : Target Practice (Medical Platform)
  - 42060 : Target Practice (Intel Team Platform)
  - 42070 : Target Practice (Combat Unit Platform)

###### Vehicle elimination

  - 52030 : Eliminate the Armored Vehicle Unit 01
  - 52010 : Eliminate the Armored Vehicle Unit 02
  - 52040 : Eliminate the Armored Vehicle Unit 03
  - 52020 : Eliminate the Armored Vehicle Unit 04
  - 52050 : Eliminate the Armored Vehicle Unit 05
  - 52070 : Eliminate the Armored Vehicle Unit 06
  - 52060 : Eliminate the Armored Vehicle Unit 07
  - 52080 : Eliminate the Armored Vehicle Unit 08
  - 52090 : Eliminate the Armored Vehicle Unit 09
  - 52100 : Eliminate the Armored Vehicle Unit 10
  - 52130 : Eliminate the Armored Vehicle Unit 11
  - 52110 : Eliminate the Armored Vehicle Unit 12
  - 52120 : Eliminate the Armored Vehicle Unit 13
  - 52140 : Eliminate the Armored Vehicle Unit 14

<!-- end list -->

  - 52035 : Eliminate the Tank Unit 01
  - 52025 : Eliminate the Tank Unit 02
  - 52015 : Eliminate the Tank Unit 03
  - 52075 : Eliminate the Tank Unit 04
  - 52065 : Eliminate the Tank Unit 05
  - 52045 : Eliminate the Tank Unit 06
  - 52055 : Eliminate the Tank Unit 07
  - 52095 : Eliminate the Tank Unit 08
  - 52085 : Eliminate the Tank Unit 09
  - 52105 : Eliminate the Tank Unit 10
  - 52135 : Eliminate the Tank Unit 11
  - 52115 : Eliminate the Tank Unit 12
  - 52125 : Eliminate the Tank Unit 13
  - 52145 : Eliminate the Tank Unit 14

<!-- end list -->

  - 52018 : Eliminate the Gunship Unit *(Orphaned lang id)*

###### Mine clearing or blueprint extraction

  - 60010 : Mine Clearing 01
  - 60011 : Mine Clearing 02
  - 60024 : Mine Clearing 03
  - 60013 : Mine Clearing 04
  - 60021 : Mine Clearing 05
  - 60020 : Mine Clearing 06
  - 60012 : Mine Clearing 07
  - 60023 : Mine Clearing 08
  - 60014 : Mine Clearing 09
  - 60022 : Mine Clearing 10

<!-- end list -->

  - 60110 : Secure the \[STUN ARM\] Blueprint
  - 60111 : Secure the \[UA-DRONE\] Blueprint
  - 60112 : Secure the \[IR-SENSOR\] Blueprint
  - 60113 : Secure the \[ANTITHEFT DEVICE\] Blueprint
  - 60114 : Secure the \[GUN-CAM DEFENDER\] Blueprint
  - 60115 : Secure the \[RIOT SMG\] Blueprint

###### Wandering Puppets

  - 71010 : Eliminate the Wandering Puppets 01
  - 71300 : Eliminate the Wandering Puppets 02
  - 71020 : Eliminate the Wandering Puppets 03
  - 71600 : Eliminate the Wandering Puppets 04
  - 71030 : Eliminate the Wandering Puppets 05
  - 71070 : Eliminate the Wandering Puppets 06
  - 71050 : Eliminate the Wandering Puppets 07
  - 71700 : Eliminate the Wandering Puppets 08
  - 71090 : Eliminate the Wandering Puppets 09
  - 71040 : Eliminate the Wandering Puppets 10
  - 71080 : Eliminate the Wandering Puppets 11
  - 71060 : Eliminate the Wandering Puppets 12
  - 71500 : Eliminate the Wandering Puppets 13
  - 71400 : Eliminate the Wandering Puppets 14
  - 71200 : Eliminate the Wandering Puppets 15

###### Wandering MSF soldier

  - 80060 : Extract the Wandering Mother Base Soldiers 01
  - 80020 : Extract the Wandering Mother Base Soldiers 02
  - 80100 : Extract the Wandering Mother Base Soldiers 03
  - 80200 : Extract the Wandering Mother Base Soldiers 04
  - 80600 : Extract the Wandering Mother Base Soldiers 05
  - 80400 : Extract the Wandering Mother Base Soldiers 06
  - 80010 : Extract the Wandering Mother Base Soldiers 07
  - 80700 : Extract the Wandering Mother Base Soldiers 08
  - 80080 : Extract the Wandering Mother Base Soldiers 09
  - 80040 : Extract the Wandering Mother Base Soldiers 10

###### Story or Legendary Gunsmith

  - 99010 : Search for the Sniper "Quiet" *(hidden)*
  - 99011 : Visit Quiet
  - 99012 : Secure Quiet

<!-- end list -->

  - 99020 : Make Contact with Emmerich

<!-- end list -->

  - 99030 : Extract the AI Pod

<!-- end list -->

  - 99040 : Secure the Remains of the Man on Fire

<!-- end list -->

  - 99050 : Eli's Challenge

<!-- end list -->

  - 99060 : Curing Paz's Amnesia *(hidden)*

<!-- end list -->

  - 99080 : Intel Agent Extraction

<!-- end list -->

  - 99071 : Extract the Legendary Gunsmith
  - 99070 : Extract the Legendary Gunsmith Again
  - 99072 : Extract the Legendary Gunsmith Yet Again

###### Other

  - dummy_car_01: Driver's Ed 01 *(Orphaned, was never even given a
    quest number Info from lang data: "Pass through all the checkpoints
    on the deck of Mother Base within the time limit. Stop a vehicle on
    the starting point to make the markers appear and the training
    begin.")*
  - dummy_car_02: Driver's Ed 02
  - dummy_car_03: Driver's Ed 03

<!-- end list -->

  - mtbs_wait_quiet: ? Never enabled by canOpenQuestChecks. Seems to
    just wake up Quiet when entering her room.
  - mtbs_return_quiet: ? Never enabled by canOpenQuestChecks. Files not in final game.
  - Mtbs_child_dog: Puppy DD block on Mother Base's Command platform.
  - Mtbs_ddog_walking: Walking adult DD block on Mother Base's Command
    platform.
  - quest_q101210: Seems to manage a Mother Base conversation between a
    male and a female Diamond Dogs soldier on the Support platform.
  - quest_q101220: Seems to manage a Mother Base conversation between
    two female Diamond Dogs soldiers on the Intel platform.
  - quest_smoking/Mtbs_SmokingSoldierCommand: Seems to manage Mother
    Base smoke break routes on the Command platform.
  - quest_smoking/Mtbs_SmokingSoldierCombat: Seems to manage Mother
    Base smoke break routes on the Combat platform.

  - 20070 : Set in sovietBase.
  - 71100 : Set in outland.
  - 80030 : Set in ruins.
  - 80050 : Set in cliffTown.
  - 80070 : Set in sovietBase.
  - 80300 : Set in savannah.
  - 80500 : Set in banana.

##### References

TppDefine.lua TppStory.lua

TppUIBootInit.lua

tpp_quest.eng.lng2

xentax

reddit

[Excel
document](https://docs.google.com/spreadsheets/d/1f4PLyHsO4Alo1PFCKqtjN2m90LH4b9Hmq-Mvz_umCDE) *\\Assets\\tpp\\script\\lib\\TppDefine.lua*, *TppStory.lua*

[Pre-release build](https://mgsvmoddingwiki.github.io/Pre-release_build/) *asset_version.txt*

### `wiki:wiki/Mission_Objectives.md`

This page describes how to use mission objectives in missions, including
defining them in the Sequence mission table subscript and using
functions to update them.

##### Mission Table Sequence subscript tables

###### missionObjectiveDefine

The `missionObjectiveDefine` table defines the precise details about
objectives, such as objective markers for areas, NPCs and gimmicks,
iDroid VI photos, subgoals, enemy routes on the map, target area CP
music, mission tasks and forced spy search on specific enemy soldiers.
An objective can also simply be an empty table, as a dummy objective
that can be the parent of another objective in the objective tree, so
when the parent is shown, its child objective that does have something
like a marker will be disabled.

###### packLabel

The `packLabel` parameter in the objective will restrict the objective
from being updated if the current packLabel isn't the one specified in
it.

``` lua
this.missionObjectiveDefine = {
    mission_target_cp = {
        packLabel = { "afterSahelanTestDemo" },
        --...
    },
}
```

###### announceLog

The `announceLog` parameter in the objective will print a message in the
announce log. The parameter is not a `langId`, instead it uses a string
key of a `langId` value string from `TppUI`'s `ANNOUNCE_LOG_TYPE` table.

``` lua
this.missionObjectiveDefine = {
    announce_eliminateTarget = {
        announceLog = "eliminateTarget",
    },
}
```

###### gameObjectName and gimmickId

The `gameObjectName` or `gimmickId` parameters will place a marker on
the given game object or gimmick with the following parameters as
arguments using the function `TppMarker.Enable(gameObjectId,...)`. The
`gameObjectName` can be a TppMarkerLocatorSystem game object or an NPC
like a soldier or a hostage, and if you're using a `gimmickId`, it will
be the name of the gimmick in the `mvars.gim_identifierParamTable`
table, meaning either a vanilla gimmick set up in the location's
scripts, or a custom one, though you'll have to push to that table
yourself somehow.

``` lua
this.missionObjectiveDefine = {
    default_area_slopedTown = {
        --EITHER:
        --Name of the marker, soldier, etc. gameobject
        gameObjectName = "s10020_marker_slopedTown",
        --OR:
        --Name of the gimmick in mvars.gim_identifierParamTable
        gimmickId = "lab_cntn001",

        --TppMarker.Enable arguments:
        visibleArea = 5, --Marker's area size, 0 is default if unassigned
        goalType = "none", --Goal type, "none" is default if unassigned
        viewType = "all", --Visible on map or game world or both, "map" is default if unassigned
        randomRange = 3, --Level of random area, randomized offset, 0 by default if unassigned
        setImportant = true, --Yellow/important marker, will make the target marker visible in the world
        setNew = true, --Mark as a new marker on the map or not
        langId = "marker_info_mission_targetArea", --Lang id of the marker
        goalLangId = "marker_info_mission_targetArea", --Lang id of the goal
        mapRadioName = "s0020_mprg0020", --Radio label on the map marker
        setInterrogation = true, --Interrogation bool, true by default?
    },
}
```

###### photoId

The `photoId` parameter will add a photo to the iDroid mission info
section. If `addFirst` is true, it will use the vertical photo on the left. If `addSecond` is
true, it will use a vertical photo on the right. There is also a seemingly unused
(non-functional, orphaned) `isComplete` parameter.

The photo index is generated into this `.ftex` texture path:

`"/Assets/tpp/ui/texture/Photo/tpp/[%05d missionCode]]/mb_photo_[%05d
missionCode]_[%03 photoId].ftex"`

Add `"_1.ftex"` as a suffix for the vertical photo texture version. The
generated example would be:
`"/Assets/tpp/ui/texture/Photo/tpp/10020/mb_photo_10020_010.ftex"`

``` lua
this.missionObjectiveDefine = {
    default_photo_target_a = {
        photoId = 10, --Photo index:
        addFirst = true,--If true, use a vertical photo on the left. False if unassigned
        addSecond = false, --If true, use a vertical photo on the right. False if unassigned
        isComplete = false, --Unused flag that doesn't do anything
        photoRadioName = "s0093_mirg0010", --Photo radio label
    },
}
```

###### hudPhotoId

The `hudPhotoId` parameter will show the previously defined `photoId`,
the vertical version of it, on the right side of the screen.

``` lua
this.missionObjectiveDefine = {
    hud_10 = {
        --Vertical photo index to show on the screen when the objective is shown
        hudPhotoId = 10,
    },
}
```

###### subGoalId

The `subGoalId` parameter will change the subgoal `langId` and if the
subgoal is above 0, print the new subgoal in the announcement log.

The subgoal index is generated into this `langId`:

`"subgoal_mission_[%02 locationCode]_[%05 missionCode]_[%02 subGoalId]"`

An output example would be:

`"subgoal_mission_10_10020_02"`

``` lua
this.missionObjectiveDefine = {
    on_subGoal_missionComplete = {
        --The subgoal index to use when the objective is shown.
        subGoalId = 2,
    },
}
```

###### showEnemyRoutePoints

The `showEnemyRoutePoints` parameter will show on the map a route made
out of the given list of `Vector3` coordinates. Strangely, the line is
drawn in backwards order from the ones listed, as in the first point
will be the one that has an arrow pointing outward.

``` lua
this.missionObjectiveDefine = {
    route_vip_field_arrival = {
        --Show a red route on the map
        showEnemyRoutePoints = {
            groupIndex = 0, --Route index, starts from 0
            width = 200.0, --Route width in meters
            langId = "marker_target_forecast_path", --Lang id for the route
            radioGroupName = "f1000_mprg0260", --Map radio label for the route
            --Coordinates starting from end arrow (the first point will be pointed at by the path)
            points={
                Vector3( 588.3,0.0,1163.0 ),
                Vector3( 739.0,0.0,1212.0 ),
                Vector3( 929.0,0.0,1261.7 ),
                Vector3( 1161.8,0.0,1408.5 ),
                Vector3( 1247.8,0.0,1733.9 ),
                Vector3( 956.9,0.0,1970.4 ),
                Vector3( 728.8,0.0,1940.4 ),
                Vector3( 455.6,0.0,2165.6 ),
            }
        },
    },
}
```

###### targetBgmCp

The `targetBgmCp` parameter will enable the Target Area Infiltration
track to play when infiltrating the specified outpost.

``` lua
this.missionObjectiveDefine = {
    --Enable the Target Area Infiltration track to play for this CP gameobject
    mission_target_cp = {
        --CP gameobject name
        targetBgmCp = "afgh_sovietBase_cp",
    },
}
```

###### missionTask

The `missionTask` parameter will modify the mission task list. A mission
can only have 8 tasks - 0 to 7. A task can also be hidden by default to
avoid telling the player what they will have to do later on.

Here's an example of two `missionTask` parameter objectives that first
define a normal objective that's shown from the start, and another that
clears it:

``` lua
this.missionObjectiveDefine = {
    --Objective example: shown by default
    --Show objective to define the mission task.
    default_missionTask_00 = {
        missionTask = {
            --Task index, 0 to 7. Include this index in  the external missionTaskList table.
            taskNo = 0,
            --New yellow marker boolean.
            isNew = true,
            --Task completion boolean.
            isComplete = false,
            --Boolean for whether to hide the task or not.
            isFirstHide = false
        },
    },
    --Show objective to clear the mission task.
    clear_missionTask_00 = {
        missionTask = {
            taskNo = 0,
            isNew = true,
            isComplete = true
        },
    },
}
```

And here's an example of a set of `missionTask`-using objectives that
use a task that's hidden by default, but then is shown, and then
completed.

``` lua
this.missionObjectiveDefine = {
    --Objective example: hidden by default
    --Show objective to define the hidden task.
    default_missionTask_01 = {
        missionTask = {
            taskNo = 1,
            isNew = true,
            isComplete = false,
            isFirstHide = true
        },
    },
    --Show objective to show the hidden task.
    open_missionTask_01 = {
        missionTask = {
            taskNo = 1,
            isNew = true,
            isComplete = false,
            isFirstHide = false
        },
    },
    --Show objective to clear the mission task.
    clear_missionTask_00 = {
        missionTask = {
            taskNo = 1,
            isNew = true,
            isComplete = true
        },
    },
}
```

###### spySearch

The `spySearch` parameter will force enable the Enemy FOM marker for an
enemy soldier, even if they're far away, set an important yellow New
mark on it, and change the marker's `langId`.

``` lua
this.missionObjectiveDefine = {
    route_vip_field_arrival = {
        --Force enable the FOM marker on an enemy soldier on the map
        spySearch = {
            --The soldier locator's name
            gameObjectName = "sol_vip_field",
            --Yellow new marker bool
            isNew = true,
            --Lang id for the FOM marker
            langId = "marker_info_mission_target",
        },
    },
}
```

###### missionObjectiveTree

The missionObjectiveTree table defines a table of priorities for the
previously defined objectives. In short, when an objective is shown, all
its children in the tree will be disabled, removed and hidden. Not all
objectives have to be on the tree, because not all of them have to be
hidden by another marker eventually. The simplest example is often used
in `missionTask` objectives:

``` lua
this.missionObjectiveTree = {
    clear_missionTask_00 = {
        default_missionTask_00 = {},
    },
    clear_missionTask_01 = {
        open_missionTask_01 = {
            default_missionTask_01 = {},
        },
    },
}
```

Here we have two task branches: the deeper you go into them, the earlier
the objective is. The `default` one defines the objective as not yet
cleared, and the `clear` one updates it to be marked as cleared. In the
second one, an in-between is introduced: since the `default` one defines
it as being hidden by default, the `open` one shows it, and afterward,
the `clear` one marks it as clear. With markers, it looks often like
this:

``` lua
this.missionObjectiveTree = {
    missionClear = {
        marker_target = {
            marker_area_targetVagueLocationMarker = {
                marker_area_targetOutpostMarker = {},
            },
        },
    },
}
```

The deepest one is the vaguest marker, and the one we are given in this
hypothetical mission, `marker_area_targetOutpostMarker`, marking the
entire outpost our target is in. The next level is
`marker_area_targetVagueLocationMarker`, a location within the outpost,
but not as precise as it would be if you were to mark the target
yourself directly, which is exactly what's up next, `marker_target` -
we've marked the target directly. Finally, the highest outer level is
`missionClear`, an objective with no markers. We have cleared the
mission after eliminating or rescuing the target, so we no longer need
any of the markers we had before.

The reason we have this tree is because of how much there is to disable
or remove from our UI when we've reached the next step in the mission.
Since we can also skip some steps, this is useful too.

It can get a bit more complex with multiple objectives with the same
children:

``` lua
this.missionObjectiveTree = {
    rv_missionClear = {
        get_s10093_Container_A = {
            add_s10093_Container_A = {
                add_lab_enemy_map = {
                    default_area_lab = {},
                },
            },
        },
        get_s10093_Container_B = {
            add_s10093_Container_B = {
                add_lab_enemy_map = {
                    default_area_lab = {},
                },
            },
        },
        default_photo_target_a  = {},
        default_photo_target_b  = {},
        target_area_cp  = {},
        intermediate_target01 = {},
    },
}
```

The objectives `default_area_lab` and `add_lab_enemy_map` are repeated
here, because showing either `add_s10093_Container_A` or
`add_s10093_Container_B` should remove those markers. A simplified
example would be this:

``` lua
this.missionObjectiveTree = {
    AreaMarker_A_ClearVersion = {
        default_mission_intel = {},
    },
    AreaMarker_B_ClearVersion = {
        default_mission_intel = {},
    },
    AreaMarker_C_ClearVersion = {
        default_mission_intel = {},
    },
    missionTask_1_RecoverTarget_clear = {
        missionTask_1_RecoverTarget ={},
        AreaMarker_A_ClearVersion = {},
        AreaMarker_B_ClearVersion = {},
        AreaMarker_C_ClearVersion ={},
        default_mission_intel = {},
    },
}
```

Here, the `default_mission_intel` marker is hidden if we get any of the
`A`, `B` or `C` `AreaMarkers`. All three are hidden if the mission task
is cleared. You can also have it be very simplistic and not bother at
all with big trees, and use something like this for everything:

``` lua
this.missionObjectiveTree = {
    clear_Area_hosTarget_flee = {
        Area_hosTarget_flee = {},
    },
    clear_Area_hosTarget_convoy = {
        Area_hosTarget_convoy = {},
    },
}
```

The `clear_` objectives are actually empty in the definition table;
they're there simply to hide their children on this tree.

###### missionObjectiveEnum

The missionObjectiveEnum enum is used by the game's code to index around
objectives instead of using their names. Every objective in the
missionObjectiveDefine table needs to be here.

This is an example of what the game does:

``` lua

this.missionObjectiveEnum = Tpp.Enum{
    "default_mission_intel",
    "default_viewPoint",
    "Arrived_viewPoint",
    --...
}
```

...and more. But you can completely ignore this weird thing and instead
use this method that incredibly easily automates it from a previously
defined missionObjectiveDefine.

``` lua
this.missionObjectiveEnum = {}
for objectiveName, objectiveTable in pairs(this.missionObjectiveDefine) do
    if Tpp.IsTypeString(objectiveName) then
        table.insert(this.missionObjectiveEnum,objectiveName)
    end
end
this.missionObjectiveEnum=Tpp.Enum(this.missionObjectiveEnum)
```

##### Objective functions

###### TppMission.UpdateObjective

The function `TppMission.UpdateObjective(...)` updates the current
objectives, with possible parameters like radio calls before or after
the objective is updated. There is also an `options` parameter, but none
of them seem to do anything.

A simple update of objectives would be this: we're simply defining the
mission tasks with these objectives.

``` lua
TppMission.UpdateObjective{
    objectives = {
        "default_missionTask_00",
        "default_missionTask_01",
        "default_missionTask_02",
        "default_missionTask_03",
        "default_missionTask_04",
    },
}
```

However, even if you want to update one objective, you have to use it in
a table.

If we want to update the objective after a specified radio label plays,
we can do this:

``` lua
TppMission.UpdateObjective{
    objectives = {
        "default_area_field"
    },
    radio = {
        radioGroups = "s0036_rtrg0010",
    },
}
```

You can also use a table of multiple radio labels as the `radioGroups`,
and also use `radioOptions` the same way we can use the second argument
in `TppRadio.Play()` for parameters for radio playback, like `delayTime`
or `priority`.

``` lua
TppMission.UpdateObjective{
    objectives = {
        "default_area_clifftown"
    },
    radio = {
        radioGroups = {
            "s0044_rtrg0010",
            "s0044_rtrg0020"
        },
        radioOptions = {
            priority = "strong"
        },
    },
}
```

We can also use `radioSecond` to play a `radioGroups` of either one or
multiple radio labels after the objective has already been updated.
`radioOptions` applies there as well.

``` lua
TppMission.UpdateObjective{
    objectives = {
        "default_area_enemyBase"
    },
    radio = {
        radioGroups = "s0033_rtrg0010",
    },
    radioSecond = {
        radioGroups = "s0033_rtrg0011",
    },
}
```

### `wiki:wiki/Mission_Table_Subscripts.md`

The Mission Table subscripts exist in every mission in the game in
various forms, though always at least having a Sequence subscript. Each
subscript contains code relating to an element of the mission, such as
enemies and NPCs, cutscenes, support radio, result score, opening
credits and music.

The TppSimpleMissionData class of entity in a DataSet .fox2 file loaded
with the mission defines paths to the Mission Table subscripts.

``` xml
<entity class="TppSimpleMissionData" classVersion="1" addr="0x053506A0" unknown1="136" unknown2="1989016">
  <staticProperties>
    <property name="name" type="String" container="StaticArray" arraySize="1">
      <value>mission_data</value>
    </property>
    <property name="dataSet" type="EntityHandle" container="StaticArray" arraySize="1">
      <value>0x04D8FF20</value>
    </property>
    <property name="script" type="FilePtr" container="StaticArray" arraySize="1">
      <value>/Assets/tpp/script/mission/mission_main.lua</value>
    </property>
    <property name="subScripts" type="FilePtr" container="StringMap" arraySize="7">
      <value key="sequence">/Assets/tpp/level/mission2/ih/example/example_sequence.lua</value>
      <value key="enemy">/Assets/tpp/level/mission2/ih/example/example_enemy.lua</value>
      <value key="radio">/Assets/tpp/level/mission2/ih/example/example_radio.lua</value>
      <value key="demo">/Assets/tpp/level/mission2/ih/example/example_demo.lua</value>
      <value key="telop">/Assets/tpp/level/mission2/ih/example/example_telop.lua</value>
      <value key="sound">/Assets/tpp/level/mission2/ih/example/example_sound.lua</value>
      <value key="score">/Assets/tpp/level/mission2/ih/example/example_score.lua</value>
    </property>
  </staticProperties>
  <dynamicProperties />
</entity>
```

TppSimpleMissionData entity example with all subscripts used in the
game.

The `sequence` subscript is the only truly integral subscript, and while
there is exclusive functionality behind other subscripts, they are
optional to the mission running at all. The example above lists all
possible subscripts used in vanilla missions.

Along with any defined subscripts, the `mission_main` script must be
packed and loaded with the DataSet as well. Here is a compressed version
of that script:

``` lua
local this = {}
this.OnAllocate = function(subScripts) return TppMain.OnAllocate(subScripts) end
this.OnInitialize = function(subScripts) return TppMain.OnInitialize(subScripts) end
this.OnReload = function(subScripts) return TppMain.OnReload(subScripts) end
this.OnUpdate = function(subScripts) return TppMain.OnUpdate(subScripts) end
this.OnChangeSVars = function(subScripts, varName, key) return TppMain.OnChangeSVars(subScripts, varName, key) end
this.OnMessage = function(subScripts, sender, messageId, arg0, arg1, arg2, arg3) return TppMain.OnMessage(subScripts, sender, messageId, arg0, arg1, arg2, arg3) end
this.OnTerminate = function(subScripts) return TppMain.OnTerminate(subScripts) end
return this
```

mission_main.lua, compressed

##### All Subscripts

These can be used in any subscript, though usually only one utilizes
them.

###### Callback functions

###### OnLoad

The `OnLoad` function, which is looked for and is called in all
subscripts, but most importantly in the Sequence subscript, has to
contain two function calls that define the sequence tables: the
index-name table, `TppSequence.RegisterSequences()`, and the
name-callbacks table, `TppSequence.RegisterSequenceTable()`.

``` lua
--Sequence names in order. The first listed sequence will be the one we will first boot to.
local sequenceNames = {
    "Seq_Game_MainGame",
    "Seq_Game_Escape"
}
--Define the sequences callback table.
local sequences = {}
--Register a callback table for each sequence in sequenceNames.
sequences.Seq_Game_MainGame={}
sequences.Seq_Game_Escape={
    OnEnter=function(self,sequenceName)
        TppMission.CanMissionClear()
    end,
}
--Tell TppSequence to register these tables.
function this.OnLoad()
    TppSequence.RegisterSequences(sequenceNames)
    TppSequence.RegisterSequenceTable(sequences)
end
```

Example of an `OnLoad` callback that defines the sequence tables.

The example above registers two sequences, although only one, of any
name, is required for the mission to boot. One of them, MainGame, has no
callbacks, but is a valid sequence nonetheless. The other sequence,
Escape, has an OnEnter callback that calls TppMission.CanMissionClear().
The OnEnter callback is called when the game switches to or starts with
that sequence. Calling TppMission.CanMissionClear() will make the game
start asking if you're not within the hot zone, so if you don't have a
hot zone area defined in a .trap file or as a GeoTriggerTrap, the start
of that sequence will clear the mission immediately.

###### Tables

###### saveVarsList

The `saveVarsList` table initializies variables that are written to the
save file for the mission. Essentially, it's a simplified version of the
returned table of the DeclareSVars function, simplified specifically
through the `TppSequence.MakeSVarsTable` function.

``` lua
this.saveVarsList = {
    isFlag00    = false,
    isFlag01    = false,
    isFlag02    = false,
    isFlag03    = false,
    numFlag00 = 0,
    numFlag01 = 0,
    numFlag02 = 0,
    numFlag03 = 0,
}
```

The only data types of variables that you can define here as is are
booleans or integers, other types, and with different parameters, you
will have to write out its own table.

``` lua
this.saveVarsList = {
    posAbortWarmhole_x = { name = "posAbortWarmhole_x", type = TppScriptVars.TYPE_FLOAT, value = 0, save = true, sync = true, wait = true, category = TppScriptVars.CATEGORY_MISSION },
    posAbortWarmhole_y = { name = "posAbortWarmhole_y", type = TppScriptVars.TYPE_FLOAT, value = 0, save = true, sync = true, wait = true, category = TppScriptVars.CATEGORY_MISSION },
    posAbortWarmhole_z = { name = "posAbortWarmhole_z", type = TppScriptVars.TYPE_FLOAT, value = 0, save = true, sync = true, wait = true, category = TppScriptVars.CATEGORY_MISSION },
}
```

###### DeclareSVars

Is called from all subscripts, but seemingly only the equivalent from
other libraries is actually used. In those uses, it seems to be a
function that returns a table of the more detailed table save lists,
just not additionally indexed by the save variable name. This and the
save variables list from before get merged into one list.

``` lua
function this.DeclareSVars()
  return{
    {name="chk_checkPointName",arraySize=TppDefine.CHECK_POINT_MAX,type=TppScriptVars.TYPE_UINT32,value=0,save=true,sync=false,wait=false,category=TppScriptVars.CATEGORY_MISSION},
    {name="chk_checkPointEnable",arraySize=TppDefine.CHECK_POINT_MAX,type=TppScriptVars.TYPE_BOOL,value=0,save=true,sync=false,wait=false,category=TppScriptVars.CATEGORY_MISSION},
  }
end
```

##### Sequence

###### Callback functions

###### MissionPrepare

TBA

###### OnEndMissionPrepareSequence

TBA

###### OnBuddyBlockLoad

Called in `TppMain`'s read of the sequence subscript right before
`TppBuddy2BlockController.Load()` is called. Usually has functions that
set up pre-placed positions or flags for buddies.

###### Flags

###### MISSION_START_INITIAL_WEATHER

Defines the mission start weather type.

``` lua
this.MISSION_START_INITIAL_WEATHER = TppDefine.WEATHER.SUNNY
```

###### ALWAYS_APPLY_TEMPORATY_PLAYER_PARTS_SETTING

Only seems to be used for the ACC missions.

###### ENABLE_DEFAULT_HELI_MISSION_CLEAR

The ENABLE_DEFAULT_HELI_MISSION_CLEAR flag is a boolean that defines
whether the game will clear or abort the mission when the player closes
the door on the support helicopter.

``` lua
this.ENABLE_DEFAULT_HELI_MISSION_CLEAR=true
```

Example use of the flag. When enabled, the mission will end when the
helicopter door is closed.

###### Tables

###### missionStartPosition

The `missionStartPosition` table defines order box names and helicopter
drop route names to help the game keep track of the player's mission
start type.

``` lua
this.missionStartPosition = {
    orderBoxList = {
        --Order box names, i.e. "box_s12000_00",
        "box_flowTape_00",
    },
    helicopterRouteList = {
        --Drop point route names, need to be here when order boxes are
        "lz_drp_flowStation_E0000|lz_drp_flowStation_E_0000",
        "lz_drp_flowStation_I0000|rt_drp_flowStation_I_0000",
        "lz_drp_swamp_W0000|lz_drp_swamp_W_0000",
    },
}
```

###### DISABLE_BUDDY_TYPE

This variable will block a buddy from participating in the mission from
within. It can either be one buddy type, or a table of multiple buddy
types.

``` lua
this.DISABLE_BUDDY_TYPE = BuddyType.QUIET
```

``` lua
this.DISABLE_BUDDY_TYPE = {
    BuddyType.HORSE,
    BuddyType.WALKER_GEAR,
    BuddyType.BATTLE_GEAR
}
```

###### playerInitialWeaponTable

The initial weapon table will override the player's specified secondary,
primary hip, back and support weapons. Unspecified slots are not
overwritten, however.

``` lua
this.playerInitialWeaponTable = {
    { secondary     = "EQP_WP_10101",   magazine = TppDefine.INIT_MAG.HANDGUN_DEFAULT },
    { primaryHip    = "EQP_WP_30101",   magazine = TppDefine.INIT_MAG.ASSAULT_DEFAULT },
    { primaryBack   = "EQP_None" },
    { support       = "EQP_SWP_Grenade" },
    { support       = "EQP_SWP_Magazine" },
}
```

``` lua
this.playerInitialWeaponTable = {
    { secondary     = "EQP_WP_10004",   magazine = TppDefine.INIT_MAG.HANDGUN_DEFAULT },
    { primaryHip    = "EQP_WP_30103",   magazine = TppDefine.INIT_MAG.ASSAULT_DEFAULT },
    { primaryBack   = "EQP_None" },
    { support       = "EQP_None", },
    { support       = "EQP_None", },
    { support       = "EQP_None", },
    { support       = "EQP_None", },
    { support       = "EQP_None", },
    { support       = "EQP_None", },
    { support       = "EQP_None", },
    { support       = "EQP_None", },
}
```

You can also use `TppDefine.CYPR_PLAYER_INITIAL_WEAPON_TABLE` to
overwrite all of the player's weapons with `"EQP_None"`.

``` lua
this.playerInitialWeaponTable = TppDefine.CYPR_PLAYER_INITIAL_WEAPON_TABLE
```

###### playerInitialItemTable

The initial item table will overwrite the player's items on mission
start. Unspecified slots will not be overwritten.

``` lua
this.playerInitialItemTable = {
    "EQP_IT_TimeCigarette", "EQP_IT_Nvg", "EQP_None",
}
```

``` lua
this.playerInitialItemTable = { "EQP_None", "EQP_None","EQP_None","EQP_None","EQP_None","EQP_None","EQP_None","EQP_None",}
```

You can also use `TppDefine.CYPR_PLAYER_INITIAL_ITEM_TABLE` to
completely overwrite the item table with `"EQP_None"`.

``` lua
this.playerInitialItemTable = TppDefine.CYPR_PLAYER_INITIAL_ITEM_TABLE
```

###### checkPointList

The `checkPointList` table lists the names of checkpoint locators.

``` lua
this.checkPointList = {
    "CHK_NotKillQuiet",
    "CHK_MovedToMB",
    "CHK_E3_killQuiet",
    "CHK_StartPos",
}
```

###### baseList

The `baseList` table defines what bases - large outposts or observation
guard posts - are in the mission and which should save a checkpoint when
entering or leaving them.

``` lua
this.baseList={
    "flowStation",
    "swampWest",
}
```

###### missionObjectiveDefine, missionObjectiveTree and missionObjectiveEnum

See this page: [Mission Objectives\#Mission Table Sequence subscript
tables](/Mission_Objectives#Mission_Table_Sequence_subscript_tables "wikilink")

TBA

##### Enemy

The `enemy` subscript defines callbacks related to NPCs, like enemy
soldiers and hostages.

###### Callback functions

###### InitEnemy

The `InitEnemy` callback is called early into `TppMain`'s reading of the
enemy sub-table, just after the `soldierDefine` table is read. It seems
to be mainly used for Mother Base missions with enemies. It's also used
to use routes for soldiers with `TppEnemy.SetSneakRoute()` and
`TppEnemy.SetCautionRoute()` or set them to use specific route groups
without shift changes before `routeSets` has the chance to give them
more random ones.

###### SetUpEnemy

The `SetUpEnemy` callback is called after all other callbacks in
`TppMain`'s read of the enemy subscript. It's usually used for more
generic custom later NPC set-ups that are not yet accounted for by other
callbacks and tables.

###### SpawnVehicleOnInitialize

This function doesn't seem to do anything on its own, but it's during
this function that `TppEnemy.SpawnVehicles(...)` is called from.

``` lua
this.SpawnVehicleOnInitialize = function()
    TppEnemy.SpawnVehicles( this.VEHICLE_SPAWN_LIST )
end
```

The name `this.VEHICLE_SPAWN_LIST` seems to be completely arbitrary
despite being common. It can be anything. The list itself is actually a
list of `SendCommand` tables sent to `TppVehicle2`, all of them spawn a
specific locator of `TppVehicle2`. See more arguments for this
`SendCommand` on the [Commands](/Commands "wikilink") page.

``` lua
this.VEHICLE_SPAWN_LIST = {
    {
        id = "Spawn",
        locator = "sol_vehicle_0000",
        type = Vehicle.type.EASTERN_TRUCK,
        subType = Vehicle.subType.EASTERN_TRUCK_CARGO_MATERIAL,
    },
}
```

The same can also be done with `TppEnemy.DespawnVehicles(...)` and a
similar arbitrary table with `"Despawn"` as the command id and just the
locator name specified. TBA

###### Flags

###### MAX_SOLDIER_STATE_COUNT

The `MAX_SOLDIER_STATE_COUNT` integer is an optional setting for your
mission that overrides the maximum amount of soldier states saved to
`svars`. The default setting is 160, and vanilla missions find that
enough, except for free roam missions in Afghanistan, Africa and Mother
Base, which raise it to 360 or 256. This only has to be done if your
totalCount of TppSoldier2 type in its GameObject definition exceeds 160.

``` lua
this.MAX_SOLDIER_STATE_COUNT = 360
```

###### USE_COMMON_REINFORCE_PLAN

The `MAX_SOLDIER_STATE_COUNT` bool is an optional flag that allows
common reinforce plans to be used if you have vanilla outposts and LRRP
patrols defined between them in `soldierDefine` and `routeSets`.

``` lua
this.USE_COMMON_REINFORCE_PLAN = true
```

###### Tables

###### soldierDefine

The `soldierDefine` table defines which soldiers should belong to which
outposts, as well as their default starting LRRP patrols and vehicles.
This table is integral to the soldiers appearing in your mission.
However, it alone will not simply spawn soldiers - you need
GameObjectLocators of TppSoldier2 type in .fox2 DataSets with the
soldier names, along with the GameObject entity that defines the
TppSoldier2 GameObject type for your mission.

Here's a simple example with two CPs with very few soldiers:

``` lua
this.soldierDefine = {
    cp_swamp_vip = {
        "sol_mis_0000",
    },
    cp_savannah = {
        "sol_mis_0004",
        "sol_mis_0005",
        "sol_mis_0006",
    },
}
```

Here's an example of a LRRP unit with a given travel plan:

``` lua
this.soldierDefine = {
    mafr_02_21_lrrp={
        "sol_02_21_0000",
        "sol_02_21_0001",
        lrrpTravelPlan  = "travel_swampWest",
    },
}
```

And with a vehicle:

``` lua
this.soldierDefine = {
    afgh_01_13_lrrp = {
        "sol_01_13_0000",
        "sol_01_13_0001",
        lrrpTravelPlan  = "travelArea2_01",
        lrrpVehicle     = "veh_trc_0000",
    },
}
```

###### routeSets

The `routeSet` table defines route sets for soldiers in the command
posts defined in the `soldierDefine` table.

See this page: [Route Set](/Route_Set "wikilink").

###### travelPlans

The `travelPlans` table defines LRRP travel and other kinds of travel
between sets of routes and outposts, with some parameters like wait hold
time, one-way patrols, etc..

This example using the `base` parameter might seem like a simple travel
plan, but it actually has some prerequisites. You have to have the
numbered LRRP CPs defined, along with their standard uniformed route
sets.

``` lua
this.travelPlans = {
    travel_swampWest={
        { base = "mafr_swampWest_ob", },
        { base = "mafr_flowStation_cp", },
    }
}
```

Here's an example of a more detailed travel route that does more or less
the same:

``` lua
this.travelPlans = {
    travelCommFacility01 = {
        { cp="afgh_02_34_lrrp",         routeGroup={ "travel", "lrrp_02to34" } },
        { cp="afgh_commFacility_cp",    routeGroup={ "travel", "lrrpHold" },wait=15 },
        { cp="afgh_02_34_lrrp",         routeGroup={ "travel", "lrrp_34to02" } },
        { cp="afgh_commWest_ob",        routeGroup={ "travel", "lrrpHold" },wait=15 },
    },
}
```

The `cp` parameter defines which command post the soldiers will belong
to and which outpost the `routeGroup` will be taken from. The
`routeGroup` defines the set of routes that will be taken from the
specified command post's route set. The `wait` time on the hold
parameter is the time in seconds that the soldiers will wait at the hold
routes. It might actually be overwritten by a common time of 15 seconds
somewhere in the code.

This is an example of a one-way travel plan:

``` lua
this.travelPlans = {
    travelCommFacility01 = {
        ONE_WAY = true,
        { cp="afgh_02_34_lrrp",         routeGroup={ "travel", "lrrp_02to34" } },
        { cp="afgh_commFacility_cp",    finishTravel=true },
    },
}
```

Once the soldiers on the travel plan finish the travel plan, they will
not loop back to the first route set and will instead join the last
command post as regular soldiers.

In this example, they will loop on the last route group instead of
joining regular route groups:

``` lua
this.travelPlans = {
    travelVip = {
        ONE_WAY = true,
        { cp="afgh_10036_lrrp",         routeGroup={ "travel", "lrrp_16to29" } },
        { cp="afgh_field_cp",           routeGroup={ "travel", "lrrp_Vip_Hold" } },
    },
}
```

TBA

###### soldierPowerSettings

The `soldierPowerSettings` table forces certain power settings onto
soldier locators from the `soldierDefine` table. The power settings
table given to a soldier can be empy to remove their power settings
entirely. See `TppEnemy`'s `POWER_SETTING` table for all power settings.

This simple example of the table will simply remove all power settings
from the given soldier.

``` lua
this.soldierPowerSettings = {
    sol_vip_0000 = { },
}
```

This example gives some specific soldiers sniper rifles, body armor,
helmets and missiles.

``` lua
this.soldierPowerSettings = {
    sol_pfCamp_0001 = { "SNIPER" },
    sol_pfCamp_0002 = { "SNIPER" },
    sol_pfCamp_0003 = { "SNIPER" },
    sol_ZRS_0010    = { "SOFT_ARMOR", "HELMET", },
    sol_ZRS_0011    = { "SOFT_ARMOR", "HELMET", },
    sol_ZRS_0012    = { "SOFT_ARMOR", "HELMET", "MISSILE" },
    sol_ZRS_0013    = { "SOFT_ARMOR", "HELMET", "MISSILE" },
}
```

###### soldierPersonalAbilitySettings

The soldier personal ability settings table forces specified soldiers to
use specific personal abilities. It's seemingly never used in the
vanilla game.

The setting types are: "`shot`", which most likely refers to firearm aim
precision, "`grenade`" grenade throw precision, "`reload`" how often
they need to reload, "`hp`" their life, "`notice`" how they prioritize
suspicious sights and noises, "`cure`" how fast they regenerate,
"`reflex`" how long the reflex mode encounter with them lasts, "`speed`"
how fast they move, "`fulton`" how often they will shoot down Fulton
balloons, and "`holdup`" how often they resist in response to being held
up. Any of these settings can be specified here.

The setting levels range from `"low"`, `"mid"`, `"high"` to `"sp"`.

``` lua
this.soldierPersonalAbilitySettings={
    sol_vip_0000={
        shot    = "sp",
        grenade = "high",
        reload  = "mid",
        hp      = "low",
        notice  = "sp",
        cure    = "high",
        reflex  = "mid",
        speed   = "low",
        fulton   = "sp",
        holdup  = "high",
    },
    sol_vip_0001={
        hp      = "sp",
        cure    = "sp",
        speed   = "sp",
        fulton   = "sp",
        holdup  = "sp",
    },
    sol_vip_0002={
        holdup  = "low",
    },
}
```

###### cpGroups

The CP groups table defines command post groups, and joins specified
outposts to existing vanilla command post groups, if you make custom
ones. See the `afgh_cpGroups` and `mafr_cpGroups` scripts for the
vanilla CP groups, or alert a CP in free roam in the game and see how
many will be raised to alert when their HQ is alerted to your presence
as well.

This example adds the custom observation post to the vanilla
`group_Area2`.

``` lua
this.cpGroups = {
    group_Area2 = {
        "ms_13_34_ob",
    }
}
```

###### interrogation

TBA

###### useGeneInter

TBA

###### uniqueInterrogation

TBA

###### soldierSubTypes

TBA

###### vehicleSettings

This table doesn't even seem to be used.

###### vehicleDefine

The `vehicleDefine` table only defines the number of vehicle instances
that should have `svars` reserved for them. You can define a specific
number of vehicles you use here, but you always should add 1 more for
the player's own vehicle. Since spawned vehicles are often defined in a
table, the fastest way to define them here would be to get the length of
the table with `#`.

``` lua
this.vehicleDefine = {
    instanceCount = #this.VEHICLE_SPAWN_LIST + 1,
}
```

###### syncRouteTable

The sync route table defines parameters for the Sync Route route node
event. In the vanilla game, it's only used in s10086/Lingua Franca,
s10110/Voices and s10150/Skull Face. It defines a group of routes that
will get synced with the Sync Route event. The `script` flag seems to
allow the function `SyncRouteManager.SetScriptStep(...)` to manipulate
it somehow.

``` lua
this.syncRouteTable = {
    interrogation1 = {
        "rts_guard1_interrogation1_0000",
        "rts_interpreter_interrogation1_0000",
        "rts_interrogator_interrogation1_0000",
    },
    interrogation1_caution = {
        "rts_guard1_interrogation1_c_0000",
        "rts_interpreter_interrogation1_c_0000",
        "rts_interrogator_interrogation1_c_0000",
    },
    interrogation2 = {
        "rts_interpreter_interrogation2_0000",
        "rts_interrogator_interrogation2_0000",
    },
}
```

``` lua
this.syncRouteTable = {
    SyncRoute = {
        "rts_Fire_fW",
        "rts_Fire_fW2",
    },
}
```

``` lua
this.syncRouteTable = {
    sync_bringer = {
        "rts_bringer_A",
        "rts_bringer_B",
        script = true,
    },
}
```

###### GetRouteSetPriority

This only seems to be used in Mother Base missions, and its result is
generated with `mtbs_enemy`'s `GetRouteSetPriority`. It's initialized as
`nil` and only set with the `mtbs_enemy` function on the script's
`OnAllocate` callback.

TBA

##### Radio

The `radio` subscript defines callbacks related to support radio lines,
like real-time radio, intel radio, optional radio, debriefings and more.

###### gameOverRadioTable

This table overrides game over lines. See
`TppRadio.COMMON_GAME_OVER_RADIO_LIST` for all the default labels used
with the `TppDefine.GAME_OVER_RADIO` enum.

``` lua
this.gameOverRadioTable = {
    [TppDefine.GAME_OVER_RADIO.PLAYER_DEAD] = "f8000_gmov0100",
    [TppDefine.GAME_OVER_RADIO.S10020_OUT_OF_MISSION_AREA] = "f8000_gmov0090"
    [TppDefine.GAME_OVER_RADIO.S10020_TARGET_TIMEOVERDEAD] = "s0020_gmov4010",
    [TppDefine.GAME_OVER_RADIO.S10020_TARGET_DEAD] = "s0020_gmov4020",
    [TppDefine.GAME_OVER_RADIO.S10020_TARGET_KILL] = "s0020_gmov4030",
    [TppDefine.GAME_OVER_RADIO.S10020_RIDING_HELI_DESTROYED] = "s0020_gmov4040",
    [TppDefine.GAME_OVER_RADIO.S10020_PLAYER_DESTROY_HELI] = "s0020_gmov4050",
}
```

###### debugRadioLineTable

Even though there is no functionality to actually display these debug
radio messages in the vanilla game, you can use this table to help
yourself debug your custom missions.

``` lua
this.debugRadioLineTable = {
    RescueHuey_announce = {
        "[dbg]ボス、東側で兵器開発をしている科学者がHECを通じて接触してきた",
        "[dbg]名前はエメリッヒ",
        "[dbg]彼は西側への亡命を希望している",
        "[dbg]まずは依頼者であり、ターゲットでもあるエメリッヒと接触したい",
        "[dbg]この科学者は常時、北のソビエト軍ベースキャンプで軟禁状態にある",
        "[dbg]だが今は変電施設に来ている",
        "[dbg]新兵器のデモンストレーションをするためにな",
        "[dbg]今がターゲット接触のチャンスといえるだろう",
        "[dbg]変電施設へ向かえ。エメリッヒに接触するんだ",
    },
    RescueHuey_updateArea = {
        "[dbg]変電施設に到達したな",
        "[dbg]エメリッヒ博士は施設北端の実験場にいるはずだ",
        "[dbg]実験場の入り口を目指してくれ",
    },
}
```

###### radioList

The `radioList` table defines radio labels that can be used in the
mission. Any label can be played without having to be registered here,
but the optional `playOnce` boolean parameter is useful, as if it's set,
it will block repeated playbacks of that label as its own radio group.
`debugRadioLineTable` entries can also be defined here the same way as
they were there.

``` lua
this.radioList = {
    { "s0033_rtrg0010", playOnce = true },
    "f1000_rtrg2250",
    test_MissionComplete_LeaveBase  = {"(dbg)拠点から離れて安全を確保するんだ" ,},
}
```

###### optionalRadioList

This table seemingly has no functionality behind it aside from
registering it to also unused mvars tables. One of them shows that this
had the same playOnce functionality as radioList, but since this whole
thing is unused, it doesn't much matter.

###### intelRadioList

The intel radio list registers radio labels for intel radio (espionage
radio) for specific locators or overall intel radio types of entities.
The specific locators include NPC locator names and special
`EspionageRadioLocator`s made for this specifically. The intel radio
types list is large and is listed as StrCode64 hashes in the game's
.exe... a few hundred times. You can find most examples of intel radio
types in `TppTutorial.IntelRadioSetting`.

``` lua
this.intelRadioList = {
    --Intel radio type
    type_walkergear = "s0080_esrg4050",
    --Espionage Radio locator
    erl_dirtyriver = "s0080_esrg1010",
    --Enemy soldier locator
    sol_outland_0000 = "s0080_esrg1030",
}
```

###### USE_COMMON_RESULT_RADIO

The `USE_COMMON_RESULT_RADIO` boolean flag seemingly does nothing and is
only used in s10041.

###### blackTelephoneDisplaySetting

This table defines the shape, texture path, image description `langId`
and timing of appearance and disappearance of the images seen in the
debriefing, or as the game internally calls it, the "black telephone"
sequence.

The table entry's key is the debriefing radio's label, as you would need
different timings for different debriefing radio labels, which change in
some missions based on what you do in them. The value is a table with a
`Japanese` and `English` tables within, and the Japanese one is only
used if the game version being used is the Japanese voice one.

The first string of an entry within either the `Japanese` or `English`
table determines the shape of the photo image - `"sub"` for vertical and
`"main"` for horizontal, and the index, starting from `"1"`. The second
string is the path to the `.ftex` file that will be used for the photo.
The texture will be stretched to the proportions dictated by the first
string. Then comes the timing float, in seconds - the image will appear
this many seconds into this radio label's version of the debriefing. The
optional fourth value is the `langId`, which only shows up for vertical
`sub` images.

If the first string is instead `"hide"`, the second string becomes which
previously defined image to hide, and the the third parameter float
becomes the time in seconds at which the image is hidden.

What controls where on the screen in the image is placed is unknown.

``` lua
this.blackTelephoneDisplaySetting = {
    f6000_rtrg0150  = {
        Japanese = {
            { "sub_1", "/Assets/tpp/ui/texture/Photo/tpp/10115/mb_photo_10115_010_1.ftex", 0.6,"cast_mosquito" },
            { "main_1", "/Assets/tpp/ui/texture/Photo/tpp/demo/mission_demo_s10115_02.ftex", 3.5 },
            { "main_2", "/Assets/tpp/ui/texture/Photo/tpp/demo/mission_demo_s10115_03.ftex", 7.3 },
            { "main_3", "/Assets/tpp/ui/texture/Photo/tpp/demo/mission_demo_s10115_04.ftex", 29.9 },
            { "hide", "main_1", 47.1 },
            { "hide", "main_2", 47.4 },
            { "hide", "main_3", 47.7 },
        },
        English = {
            { "sub_1", "/Assets/tpp/ui/texture/Photo/tpp/10115/mb_photo_10115_010_1.ftex", 0.6,"cast_mosquito" },
            { "main_1", "/Assets/tpp/ui/texture/Photo/tpp/demo/mission_demo_s10115_02.ftex", 4.0 },
            { "main_2", "/Assets/tpp/ui/texture/Photo/tpp/demo/mission_demo_s10115_03.ftex", 7.1 },
            { "main_3", "/Assets/tpp/ui/texture/Photo/tpp/demo/mission_demo_s10115_04.ftex", 28.3 },
            { "hide", "main_1", 43.3 },
            { "hide", "main_2", 43.7 },
            { "hide", "main_3", 44.0 },
        },
    },
}
```

###### commonRadioTable

This table overrides common radio lines for various contexts, like
recovering an enemy soldier or prisoner, approaching an enemy
helicopter, being warned about leaving the mission area, etc. You can
also use `TppRadio.IGNORE_COMMON_RADIO` to completely disable that radio
call in your mission. See `TppRadio.COMMON_RADIO_LIST` for the radio
labels used for the `TppDefine.COMMON_RADIO` enum.

``` lua
this.commonRadioTable = {
    [ TppDefine.COMMON_RADIO.HOSTAGE_RECOVERED ] = TppRadio.IGNORE_COMMON_RADIO,
    [ TppDefine.COMMON_RADIO.SEARCH_TARGET_ENABLED ] = TppRadio.IGNORE_COMMON_RADIO,
    [ TppDefine.COMMON_RADIO.PLAYER_NEAR_ENEMY_HELI ] = "f1000_rtrg3781",
    [ TppDefine.COMMON_RADIO.OUTSIDE_MISSION_AREA ] = "s0150_rtrg0050",
    [ TppDefine.COMMON_RADIO.ABORT_BY_HELI ] = "s0260_rtrg0430"
}
```

##### Demo

The `demo` subscript defines callbacks related to cutscenes.

###### demoList

The `demoList` table defines internal `demoId`s to indexed with more
descriptive names used by functions like `TppDemo.Play()`.

``` lua
this.demoList = {
    Demo_ArrivalInAfghanistan       = "p31_010010",
    Demo_RescueMillerExplanation    = "p31_010020",
    Demo_GetIntel                   = "p31_010025",
    Demo_RescueMiller               = "p31_010030",
    Demo_TimeOverDeadMiller         = "p31_010035",
    Demo_ParasiteAppearance         = "p31_010040",
    Demo_ParasiteDiscover_upper     = "p31_010045",
    Demo_EscapeWithMillerOnHeli     = "p31_010050",
}
```

###### demoBlockList

The `demoBlockList` table defines the blocks that will get loaded for
specific cutscenes, using the more descriptive names from the `demoList`
table. This table is based on the `ScriptBlock` system, so you can load
multiple .fpk packs at once, but only one of these needs to have a
`ScriptBlockData` entity with the relevant script in it.

``` lua
this.demoBlockList = {
    Demo_SahelanTest        = { "/Assets/tpp/pack/mission2/story/s10070/s10070_d01.fpk" },
    Demo_GetIntel           = { "/Assets/tpp/pack/mission2/story/s10070/s10070_d07.fpk" },
    Demo_ContactHuey        = { "/Assets/tpp/pack/mission2/story/s10070/s10070_d02.fpk" },
    Demo_RideMetal          = { "/Assets/tpp/pack/mission2/story/s10070/s10070_d06.fpk" },
    Demo_SahelanHerald01    = {
        TppDefine.MISSION_COMMON_PACK.EAST_TRUCK,
        "/Assets/tpp/pack/mission2/story/s10070/s10070_d08.fpk"
    },
    Demo_SahelanHerald02    = { "/Assets/tpp/pack/mission2/story/s10070/s10070_d08.fpk" },
    Demo_SahelanAttacks     = {
        TppDefine.MISSION_COMMON_PACK.SKULLFACE,
        TppDefine.MISSION_COMMON_PACK.EAST_TRUCK,
        "/Assets/tpp/pack/mission2/story/s10070/s10070_d03.fpk",
    },
    Demo_SahelanFalling     = { "/Assets/tpp/pack/mission2/story/s10070/s10070_d04.fpk" },
    Demo_MotherBase         = { "/Assets/tpp/pack/mission2/story/s10070/s10070_d05.fpk" },
}
```

##### Sound

The `sound` subscript defines callbacks related to the mission's music,
like certain jingles, including the helicopter's descend track.

###### USE_COMMON_ESCAPE_BGM

If the `USE_COMMON_ESCAPE_BGM` bool is set to true and the `bgmList`
exists as a table in the subscript, the game will use the location's
common escape scene music.

``` lua
this.USE_COMMON_ESCAPE_BGM=true
```

###### bgmList

The `bgmList` table defines scene BGM event sets. They're indexed by
their name, which will get used with functions like
`TppSound.SetSceneBGM(...)`.

``` lua

this.bgmList = {
    bgm_volgin = {
        start = "Play_bgm_s10110_volgin_01",
        finish = "Stop_bgm_s10110_volgin_01",
        restore = "Set_Switch_bgm_boss_phase_none",
        switch = {
            "Set_Switch_bgm_boss_phase_al",
            "Set_Switch_bgm_boss_phase_ed",
            "Set_Switch_bgm_boss_phase_none",
            "Set_Switch_bgm_boss_phase_sn",
        },
    },
    bgm_south_africa = {
        start = "Play_bgm_s10080_south_africa",
        finish = "Stop_bgm_s10080_south_africa",
    },
}
```

###### missionStartTelopJingleName

The mission start telop jingle name is seemingly unused in the game's
vanilla missions. It seems to define the play event for the music that
plays at the start of the mission, and in the vanilla game, the only
unique ones that are heard are in free roam Afghanistan and Africa
helicopter entries.

``` lua
this.missionStartTelopJingleName="Play_bgm_afgh_jingle_op"
```

###### noRestorePhaseBGMList

This is seemingly unused entirely, all that's there is that the mvars
table it's turned into hashes the table's values, which are therefore
most likely the BGM set names.

###### showCreditJingleName

This overrides the event that plays the music in the mission's end
credits.

``` lua
this.showCreditJingleName = "Play_bgm_s10240_jingle_ed"
```

###### heliDescentJingleName

This overrides the event that plays when the mission can be cleared and
helicopter descends for the player to ride it.

``` lua
this.heliDescentJingleName = "Play_bgm_mission_heli_descent_low"
```

###### startHeliClearJingleName

This overrides the event that plays when the mission can be cleared and
you're riding the helicopter on your way to clear the mission.

``` lua
this.startHeliClearJingleName = "Play_bgm_mission_clear_heli_sad"
```

###### finishHeliClearJingleName

This overrides the event that ends the previously mentioned event's
music.

``` lua
this.finishHeliClearJingleName = "Stop_bgm_mission_clear_heli_sad"
```

##### Telop

The `telop` subscript defines the `langIds` for names appearing
mission's opening credits. It entirely consists of a few tables of
langIds.

###### mainCharacterLangList

The main character list defines the `langId`s credits for what main
characters are either the player or give support radio in the mission.
The vanilla game usually uses the given three standard main character
`langId`s.

``` lua
this.mainCharacterLangList = {
    "cast_venom_snake",
    "cast_kazuhira_miller",
    "cast_sharashka_ocelot"
}
```

Missions where supporting characters also provide support radio also
include those characters, specifically `"cast_code_talker"` and
`"cast_emmerich"`.

###### enemyCombatantsLangList

The enemy combatants list defines the `langId`s for credits for which
faction of enemy soldiers the player encounters in the mission. It can
be one group or multiple. This telop list is optional.

Commonly, one enemy combatants group `langId` is used:

``` lua
this.enemyCombatantsLangList = {
    "cast_soviet_soldiers"
}
```

Sometimes, multiple credits are shown, and always in a sub-table, as
well:

``` lua
this.enemyCombatantsLangList = {
    {
        "cast_soviet_soldiers",
        "cast_Spetsnaz"
    }
}
```

###### guestCharacterLangList

The guest character list defines the `langId`s for credits for mission
targets or optional targets in the mission. This table is optional.

Just like the enemy combatants list, a single `langId` is within the
table directly, but multiple have to be in a sub-table.

``` lua
this.guestCharacterLangList = {
    "cast_bionics_engineer"
}
```

``` lua
this.guestCharacterLangList = {
    {
        "cast_skull_face",
        "cast_tretij_rebenok",
        "cast_soldier_skulls",
        "cast_hamid_fighters_mujahid"
    }
}
```

###### specialMechanicLangList

The special mechanic list defines the `langId`s for credits for the
featured mechas in the mission, like armored vehicles, enemy
helicopters, Walker Gears or Sahelanthropus. This table is optional.

Like before, a single `langId` is within the table directly, but
multiple have to be in a sub-table.

``` lua
this.specialMechanicLangList = {
    "cast_tt-77"
}
```

``` lua
this.specialMechanicLangList = {
    {
        "cast_sahelanthropus",
        "cast_HP-48_Krokodil"
    }
}
```

###### missionWriter

The mission writer list defines the `langIds` for the mission's writers.
There can only be one or two writers - third or more will not display on
the screen. Unlike the previous three lists, this table does not use a
sub-table for multiple entries.

``` lua
this.missionWriter = {
    "staff_hideo_kojima",
    "staff_hidenari_inamura"
}
```

###### missionDirector

The mission director table is orphaned and is not used in `TppTelop`.

###### missionLevelDesigner

The mission level designer list defines the `langId`s first for the
mission's director / tuner, and second the mission location's level
designer. Unlike some of the previous lists, this does not need to use a
sub-table for multiple entries.

``` lua
this.missionLevelDesigner = {
    "staff_yuji_korekado",
    "staff_shinpei_yamamoto"
}
```

###### NO_MISSION_TELOP_ON_START_HELICOPTER

Skips DD logo with mission name on mission start if set to true.

```lua
this.NO_MISSION_TELOP_ON_START_HELICOPTER = true
```

##### Score

The `score` subscript defines time limits for certain mission ranks and
the max amount of tactical takedowns that count as bonuses to the score.
The only contents it ever has is the table `missionScoreTable`.

###### missionScoreTable

This table defines the base time in seconds for each mission completion
rank with `baseTime` and the count limit for tactical takedown bonuses
in with `tacticalTakeDownPoint`.

``` lua
this.missionScoreTable = {
    baseTime = {
        S = 720, A = 1380, B = 2370, C = 5928, D = 7836, E = 11754
    },
    tacticalTakeDownPoint = { countLimit = 40 },
}
```

### `wiki:wiki/Missions.md`

{:.small}

### `wiki:wiki/Route.md`

In TPP and GZ, the **route system** governs the behavior of AI agents
such as soldiers. Routes are stored in route sets, defined in
[FRT](/FRT) files.

frt files can be opened and created with [FoxKit](/FoxKit).
Further info
[here](https://github.com/youarebritish/FoxKit/wiki/Working-with-Route-Builder)

##### Overview

A route is a linear sequence of nodes, each of which has a location in
space. An agent acting along a route will travel from node to node, and
upon reaching the end of the route, they will return to the first node
and the route will repeat.

Although each agent only acts along one route at a time, multiple agents
may patrol the same route together. In addition, an AI agent is assigned
a number of routes, and which one they use at a given moment is dictated
by the alert status:

  - Sneak route: Used when the agent's CP is unaware of the player.
  - Caution route: Used when the encampment is on alert.
  - Alert route: Used during combat alert. Combat AI usually uses a
    unique system, however, so having an alert route defined is rare.

You can change an agent's sneak route in Lua by calling:

`GameObject.SendCommand(gameObjectId, { id="SetSneakRoute", route=routeId })`

where gameObjectId is the GameObject's ID (obtained through calling
GameObject.GetGameObjectId) and routeId is the name of the desired
route, for instance, rts_ptr_e_citadel_W_0000. The caution and
alert routes can be changed the same way, using "SetCautionRoute" and
"SetAlertRoute" respectively.

###### Other uses

Routes aren't only used for enemies. Helicopters also use routes,
particularly for defining the approach and departure behavior for Pequod
when using LZs.

##### Events

The most complex aspect of the route system are route events, and they
are still not fully understood. There are two classes of route events:

  - Node events are performed once an agent has arrived at a node.
  - Edge events are performed while an agent is on their way to a node.

An example of a node event is CautionStandIdleReady, which causes the
agent to stand idle in the caution stance. An example of an edge event
is RelaxedWalk, which causes the agent to walk in a leisurely way to the
node.

One of the most versatile node events is SendMessage, which can trigger
a message in Lua, allowing you to write custom code to invoke whenever
an agent arrives at that node.

As each event has different parameters, and not all of the event names
have been discovered yet, this is still an area of active research. If
interested, consider using
[FoxLib](https://github.com/youarebritish/FoxLib) to unpack, edit, and
create frt files to experiment with routes.

##### Notes

  - Assigning a soldier to a nonexistent route will not crash the game,
    but seems to make the soldier disappear.

##### See also

  - [Routes](/Routes)
  - [Route descriptions](/Route_descriptions)

### `wiki:wiki/Route_Set.md`

Route sets define groups of route names that will be used by the
specified command post to arrange its soldiers for time and phase-based
patrols, shift break routes, travel route groups, special Walker Gear
parking routes and weather-dependent routes. These do not define the
actual route data - that would be `.frt` Fox Route files, only one of
which can be loaded in an `.fpk` pack.

This is as minimal as you can get with a custom route set: one priority
route group, sneak day and night sets, and a caution set, along with an
empty hold route group.

``` lua
this.routeSets = {
    ms_13_34_ob = {
        priority = {
            "groupA",
        },
        sneak_day = {
            groupA = {
                "rts_d_ene01_13to34_0000",
                "rts_d_ene02_13to34_0000",
            },
        },
        sneak_night = {
            groupA = {
                "rts_n_ene01_13to34_0000",
                "rts_n_ene02_13to34_0000",
            },
        },
        caution = {
            groupA = {
                "rts_d_ene01_13to34_0000",
                "rts_d_ene01_13to34_0000",
            },
        },
        hold = {
            default = {},
        },
    },
    //...
}
```

##### Route Sets Lua Table

###### Parameters

###### USE_COMMON_ROUTE_SETS

Optional boolean flag. Set to true to use common route sets from
`afgh_routeSets.lua` or `mafr_routeSets.lua`. The merging is a complex
process if you define more custom route set types.

``` lua
this.routeSets={
    afgh_field_cp = {
        USE_COMMON_ROUTE_SETS = true,
        //...
    },
    //...
}
```

###### priority

List of shift-based route group names, listed in descending order of
priority. Usually named "groupA", "groupB", etc., but they're arbitrary.

``` lua
this.routeSets={
    afgh_field_cp = {
        priority = {
            "vip",
            "groupSniper",
            "groupA",
            "groupB",
            "groupC",
            "groupD",
        },
        //...
    },
    //...
}
```

###### fixedShiftChangeGroup

List of shift-based route group names that are fixed, meaning the
soldiers using these routes will not cross over into other route groups
on shift changes. Used commonly for VIPs, snipers, and other
importantly-placed soldier routes.

``` lua
this.routeSets={
    afgh_field_cp = {
        fixedShiftChangeGroup = {
            "vip",
            "groupSniper",
        },
        //...
    },
    //...
}
```

###### Shift-based grouped route sets

These route sets of groups change by shifts and phases, and are grouped
with names like the ones defined above. These route sets all follow the
same format:

``` lua
this.routeSets={
    afgh_field_cp = {
        sneak_day = {
            groupA = {
                "rt_field_d_0000",
                "rt_field_d_0002",
                "rt_field_d_0012",
                "rt_field_d_0013",
            },
            groupB = {
                "rt_field_d_0011",
                "rt_field_d_0010_sub",
                "rt_field_d_0014",
                "rt_field_d_0006",
            },
            //...
        },
        //...
    },
    //...
}
```

For route names that are meant to attract a soldier with a sniper rifle
or a VIP, you should use a table instead of a route, with the first
entry in the table being the route name, and the other, an `attr` string
that defines whether the route should only be used by snipers or a VIP.

``` lua
this.routeSets={
    mafr_lab_cp = {
        sneak_day = {
            vip = {
                { "rts_10093_d_0000", attr = "VIP" },
            },
            //...
        },
        //...
    },
    //...
}
```

``` lua
this.routeSets={
    afgh_remnants_cp = {
        sneak_day = {
            groupSniper = {
                { "rt_remnants_snp_0000", attr = "SNIPER" },
                { "rt_remnants_snp_0001", attr = "SNIPER" },
            },
            //...
        },
        //...
    },
    //...
}
```

###### sneak_day

Sets of groups of routes used in the Sneak phase in the daytime,
starting from 06:04:33.

###### sneak_night

Used in the Sneak phase in the nighttime, starting from 18:14:13. When
the set `sneak_midnight` is not defined, which is always in the vanilla
game, is also used starting from 22:00:00.

###### sneak_midnight

Used in the Sneak phase around midnight, starting from 22:00:00. Never
used in the vanilla game, but seemingly can still be used. When it's not
defined, `sneak_night` overwrites it.

###### caution

Used in the Caution phase. Usually all routes are stored into the first
route group, leaving other route groups as empty tables.

###### hold

Used for extra soldiers who don't get a free route in other route groups
on shift changes in the Sneak phase in the daytime. Usually uses an
undefined `default` route group, but seemingly per-route group hold and
sleep routes can be used. Is usually always there, even if it's empty,
as in contains an empty table of a `default` route group.

``` lua
this.routeSets={
    afgh_field_cp = {
        hold = {
            default = {
                "rt_field_h_0000",
                "rt_field_h_0001",
                "rt_field_h_0002",
                "rt_field_h_0003",
            },
            //...
        },
        //...
    },
    //...
}
```

###### sleep

Just like `hold` above, but for nighttime, and has sleep routes where
soldiers sleep while sitting or lying on beds.

###### Other

###### travel

This route set's route groups are fully managed by the travel plan
system, they are not at all affected by priority, the fixed list, shifts
or phases. The route groups expected here can be used for the
reinforcements system or by simplified travel plans.

###### lrrpHold

This route group that appears in guard posts (`_ob`) and command posts
(`_cp`) is used by simplified travel plans. The routes in it are for
soldiers smoking in a spot where the LRRP patrol stays at the CP after
moving into it and before moving out of it. Usually has two different
routes.

``` lua
this.routeSets={
    afgh_field_cp = {
        travel = {
            lrrpHold = {
                "rt_field_l_0000",
                "rt_field_l_0001",
            },
            //...
        },
        //...
    },
    //...
}
```

###### lrrp_%02dto%02d

These route groups that appear in LRRP CPs (`_lrrp`) between the indexed
CPs in its name. These usually contain two duplicate names of the same
route that leads from the first indexed CP and to the other, and the
soldiers driving a vehicle or walking along that route will be
synchronized that way. Used by simplified travel plans. For simplified
travel plans, the LRRP CP name should also be formatted in
`%s_%02d_%02d_lrrp`, with the four letter location name at the start and
the first CP index being the lesser number to the second. The indices
are defined for vanilla locations in `afgh_travelPlans.lua` and
`mafr_travelPlans.lua`, or in the enemy subscript's `lrrpNumberDefine`
and `cpLink` tables, which are never used in the vanilla game.

``` lua
this.routeSets={
    afgh_field_cp = {
        travel = {
            lrrp_01to13 = {
                "rt_01to13_0000",
                "rt_01to13_0000",
            },
            lrrp_13to01 = {
                "rt_13to01_0000",
                "rt_13to01_0000",
            },
            //...
        },
        //...
    },
    //...
}
```

Formatted name examples would be: `lrrp_01to13`, `lrrp_21to20`.

###### rp_%02dto%02d

Just like `lrrp_%02dto%02d` above, but used by reinforcement plans. Has
four duplicate route names instead, and those route names can be the
same as the two `lrrp_%02dto%02d` has.

``` lua
this.routeSets={
    afgh_field_cp = {
        travel = {
            rp_01to13 = {
                "rt_01to13_0000",
                "rt_01to13_0000",
                "rt_01to13_0000",
                "rt_01to13_0000",
            },
            rp_13to01 = {
                "rt_13to01_0000",
                "rt_13to01_0000",
                "rt_13to01_0000",
                "rt_13to01_0000",
            },
            //...
        },
        //...
    },
    //...
}
```

###### walkergearpark

A list of routes that soldiers will leave Walker Gears at when they
return to the Sneak phase. These are not grouped and are just a direct
list of routes for the CP, which can't be merged into the common route
set.

``` lua
this.routeSets={
    afgh_sovietBase_cp = {
        walkergearpark = {
            "rts_sovietBase_walkerGearPark0000",
            "rts_sovietBase_walkerGearPark0001",
            "rts_sovietBase_walkerGearPark0002",
        },
        //...
    },
    //...
}
```

###### outofrain

A list of routes soldiers will temporarily use when it rains or a
sandstorm comes in. Usually they're placed indoors or under a roof.
These are also not grouped and are a direct list of routes, which also
can't be merged into the common route set.

``` lua
this.routeSets={
    afgh_sovietBase_cp = {
        outofrain = {
            "rt_field_r_0000",
            "rt_field_r_0001",
            "rt_field_r_0002",
            "rt_field_r_0003",
            "rt_field_r_0004",
            "rt_field_r_0005",
            "rt_field_r_0006",
            "rt_field_r_0007",
            "rt_field_r_0008",
            "rt_field_r_0009",
            "rt_field_r_0010",
            "rt_field_r_0011",
            "rt_field_r_0012",
            "rt_field_r_0013",
            "rt_field_r_0014",
            "rt_field_r_0015",
            "rt_field_r_0016",
        },
        //...
    },
    //...
}
```

### `wiki:wiki/Route_descriptions.md`

Use this page to summarize interesting routes from the main game. Be
sure to note where the route is located, where it's used in the game,
and what it does.

##### cypr

List Cyprus routes here.

##### afgh

###### s10040.frt

Used in the mission "Where Do the Bees Sleep?"

###### 1478413963

  - Type: Sneak
  - Location: Da Smasei Laman (Smasei Fort)
  - Note: Route starts in the entrance to the building in the back, to
    the left and up the arch before turning right to move towards and
    through the balcony out in the open going down into the caves system
    into the room where the honeybee is located in the main mission.

###### rt_bridge_c_0009

  - Type: Caution
  - Location: Mountain Relay Base
  - Notes: TODO, just an example. Write up a summary of what happens in
    the route.

##### mafr

List Middle Africa routes here.

##### mtbs

List Mother Base routes here.

### `wiki:wiki/Routes.md`

If you discover anything interesting or useful about routes or route
events, please feel free to document them here for others to learn from.
This page can be a general repository of unsorted route-related
information. If your findings are complicated or in-depth, consider
creating a separate page for them.

{:.small}

##### Introduction

![Edge Node : Relaxed Walk](/assets/EdgeNode.jpg){:.thumb .legacy-small width="268px"} Each Event Node has ten parameters.
And each parameter defines a behavior for the event as well as each
event has very specific parameters. There is no event that has used all
ten parameters.

Even the Edge Node can contain numbers in the ten parameters. An
interesting one is while using Relaxed Walk there is a parameter to make
the Soldier stare at something while moving.

![Event Node : Relaxed Idle Act with parameters filled](/assets/EventNode.jpg){:.thumb .legacy-small width="267px"}

##### Relaxed Idle Act and Caution Idle Act \[event node\]

These two events are simple to use. Only three parameters out of ten are
needed to run.

**Param0**. 1, There are other values but for now 1 is enough for these
two Events.

**Param1**. It holds values where the event will point to a specific
direction, as well as hold for a brief time what has been chosen in
Param6. For this there are unique numbers intended for this.
![Old Param1](/assets/Param1%20Unique%20Numbers%20.jpg){:.thumb .legacy-small width="166px"} *Values to used in
vanilla routes' Param1*

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

The values in Param1 are actually two shorts - rotation and afterward
the wait time, but currently FoxKit's Route Builder reads them as one
integer. To more accurately edit Param1, you can convert the integer
from a decimal a hexadecimal format and edit the first and last half
separately.

The rotation value ranges from **0** to **65535**/**FFFFh**, rotating
counter-clockwise.

**479**/**01DFh** is the most common wait time value.

**Param6**. Display specific behavior/animations.

|                    |                           |                                                |
| ------------------ | ------------------------- | ---------------------------------------------- |
| Name string        | StrCode32 hash in decimal | Description and notes                          |
| StandActNormal     | 496717012                 | Looking forward                                |
| StandActIdleStill  | 1049359963                | Standing still, no acting                      |
| StandActKick       | 2135364818                | Relaxed kick with a sound effect               |
| TBA                | 3641544758                | Slow start, sneak into caution, left and right |
| TBA                | 4293802043                | Attack box with rifle (10040)                  |
| StandActWalkAround | 2277088634                | Stepping around                                |
| StandActSmoking    | 2014502296                | Smoking                                        |
| TBA                | 911690047                 | Sleeping in a bed                              |
| TBA                | 4113090604                | Guy sleeping sitting                           |

###### **Relaxed Stand Idle**

The mostly simple one. Just hold a value 1 in Param0 and a list of
Unique Numbers in Param2 for wait idle and rotation. It is slightly
different from **Relaxed Idle Act.**

##### Caution Stand Idle Aim/ Caution Squat Idle Aim \[event node\]

As the name itself says these Events Nodes works to aim at something.
Also it take part another Node that will be treated as the target of the
scope (Edge Move and Event Wait)

**Param0**. There are two values that work here, not just "1". Route As
Sight Move Path and Route As Object. The others somehow get in the way.

  - **No target** = 1. It works fine. In fact I'm astonished that it
    works exactly like the Route As Sight Move Path

<!-- end list -->

  - **Static Point** = 257. This aim type will make the soldier look at
    static point in space at the coordinates defined in Param2 (x),
    Param3 (y) and Param4 (z), as float values converted to decimal.

<!-- end list -->

  - **Character** = 513. This aim type will make the soldier look at an
    entity defined by a StrCode32 hash of a GameObjectLocator's name in
    a Param.

<!-- end list -->

  - '''Route As Sight Move Path '''= 769.  This aim type will make the
    soldier's looking target follow a route, the StrCode32 hash of which
    is placed in Param2. And if the target follows a movement of Edge
    Node "Move", "Move Slow", "Move Normal" and "Move Fast" the Event
    Node Aim will follow the movement.

<!-- end list -->

  - **Route As Object** = 1025. Sorry for that but I haven't not tested
    this value yet. But it should be similar to 769.

**Param1**. It holds values where the event will point to a specific
direction. Unique Numbers to use in Param1 ![A simple Route to Sight a target called Bait](/assets/Setting%20up%20a%20Aim.jpg){:.thumb .legacy-small width="395px"}
<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

**Param2**. Holds a number that means the target of the sight. Any Node
can be a target. Even moving.

So if you create a Node called "Target". And if you convert Target to
number, 2924226716. This will be the value to be placed in Param2.

See *Edge Move and Event Wait* to set better Targets.

**Param3**. It holds a **Empty String** "", which is **3205930904**.
These could also be a set of coordinates for a static point in space,
possibly used in case the target route isn't there.

**Param4**. Same as Param3.

**Param5**. Same as Param3 and 4. However this parameter seems to be
dispensable. Since in some cases it worked even without any value.

###### **Edge Move and Event Wait**

'''
Both the Edge Move and the Event Wait are indispensable for the Aim to
work with more realism, I must say.

Edge Move works like a Relaxed Walk and Run, Caution Walk and Run. There
is slow, normal and fast.

Event Wait is similar to Act idle. And hold only two Parameters.

**Param0**. 1

**Param1**. Set the Aim to hold for a brief moment before switching to
another Node. Unique Numbers to use here.

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

##### Relaxed Walk \[edge node\]

This edge node also have parameters. A simple one is while the node move
it can target another route. I mean, the soldier while walking can turn
his head and stare to something instead of looking straight like a
robot.

It works the same as above in the Aim nodes. But Edges events have
values -1 in Param0. So if Param0 is 769 to event node, for edge node
should be 768 otherwise will not work.

Param2 is the string of another Route that should do the soldier to look
at. Param3, 4 and 5 holds a fixed number '''3205930904. '''Which is just
a empty string.

This edge paramaters is usuful to a enemy guard scan better areas while
walking.

##### Conversation Idle \[event node\]

A simple Event Node that triggers a specific conversation. Using this
Node will cause a conversation to be on one side only. To create more
specific situations it would be necessary to define it by scripting.
Even so, here are some parameters that work, although simple.

**Param0**. 1

**Param1**. It holds values where the event will point to a specific
direction, as well as hold for a brief time what has been chosen in
Param6. For this there are unique numbers intended for this.

*Unique Numbers to use in Param1*

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

**Param6**: String as S32 unit. Use the above strings and convert to
numbers. I mean.. “USSR_story_04” is converted to 1380492315. So use
this number in Param6. You may find this
[here](https://github.com/TinManTex/mgsv-deminified-lua/blob/fb0254475fee5978ac38d968d5b75f41ca072f2c/data1/Assets/tpp/script/lib/TppEnemy.lua)

**Param7**. Does not need any value to work actually but this one point
to another route. So if you want to link together two soldiers in
conversation. "sol_quest_0000" should be 1856151639 as example.

By Script:

`--  CallConversation`
`this.CallConversation = function( speakerGameObjectId, friendGameObjectId, speechLabel )   `

`   local speakerGameObjectId   = "sol_vip"`
`   local friendGameObjectId    = "sol_vip2"`
`   local speechLabel = "CT10195_01" -- A conversation`

`   if Tpp.IsTypeString( speakerGameObjectId ) then`
`       speakerGameObjectId = GameObject.GetGameObjectId( speakerGameObjectId )`
`   end`
`   if Tpp.IsTypeString( friendGameObjectId ) then`
`       friendGameObjectId = GameObject.GetGameObjectId( friendGameObjectId )`
`   end`

`   local command = { id = "CallConversation", label = speechLabel, friend  = friendGameObjectId, } -- Im sure using this will set a conversation between two listeners.`
`   GameObject.SendCommand( speakerGameObjectId, command )`

`end`

The speech should be a string that fires some dialogue inside the .spch
files. Right now the file is not reversed to be made from scratch but
its possible to reuse some **special speech** like the one in the
mission s10036 "A Heroes Way", located in
s10036_area_fpk\\Assets\\tpp\\level\\mission2\\story\\s10036\\speech_data_s10036_Vip.spch

And if you see the lua file enemy in
s10036_area_fpkd\\Assets\\tpp\\level\\mission2\\story\\s10036\\s10036_enemy.lua

It calls the speechlabel "VIP_001".

But using special speechs needs to be loaded in a fox2 file with
'''TppSpeechData. '''

##### Send Message \[event node\]

I think the best possible Node Event. It can activate any command
including AI such as SetCommandAi (FORCE_SHOOT, SHOOT_PRACTICE,
FORCE_WAIT, SHOOT_ROCKET). Send Message can work with at least three
parameters (Param0, Param1 and Param7). Although it is possible to
access other parameters, currently unknown.

**Param0**: 1

**Param1**. It holds values where the event will point to a specific
direction, as well as hold for a brief time what has been chosen in
Param6. For this there are unique numbers intended for this.

*Unique Numbers to use in Param1*

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

**Param6**: Sometimes it have 4 to 6 numbers. But I have not figured out
anything that might make sense. It is possible to ignore this param.

**Param7**: This parameter is what sends a message. If you wrote "doIt"
and turned this string into numbers. That will be 1780500634. String As
32 uint. This number is what will be placed in this parameter.

After that just write a code that identifies the string "doIt" and then
some script.

`if messageId == StrCode32( "doIt" ) then`
`  this.NowYes("sol_quest_0003") -- function whatever`

A simple example to trigger a soldier to kill a hostage.

`function this.SoldierWantsToKillThatHostage ( soldierName )`

`  local soldierId = GameObject.GetGameObjectId("TppSoldier2", soldierName ) -- `
`  local hostageId = GameObject.GetGameObjectId("TppHostageUnique2", "Hostage_0" ) `
`  local command = { id="SetExecuteHostage", targetId=hostageId } `
`  GameObject.SendCommand( soldierId, command ) `

`end`

`this.Messages = function()`
`  return`
`    StrCode32Table`
`      {        `
`        GameObject = `
`     {`
`       {   `
`              msg = "RoutePoint2", `
`         func = function (gameObjectId, routeId ,routeNode, messageId )`
`       if messageId == StrCode32( "doIt" ) then`
`       this.SoldierWantsToKillThatHostage("sol_quest_0000")`
`       end `
`         end`
`       },`
`     },`
`      }`
`end`

![](/assets/SendMessage.jpg){:.thumb .legacy-small width="226px"}

**Param8**: Sometimes it have 4 to 6 numbers. But I have not figured out
anything that might make sense. It is possible to ignore this param.

**Param9**: Sometimes it have 4 to 6 numbers. But I have not figured out
anything that might make sense. It is possible to ignore this param.

##### Caution Stand Fire/ Caution Squat Fire \[event node\]

![](/assets/Sphere%20of%20possibilities%20lol.jpg){:.thumb .legacy-small width="387px"}
Using the right parameters this event fires steady shots in a certain
direction. It's a bit confusing as to what parameters to set for the
direction of the shots. Here is an image that illustrates the dimension
of where to shoot.

**Param0**: If for **1** as value will not activate the shots. The
soldier will just stand and stare. **257** static point is the value
that really works. **769** activates the shot but can not move to a
certain direction. So use 257 to continue.

**Param1**. Here it hold for a brief time the shoot. If set **0** the
enemy will constantly shoot. For this there are unique numbers intended
below.

*Unique Numbers to use in Param1*

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

The next three parameters, Param2, Param3 and Param4 will set the
direction of the fire. Its a bit confusing choose the right numbers as
the three values depends of each one to work. Setting 0 in the three
params will be the safety zone and the default direction.
![](/assets/Fire%20Parameters.jpg){:.thumb width="508px"} **Param2**: 0

**Param3**: 0

**Param4**: 0

Those values may vary a lot. It can set one direction different values
than what it show in the image.

Using Cheat Engine to change those values ingame can be very helpful.

##### Vehicle Move Fast/Normal/Slow \[event node\]

Simple to use it. To work it just need to choose a unique id number at
Param6. Some routes use more parameters for more complex AI, but
currently unknown how to use it.

The unique number to be set in **Param6** can be find looking at the
vanilla routes. Taking the Field Area as example and looking inside the
s10036_area.frt.

Look at the image, there is four unique numbers divided along the small
cp to the field cp and then goes to another small cp.
![](/assets/Field%20Area.jpg){:.thumb width="439px"} So.. If you want to
do a route where a vehicle start at the small cp 22 and goes trhough the
field cp (Shago Kallai) to end at the small cp 25 just use those numbers
in param6.

Some routes in story mission have one unique number to pass all the road
instead of using slices of the road. In s10036_area.frt the vip vehicle
start at small cp 25 and travel to the shago village with just
**3554650167**, instead of using 2662551924 and 1108895110.

Currently unknown what those numbers means.

As you see, its a lot of work to figure out which unique id every road
have inside the Vanilla Routes. But with those four numbers in the image
above it is a start to have a lot of fun see vehicles moving. Its
possible to spawn a vehicle in the Shago Village that holds the number
2510639541 which belongs to the road outside of where the vehicle spawn
and yet the vehicle will try to move there no matter what. Lots of fun
because the model keeps try to running throught the map like crazy.

##### Switch Route

A Condition route. Though using SendMessage is much more easy to have a
condition switch route is pretty much used to change a route to
something linked to a gimmick location, resource or passage of time.
SwitchRoute always use two routes to work. The conditions names for it
are:

"IsNotGimmickBroken" - 665243854

"IsGimmickBroken" - 844380222

"CanUseSearchLight" - 1327217007

"CanNotUseSearchLight" - 1982248506

The first example can be this one. A route that will switch to another
route to use a Search Light equipament once isNight. The first one
called **rts_walkingAtDay_00** and the second route
**rts_usingSearchLightAtNight_00**.

**rts_walkingAtDay_00**

**Param0**: 1

**Param1**. It holds values where the event will point to a specific
direction, as well as hold for a brief time what has been chosen in
Param6. For this there are unique numbers intended for this.

*Unique Numbers to use in Param1*

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

**Param6**: Point to the route '''rts_usingSearchLightAtNight_00,
'''which is 3067857059.

**Param7**: Is where holds the conditionName. In this case
CanUseSearchLight, 1327217007
![](/assets/Gimmick%20lua%20table%20entries.png){:.thumb} **Param8**: Is
the gimmick id of the searchlight gimmick. In this case I will use a
gimmick id from Afghanistan, the locatorName of which is
"gntn_srlg001_vrtn002_gim_n0002|srt_gntn_srlg001_gm" in
*/Assets/tpp/level/location/afgh/block_large/field/afgh_field_gimmick.fox2*.
We can find its gimmick id to use in this parameter in the location's
gimmick script, located in
*Assets\\tpp\\pack\\location\\afgh\\pack_common\\afgh_script_fpkd\\Assets\\tpp\\script\\location\\afgh\\afgh_gimmick.lua*.
With the .fox2 path and locatorName, we'll find the gimmick id used by
the gimmick tables within that script's gimmickIdentifierParamTable,
here it being "*field_light003*," which is 4280345761 in StrCode32
decimal. This is what we'll use for Param 8.

So... In this Route **rts_walkingAtDay_00** if the condition used is
CanUseSearchLight and once the passage of time becames Night it will
switchRoute to '''rts_usingSearchLightAtNight_00. '''Now the second
route...

**rts_usingSearchLightAtNight_00**

**Param0**: 1

**Param1**. It holds values where the event will point to a specific
direction, as well as hold for a brief time what has been chosen in
Param6. For this there are unique numbers intended for this.

*Unique Numbers to use in Param1*

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

**Param6**: Point to the route '''rts_usingSearchLightAtNight_00,
'''which is 3067857059. This maybe keep a loop. If the route name to be
**rts_walkingAtDay_00** may break the loop?

**Param7**: Is where holds the conditionName. In this case now it use
CanNotUseSearchLight, 1982248506. Means that once the Night is over the
Route will switch to **rts_walkingAtDay_00.**

**Param8**: Is the same gimmick used in **rts_walkingAtDay_00.**

But, switchroute is just a Event that change to another route. Once the
condition is true it needs to have another event such Relaxed Idle, Aim,
Fire and so on. In this case as the route is using Search Light there is
a event called **UseSearchLight.**

###### UseSearchLight

**Param0**: 16777985

**Param1**. It holds values where the event will point to a specific
direction, as well as hold for a brief time what has been chosen in
Param6. For this there are unique numbers intended for this.

*Unique Numbers to use in Param1*

<https://github.com/TinManTex/mgsv-lookup-strings/blob/master/RouteTool/Hashes/Tpp/Previous/routeEventMessages_unique.txt>

**Param6**: Works the same as Aim. So the seacrhLight will move
alongside of the path of this route the same way in Caution Stand Idle
Aim.

**Param3, 4 and 5**: It holds a **Empty String** "", which is
**3205930904.** ![](/assets/SwitchRoute.jpg){:.thumb .legacy-small width="373px"}

And there it is. Im still figure out how to use the other conditionName
'''IsGimmickBroken. '''So far it use to access gimmick WatchTower and
Mortars, heavy equipament and so on.

##### Use Flash Light and 1875147223

UseFlashLight a node event that has no unique parameters, but when
soldiers use it, they will shine a flashlight at their sight target. In
the daytime, UseFlashLight will instead use a Caution Idle Search-like
animation, however the still unhashed 1875147223 node event will use the
flashlight animation even in the daytime.
[Category:FRT](/Category:FRT "wikilink")