About this reference

V Framework loads as an Infinite Heaven module. Its libraries become global Lua tables available to mission modules and other loaded scripts.

V_TppUiCommand.SetEmergencyMissionPopup(
  "Emergency!",
  "Mother Base is under attack!"
)

V_TppUiCommand.SetMissionEmergency(10070, true)

Mission-specific overrides reset when the mission reloads. Most libraries also provide explicit Clear*, Unset*, or reset functions.

Soldiers and hostages may usually be referenced by name or gameObjectId.

This page has three parts: Lua libraries, SendCommand and Messages.

Lua libraries

Core

Pickable

Live editing of pickables placed in the stage (weapons, items and supplies lying in the world). Address a pickable either by its locator index (TppPickable.GetLocatorIndex) or directly by its stage locator name.

Keys of the info table (every key is optional in setters; getters return them all plus locatorIndex):

local idx = TppPickable.GetLocatorIndex("wp_loc0001")
V_Pickable.SetInfoByLocatorIndex(idx, {
  countRaw = 300,
  countMax = 300,
})

V_Pickable.SetInfoByLocatorName("wp_loc0002", {
  equipId = 44,       -- any equip id, e.g. a TppEquip constant
  countRaw = 90,
  countMax = 90,
})

-- read everything back
local info = V_Pickable.GetInfoByLocatorIndex(idx)
if info then
  V_FrameWork.Log("equip " .. info.equipId .. " count " .. info.countRaw)
end

Overrides persist for the whole game session and re-apply whenever the stage rebuilds its pickables. They are keyed by locator index, so an index-based override set on one map also applies to that index on other maps. When raising a weapon pickup’s ammo, set countMax together with countRaw, otherwise the magazine fill stays clamped at the vanilla value. Ammo boxes do not use countRaw as a quantity - leave those untouched.

Collectibles

World collectibles - the plants, diamonds, and emblems lying around a location. Custom types can be registered and placed anywhere.

Setters take either the type name or its numeric id. Registering also publishes the id as TppCollection.<name>, which is how you compare it later.

V_TppCollection.RegisterCollectionType("MyMod:Collect",
{
  Model = "/Assets/tpp/item/ibo/Scenes/ibo6_main0_def.fmdl",

  Color            = {r = 1, g = 0, b = 0, a = 0.5},
  Strength         = {x = 0.5, y = 1.0, z = 0.5, w = 1.0},
  Yoffset          = 0.25,
  GroundEffectSize = 0.4,

  RootModel  = "/Assets/.../stump.fmdl",
  Fova       = "/Assets/.../variation.fv2",
  IsHerb     = false,
  IsMaterial = false,
  IsDiamond  = false,
})

V_TppCollection.AddCollection("MyCollect_00", "MyMod:Collect", 185.1, 336.3, 156.8, 90) -- Quickly spawns it in the world.

Player

Voice overrides

The package and the voice type have to agree, or the package loads silent. The voice type names and numbers, and the per-voice voiceFpk table, are covered under Outfit voice.

Energy Wall

CQC

Quiet’s CQC

In the vanilla game, Quiet can’t hold enemies with CQC nor interrogate them. These two functions enable that and they can also be toggled via IH in V Framework menu.

V_Player.SetQuietHoldCqc(true)
V_Player.SetQuietInterrogate(true)

These never apply in FOB.

Demo attachment

Rides the player on another game object’s connect point for the duration of a demo.

V_Player.RequestToAttachInDemo{ ownerId = GetGameObjectId"Cargo_Truck_WEST_001", connectPoint = "CNP_DECK_A", unattachOnSleep = false }

Space check

if V_Player.IsThereEnoughSpaceAroundPlayer( -2.5, 2.5, -2.5, 1.5 ) == false then
  -- cramped: take the fallback path
end

Custom outfits

See V Framework Custom Outfits.

key is the same string you passed to RegisterOutfit, either positionally or as { key = "..." }. An unknown key returns false.

local partsType, selectorCode, developId = V_Player.GetOutfitInfo("MyOutfit")

Equipment

