Usage

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.

Lua libraries

Framework

Fox utilities

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 (the same index domain as 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.

Player

Voice overrides

Energy Wall

Custom outfits

See V Framework Custom Outfits.

Equipment

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

Each function creates named constants and returns the assigned value or false.

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

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 with a log message. See Cross-family handling for donor screening, the family support table, and required .fpk files.

Mother Base Management

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
}

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",
  },
}

Develop record state

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

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 = 0xffff

-- Static visibility
bluePrintId = true
bluePrintId = false

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

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

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.

Sound

Cassette

Playback and visibility

All functions above belong to V_CassetteCommand.

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

Equipment icons

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 (e.g. 11082 = Episode 36, 13006 = a side op), take a lang-id key whose text you supply in your own lang file, and take an optional color-name string.

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

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

Helicopter

Sahelanthropus

Constants

Game Over types

Outfit Develop groups

SendCommand extensions

Usage

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.

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.

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",
  },
})

Caution phase

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

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

Friendly fire

Use a Command Post ID or { type = "TppCommandPost2" }.

Hostages

Escape state

GameObject.SendCommand(hostageId, {
  id = "SetEscapeState",
  enable = true,
})

When enabled, the prisoner is reported as taken by the player rather than escaped.

Lost-hostage tracking

Hostage types:

0 = male
1 = female
2 = child

VIP soldiers

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

Holdup recovery

GameObject.SendCommand({ type = "TppSoldier2" }, {
  id = "SetUseConcernedHoldupRecovery",
  enable = true,
})

Controls custom concerned-soldier holdup recovery for non-VIP soldiers.

Call-sign patrol soldiers

Soldier stealth camouflage

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

Interrogation voice

AssignInterrogationWithVoice is a native 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).

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(
  GameObject.GetGameObjectId("sol_enemyBase_0000"),
  {
    id = "AssignInterrogationWithVoice",
    soundDialogueEvent = "DD_vox_ene", -- name string, or its FNV1-32 hash as a number
  }
)

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.

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.

Radio messages

Player messages

UI 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).

Subtitles messages

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