See V Framework Custom Weapons for the complete weapon-building guide.

Equip IDs

Each AddToEquipIdTable row contains six positional values:

{
  equipId,
  equipType,
  subId,
  block,
  partsPath,
  packPath,
}

Example:

V_TppEquip.AddToEquipIdTable({
  {
    TppEquip.EQP_WP_Com_sg_020,
    TppEquip.EQP_TYPE_Shotgun,
    TppEquip.WP_Com_sg_020,
    TppEquip.EQP_BLOCK_MISSION,
    "/Assets/tpp/parts/weapon/assemble/shg/sg04_main0_aw0_v00.parts",
    "/Assets/tpp/pack/collectible/primary/EQP_WP_Com_sg_020.fpk",
  },
})

Malformed rows are skipped. Valid custom rows are reapplied after the game reloads its equip table.

Only weapons may use the EQP_WP_ name prefix - the allocator routes those names into the equip table’s weapon id band. The per-boot log line [EquipIdCompression] native occupancy: item band N free of 559, weapon band N free of 89 shows the shared budget all installed mods draw from.

Weapon-part declarations

V_TppEquip.DeclareWPs { "WP_A", "WP_B" }   --> 2
V_TppEquip.DeclareWPs("WP_A")              --> the assigned number, or false

SetOption also carries the laser’s colour and appearance - laserColor plus the laser* tuning fields. See Custom Weapons. | DeclareDamages | TppDamage.ATK_* | SetDamage |

Each of these reserves a real part slot in the engine’s parameter tables, which is what lets a custom part behave differently from every vanilla one.

Other constant spaces

These declare into the remaining spaces. They take the same argument shape - a table of name strings - and publish under TppEquip the same way:

V_TppEquip.DeclareTriggers    { "TRIGGER_Example" }
V_TppEquip.DeclareBulletTypes { "BULLET_TYPE_Example" }

Receiver sound (receiverParamSetsSound)

SetReceiver’s receiverParamSetsSound accepts a root string, a vanilla row index, or a table { name, middle, event, sup, supEvent } - sup (a root) and supEvent (an exact event name) pick the suppressed-shot sound independently of the loud one. See Fire sound for every form.

Cross-family handling

Unusable donors are refused and no mapping is registered; in a release build that refusal is silent. See Cross-family handling for the full description.

Receiver motion

Every field is documented in Custom gun motion.

Remote-controlled missile

Only equipId/receiverId is required.

Mother Base Management

Every function in this section belongs to V_TppMotherBaseManagement.

ACC change-location menu

AddToChangeLocationMenu takes a plain array of numeric location codes; each one becomes an entry in the ACC change-location menu:

V_TppMotherBaseManagement.AddToChangeLocationMenu{
  40,   -- Gntn
}

VI photo text

AddPhotoAdditionalText takes an array of row tables. missionCode, photoId, and photoType are required numbers - a row missing any of them is skipped. targetTypeLangId is the language-entry name of the text shown on the photo:

V_TppMotherBaseManagement.AddPhotoAdditionalText{
  {
    missionCode      = 10043,
    photoId          = 0,
    photoType        = 0,
    targetTypeLangId = "example_photo_text",
  },
}

AddToEquipDevelopTable

local developId =
  V_TppMotherBaseManagement.AddToEquipDevelopTable(
    "MyMod:MySuit",
    {
      const = {
        equipID            = TppEquip.EQP_SUIT,
        equipDevelopTypeID = TppMbDev.EQP_DEV_TYPE_Suit,
        langEquipName      = "my_suit_name",
        iconFtexPath       = "/Assets/.../ui_icon_alp",
      },

      flow = {
        grade            = 3,
        developGmpCost   = 500,
        initialAvailable = 0,
      },
    }
  )

developId and flowIndex are allocated automatically from the record key. Do not supply them manually.

Readable names and raw pNN names are both accepted.

Important const fields

bluePrintId forms

-- Always visible
bluePrintId = 65535

-- Live condition
bluePrintId = function()
  return TppStory.IsMissionCleard(10080)
end

-- Real vanilla blueprint/design
bluePrintId = TppMotherBaseManagementConst.DESIGN_2001

-- Custom blueprint, by key or by id - both are equivalent
bluePrintId = "MyMod_AK50"
bluePrintId = TppMotherBaseManagementConst.MyMod_AK50

Function predicates are checked whenever the R&D menu builds, allowing rows to appear or disappear during the session.

Important flow fields

The framework automatically repairs invalid grade and side-branch collisions and writes a warning to the log.

Develop record state

SetEquipDevelopVisible can reveal a hidden item immediately. Revealing an item still marked NEW also triggers its requirements-met announcement.

DataBase entries

A DataBase entry is the slot the iDroid DATABASE is built out of. The game uses one kind for all of it - blueprints, key items, photos, animals, posters, codenames and medicinal plants are the same thing with a different category.

Registering gives an entry an identity, a row and an obtained flag. It does not make the entry behave like its category - that part is always yours to add

Registering also publishes the id as a constant under both TppMotherBaseManagementConst and V_TppMotherBaseManagement, provided the key is a valid Lua identifier - so MyMod_AK50 over MyMod:AK50 if you want TppMotherBaseManagementConst.MyMod_AK50 to exist.

The iDroid DATABASE entry

A registered entry gets no DATABASE row of its own until you describe it. SetDataBaseDisplay supplies the row’s name, icons, description and tab.

local bpId = V_TppMotherBaseManagement.RegisterDataBase("MyMod_Rsh12")

V_TppMotherBaseManagement.SetDataBaseDisplay{
  dataBaseId  = bpId,
  langDocName = "langId_name",
  langDocInfo = "langId_desc",
  docIcon     = "/Assets/tpp/ui/texture/Resource/keyitem/icon/ui_kit_devdata_sr_alp.ftex",
  docImage    = "/Assets/tpp/ui/texture/Resource/keyitem/image/ui_kit_devdata_sr.ftex",
  tab         = V_TppDataBase.TAB_BLUEPRINT,
}

TppTerminal.BLUE_PRINT_LANG_ID[bpId] = "langId_name"
TppTerminal.keyItemAnnounceLogTable[bpId] = "langId_name"
TppTerminal.keyItemRewardTable[bpId] = "langId_name"

Choosing a tab

tab takes any value in V_TppDataBase. The game builds a list for seven of the nine categories; the other two are rejected with a log rather than accepted into a row that could never appear.

The tabs are split across two screens:

Unique staff

A unique staff record is one named, hand-authored Mother Base staffer. Ocelot, Miller, Code Talker and the special soldiers are all vanilla examples. Registering one gives it a name, a face, a skill and six section-point values. Putting it on a soldier or hostage in a mission is a separate step, covered below.

Vanilla TppMotherBaseManagement.RegisterUniqueStaff takes a uniqueTypeId number you pick yourself, nothing detects a clash, and two mods that pick the same number silently overwrite one another. V Framework takes a key instead and allocates the number:

local id = V_TppMotherBaseManagement.RegisterUniqueStaff{
  key = "MyMod.Medic13106",
  -- ...
}

Required fields

The game discards a unique staff record that is missing any one of these

• no error, no log, the staff simply never exists. V Framework checks them first and logs the field that is missing or has the wrong type.

nameLangMessageId must name an entry in your lang files. Unique staff have no generated fallback name, so a missing entry shows as blank.

These are optional:

V_TppMotherBaseManagement.RegisterUniqueStaff{
  key                 = "MyMod.Medic13106",
  missionId           = 13106,
  skill               = "Surgeon",
  nameLangMessageId   = "my_staff_13106_medic",
  faceId              = 120,

  combatSectionPoint  = 40,
  developSectionPoint = 55,
  baseDevSectionPoint = 45,
  supportSectionPoint = 50,
  spySectionPoint     = 35,
  medicalSectionPoint = 110,

  isEnmity            = false,
  moraleEnmity        = 7,
  condition           = "Normal",
  badConditionWeight  = 3,

  langProficEnglish   = true,
  langProficRussian   = false,
  langProficPashto    = false,
  langProficKikongo   = false,
  langProficAfrikaans = false,
}

Placing the staff in a mission

Registering creates the record. It does not put anyone in a mission - that is a separate step in the mission’s own scripts, outside V Framework. What V Framework gives you is the id to hand to it:

local id = V_TppMotherBaseManagement.GetUniqueStaffTypeId("MyMod.Medic13106")

Returns nil if the key was never registered, so check it before use.

Sound

SetMissionPreparationMusic

V_TppSoundDaemon.SetMissionPreparationMusic("Play_bgm_my_track", "Stop_bgm_my_track")

The function returns true on success. Both events are required, since the stop event is what silences the track when the player leaves the screen.

A mission code takes priority over the mission-independent setting:

V_TppSoundDaemon.SetMissionPreparationMusic("Play_bgm_default", "Stop_bgm_default")
V_TppSoundDaemon.SetMissionPreparationMusic("Play_bgm_s10010", "Stop_bgm_s10010", 10010)

Cassette

All functions below belong to V_CassetteCommand.

Playback and visibility

Custom tape helpers

RegisterCustomTapes

V_CassetteCommand.RegisterCustomTapes({
  albums = {
    {
      albumId = "custom_album",
      langId  = "custom_album_name",
      type    = "PREINSTALL_MUSIC",
    },
  },

  tracks = {
    {
      albumId   = "custom_album",
      langId    = "custom_track_name",
      fileName  = "custom_track",
      dataTimeJp = 0,
      dataTimeEn = 0,
      unlocked   = 1,
    },
  },
})

The function returns true on success. Invalid album or track entries are skipped.

Album fields

Common album types:

PREINSTALL_MISSION_INFO
PREINSTALL_MUSIC
PREINSTALL_BRIEFING
PREINSTALL_SPECIAL

Track fields

The track save index is allocated automatically.

UI

All functions below belong to V_TppUiCommand.

Equipment backgrounds

Screen textures

missionCode is optional on every function above, but it does not mean the same thing to a setter as it does to a clear.

Setting. Omit it, or pass 0, and you set the global default. That is a fallback, not a blanket: a mission that has its own entry keeps using that entry, because a per-mission texture always wins over the global one. Pass a mission code to set that mission’s entry.

Clearing. Omit it, or pass 0, and ClearLoadingSplashTextures, ClearGameOverSplashTextures and UnsetMissionTelopSplashTexturePath drop the global default and every per-mission entry with it. Pass a mission code to clear only that mission and leave the rest standing.

A path is hashed as given. The Mission Telop path has .ftex appended when it does not already end in it; the loading and Game Over paths do not, so pass those exactly as the asset is named.

Equipment icons

Equipment names

Custom equip ids have no row in the game’s name data and otherwise render blank. This is the pickup/HUD/equip-list name path - the R&D develop row takes its label from the develop record instead.

V_TppUiCommand.SetEquipLangInfo{
  equipId           = TppEquip.EQP_WP_Example,
  langEquipName     = "example_weapon_name",
  langEquipInfo     = "example_weapon_info",
  langEquipRealName = "example_weapon_real_name",
}

Emergency missions

Time Cigarette

iDroid announcement popups

Enemy information

Announcement-log sound

Mission-select warnings

Add a custom warning line to a mission in the iDroid mission list, keyed by mission code. Both are addressed by the numeric mission code, take a lang-id key whose text you supply in your own lang file, and take an optional color-name string.

Leaving the color param nil will make it use the default color. The Warning will be Red, and Help Yellow

-- red accept-popup warning, in a custom color
V_TppUiCommand.SetMissionAcceptWarning(13006, "MustOwnRockets", "cmn-col-ng")

-- yellow mission-list help, default color
V_TppUiCommand.SetMissionMenuHelp(11082, "MustOwnRockets")

Helicopter

Sahelanthropus

Constants

Game Over types

For V_TppSoundDaemon.SetGameOverMusic.

Outfit Develop groups

For equipDevelopGroupID in an outfit’s V_TppMotherBaseManagement.AddToEquipDevelopTable const table.

Player stances

For V_Player.RequestToSetTargetCqcStance.

Radio call signs

For callSign in the Radio call sign command.

Call signs live in the V_TppCallSign table, for example V_TppCallSign.ZULU_1. Valid call signs are 1 to 13.

DATABASE tabs

For tab in V_TppMotherBaseManagement.SetDataBaseDisplay.

SendCommand

Sending a command

GameObject.SendCommand(target, {
  id = "CommandName",
  -- command fields
})

The target may be a game object ID, mapped index, type target, or Command Post. Some global commands ignore the target.

Accepted command value types

Boolean fields accept:

true / false
0 / any nonzero number

These fields accept a string or StrCode32:

deadBodyLabel
customLostLabel
entries in labels

Strings are converted with FoxHashes.StrCode32.

Soldiers

Occasional chats

Target:

{ type = "TppSoldier2" }

labels accepts up to 255 strings or StrCode32 values.

GameObject.SendCommand({ type = "TppSoldier2" }, {
  id = "SetOccasionalChatList",
  labels = {
    "speech_label_1",
    "speech_label_2",
  },
})

Optical camouflage

Soldiers only, and the target must be given as a numeric GameObjectId - a { type = "TppSoldier2" } is not accepted.

GameObject.SendCommand(
  GameObject.GetGameObjectId("sol_enemyBase_0000"),
  {
    id = "SetOpticalCamo",
    enable = true,
  }
)

Radio call sign

Gives one soldier a radio call sign, so radio chatter refers to them as Zulu 1, Delta 6 and so on. Use the V_TppCallSign table rather than raw numbers.

GameObject.SendCommand(soldierId, {
  id       = "SetRadioCallSign",
  callSign = V_TppCallSign.ZULU_1,
})

Valid call signs are 1 to 13.

Restrict notice

SetRestrictNotice is a vanilla command. V_FrameWork adds one optional ignorePlayer field and passes the vanilla field through untouched. Soldiers only.

GameObject.SendCommand(soldierId, {
  id           = "SetRestrictNotice",
  enabled      = true,
  ignorePlayer = true,
})

Ignore vehicle

Stops one soldier reacting to vehicles. He no longer notices or takes evasive action from them, so he will not flee an approaching vehicle.

GameObject.SendCommand(soldierId, {
  id      = "SetIgnoreVehicle",
  enabled = true,
})

Voice pitch

GameObject.SendCommand(soldierGameObjectId, { id = "SetVoicePitch", pitch = 300 })

SetVoicePitch currently only works on TppSoldier2 and TppCommandPost2

VIP soldiers

GameObject.SendCommand(soldierId, {
  id = "SetVIPImportant",
  isOfficer = true,
  deadBodyLabel = "speech_dead_body_found",
})

Interrogation voice

AssignInterrogationWithVoice is a vanilla command. V_FrameWork adds one optional field, soundDialogueEvent, that overrides the Wwise dialogue event played while the soldier is interrogated (vanilla plays DD_vox_ene), and passes the vanilla fields through untouched.

The vanilla soundParameterId and index fields are documented for a Command Post ID target; the worked example on this page targets a soldier gameObjectId.

soundDialogueEvent accepts a Wwise event name (string) or its FNV1-32 hash (number). The override is remembered per interrogated command post, so different soldiers can be given different voices.

GameObject.SendCommand(cpId, {
  id                 = "AssignInterrogationWithVoice",
  soundParameterId   = soundParameterId,
  index              = index,
  soundDialogueEvent = "your_wwise_event",
})

GameObject.SendCommand(
  GameObject.GetGameObjectId("sol_enemyBase_0000"),
  {
    id = "AssignInterrogationWithVoice",
    soundDialogueEvent = "DD_vox_ene", -- name string, or its FNV1-32 hash as a number
  }
)

Command Posts

Caution phase

GameObject.SendCommand(
  GameObject.GetGameObjectId("afgh_enemyBase_cp"),
  {
    id = "SetCautionPhaseDuration",
    duration = 99,
  }
)

Target a specific Command Post ID or { type = "TppCommandPost2" } for all CPs.

Friendly fire

Lets soldiers damage each other. Off by default.

This is global, not per-post.

GameObject.SendCommand(
  { type = "TppCommandPost2" },
  { id = "SetFriendlyFire", enable = true })

Hostages

Hostage types:

0 = male
1 = female
2 = child

Head-mark colours

Overrides the colour of one entity’s HUD head-mark, per marker state. Up to six colours can be given, and the marker then cycles through them.

Colour values

color through color6 each accept:

RGB values accept 0-1 normalized values or 0-255 byte values.

GameObject.SendCommand(
  GameObject.GetGameObjectId("sol_enemyBase_0000"),
  {
    id = "SetHeadMarkColor",
    state = "dying",
    color = { r = 255, g = 0, b = 0 },
  }
)

Animation

Give two or more colours and the marker cycles through them.

-- red -> orange -> white pulse, one full cycle every two seconds
GameObject.SendCommand(soldierId, {
  id     = "SetHeadMarkColor",
  state  = "dying",
  color  = { r = 255, g = 0,   b = 0 },
  color2 = { r = 255, g = 128, b = 0 },
  color3 = { r = 255, g = 255, b = 255 },
  speed  = 0.5,
})

-- hard blink between two palette colours
GameObject.SendCommand(soldierId, {
  id     = "SetHeadMarkColor",
  state  = "alive",
  color  = "cmn-col-marker-enemy",
  color2 = "cmn-col-marker-powerless",
  speed  = 4.0,
})

Set blend = false to switch between colours instead of fading.

Fading between states

fade is how long, in seconds, the marker takes to cross to this state’s colour when the soldier enters the state. It defaults to 0, which changes colour instantly.

-- alive -> dying eases over half a second instead of snapping
GameObject.SendCommand(soldierId, {
  id    = "SetHeadMarkColor",
  state = "dying",
  color = { r = 255, g = 0, b = 0 },
  fade  = 0.5,
})

The fade starts from whatever colour the marker was actually showing, so it works from a vanilla state as well as from another override, and it picks up mid-animation colours correctly. Leaving a faded state also fades back out to the vanilla colour.

Clearing

-- clear one state
GameObject.SendCommand(soldierId, { id = "SetHeadMarkColor", state = "dying" })

-- clear every state for this gameObjectId
GameObject.SendCommand(soldierId, { id = "SetHeadMarkColor" })

SetHeadMarkColor is NOT exclusive to TppSoldier2 and can work on any locator that has a HeadMark.

Sahelanthropus commands

Use this target:

{ type = "TppSahelan2", group = 0, index = 0 }

phase = -1 applies a light override to every phase.

GameObject.SendCommand(sahelanId, {
  id = "SetEyeLampColor",
  phase = -1,
  color = { r = 255, g = 0, b = 0, a = 255 },
})

Colors accept 0-1 normalized values or 0-255 byte values.

Messages

V Framework emits extra executable-to-Lua messages using the normal MGSV message system.

See the Messages guide.

GameObject messages

NoticeNoise and NoticeIndis are soldiers only - they come from the soldier notice AI, which animals never run. Wildlife uses a single AnimalNotice message instead, covering every species through one handler.

noticeKind says what the animal reacted to:

Coverage is goats, sheep, wolves and bears. Birds, rats and D-Dog have no per-animal notice node and do not fire this message.

Player messages

Mission messages

Helicopter messages

Cassette messages

trackId is the cassette track id (the same value V_CassetteCommand.GetTapeTrackId returns). isXByUser is 1 when the action came from the in-game walkman UI, and 0 when it came from a V_CassetteCommand function (PlayCassetteTapeByTrackId, StopCassette, PauseCassette, ResumeCassette, SetCassetteSpeakerEnabled).

UI messages

Subtitles messages

message is the StrCode32 hash of the name inside the [m=...] tag.

See also

• V Framework
• V Framework Custom Weapons
• V Framework Custom Outfits