Venice Unleashed

https://docs.veniceunleashed.net
Admin
Venice Unleashed is a custom modding and dedicated server platform for Battlefield 3 that enables...
Tokens:808,838
Snippets:12,677
Trust Score:8.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install VisualTerrain:Load hook

Source: https://docs.veniceunleashed.net/vext/ref/shared/hook/visualterrain_load

Example of installing the VisualTerrain:Load hook using Hooks:Install. The callback receives the hook name and the assetName parameter.

```lua
Hooks:Install('VisualTerrain:Load', 1, function(hook, assetName)
    -- Do stuff here.
end)

```

--------------------------------

### Search for instance by partition and instance Guid using ResourceManager:FindInstanceByGuid

Source: https://docs.veniceunleashed.net/vext/guides/datamod

Faster lookup using both partition Guid and instance Guid with the ResourceManager:FindInstanceByGuid method. The example uses partition Guid '707F4A91-B837-47AC-8BEE-5EB614399714' and instance Guid 'A83D8333-F6D5-43AA-BA65-96122FAE8F7C'.

```lua
local instance = ResourceManager:FindInstanceByGuid(Guid('707F4A91-B837-47AC-8BEE-5EB614399714'), Guid('A83D8333-F6D5-43AA-BA65-96122FAE8F7C'))
```

--------------------------------

### Install UI:CreateSelfKilledMessage hook

Source: https://docs.veniceunleashed.net/vext/ref/client/hook/ui_createselfkilledmessage

Example of installing a hook for UI:CreateSelfKilledMessage. The hook function receives killer, weapon, and isHeadshot parameters. Use this to execute custom logic when the local player is killed.

```lua
Hooks:Install('UI:CreateSelfKilledMessage', 1, function(hook, killer, weapon, isHeadshot)
    -- Do stuff here.
end)
```

--------------------------------

### Run VU server in GUI mode with vu.exe -server -dedicated

Source: https://docs.veniceunleashed.net/hosting/setup-win

Starts the VU server in GUI mode, which is the default operating mode and creates a new window with server output. Requires the vu.exe executable from the VU installation directory.

```text
vu.exe -server -dedicated

```

--------------------------------

### Install Server:SuppressEnemies hook

Source: https://docs.veniceunleashed.net/vext/ref/server/hook/server_suppressenemies

Example of installing the Server:SuppressEnemies hook with Hooks:Install. The callback receives the hook name and the suppressionModifier parameter. Place your logic inside the function body.

```lua
Hooks:Install('Server:SuppressEnemies', 1, function(hook, suppressionModifier)
    -- Do stuff here.
end)

```

--------------------------------

### Define a partition in JSON

Source: https://docs.veniceunleashed.net/vext/guides/custom-content

Example JSON structure for a partition, including unique GUIDs and instance definitions.

```json
{
  "Name": "My/Amazing/Partition",
  "PartitionGuid": "c8b8c7ac-7e47-4f7d-94e4-9f3e72f37553",
  "PrimaryInstanceGuid": "ba89b889-ad07-4f58-b5c6-fde0cd6675d5",
  "Instances": {
    "ba89b889-ad07-4f58-b5c6-fde0cd6675d5": {
      "$type": "TextureAsset",
      "Name": "Weapons/XP4_Crossbow_Prototype/XP4_Crossbow_bow_D"
    }
  }
}
```

--------------------------------

### SQL library usage example

Source: https://docs.veniceunleashed.net/vext/ref/server/library/sql

Complete example showing how to open a SQL connection, create a table, insert rows with parameters, test a NOT NULL constraint, and fetch all rows. Uses SQL:Open(), SQL:Query(), SQL:Blob(), SQL:Error(), SQL:LastInsertId(), and SQL:AffectedRows().

```lua
if not SQL:Open() then
  return
end

-- Create our table.
local query = [[
  CREATE TABLE IF NOT EXISTS test_table (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    text_value TEXT,
    int_value INTEGER,
    real_value REAL,
    blob_value BLOB,
    some_null_value BLOB,
    not_null_text TEXT NOT NULL
  )
]]

if not SQL:Query(query) then
  print('Failed to execute query: ' .. SQL:Error())
  return
end

-- Insert some test data.
query = 'INSERT INTO test_table (text_value, int_value, real_value, blob_value, some_null_value, not_null_text) VALUES (?, ?, ?, ?, ?, ?)'

if not SQL:Query(query, 'My Text', 1337, 420.69, SQL:Blob('My Blob'), nil, 'My Not Null Text') then
  print('Failed to execute query: ' .. SQL:Error())
  return
end

if not SQL:Query(query, 'My Text 2', 13372, 420.692, SQL:Blob('My Blob 2'), nil, 'My Not Null Text 2') then
  print('Failed to execute query: ' .. SQL:Error())
  return
end

print('Inserted data. Insert ID: ' .. tostring(SQL:LastInsertId()) .. '. Rows affected: ' .. tostring(SQL:AffectedRows()))

-- Test the NOT NULL constraint.
if not SQL:Query(query, 'My Text', 1337, 420.69, SQL:Blob('My Blob'), nil, nil) then
  -- Error should be "NOT NULL constraint failed: test_table.not_null_text"
  print('Failed to execute query: ' .. SQL:Error())
end

-- Fetch all rows from the table.
results = SQL:Query('SELECT * FROM test_table')

if not results then
  print('Failed to execute query: ' .. SQL:Error())
  return
end

-- Print the fetched rows.
for _, row in pairs(results) do
  print('Got row:')
  print(row)
end
```

--------------------------------

### Get created entity with hookCtx:Call in EntityFactory:Create hook

Source: https://docs.veniceunleashed.net/vext/guides/entities

Installs an EntityFactory:Create hook that calls hookCtx:Call to get the created entity after the engine's default behavior. The example notes the return value can be nil if creation was prevented or the data was invalid. Otherwise, it returns an object of the Entity type.

```lua
Hooks:Install('EntityFactory:Create', 100, function(hookCtx, entityData, transform)
  local createdEntity = hookCtx:Call()
  -- Do something with createdEntity.
end)


```

--------------------------------

### Startup.txt server settings

Source: https://docs.veniceunleashed.net/hosting/config

Configure server variables such as the server name and friendly fire settings.

```text
vars.serverName "My incredible VU server"
vars.friendlyFire true
```

--------------------------------

### Create VU client and instance folders

Source: https://docs.veniceunleashed.net/hosting/setup-linux

Creates the VU client folder (~/vu/client) for VU files and the server instance directory (~/vu/instance) for configuration files, mods, and other necessary server files.

```bash
mkdir -p ~/vu/client
mkdir -p ~/vu/instance

```

--------------------------------

### Search for instance by Guid using ResourceManager:SearchForInstanceByGuid

Source: https://docs.veniceunleashed.net/vext/guides/datamod

Looks up an instance by its instance Guid using the ResourceManager:SearchForInstanceByGuid method. The example uses the Guid 'A83D8333-F6D5-43AA-BA65-96122FAE8F7C'.

```lua
local instance = ResourceManager:SearchForInstanceByGuid(Guid('A83D8333-F6D5-43AA-BA65-96122FAE8F7C'))
```

--------------------------------

### Server script: print('Hello world!')

Source: https://docs.veniceunleashed.net/modding/your-first-mod

Place this in ext/server/__init__.lua to print a message to the server console when the mod loads. The script is executed only on the server because it is inside the server folder.

```lua
print('Hello world!')

```

--------------------------------

### Install(hookName: string, priority: int, context: any, callback: callable): Hook

Source: https://docs.veniceunleashed.net/vext/ref/shared/library/hooks

Installs a callback for a given hook name with a specified priority and a context object. Returns a Hook object.

```APIDOC
## Install(hookName: string, priority: int, context: any, callback: callable): Hook

### Description
Installs a callback for a given hook name with a specified priority and a context object. Returns a Hook object.

### Method
Install

### Parameters
- **hookName** (string) - Required - The name of the hook to install the callback for.
- **priority** (int) - Required - The priority of the callback.
- **context** (any) - Required - The context to associate with the callback.
- **callback** (callable) - Required - The callback function to be invoked.

### Returns
- **Hook** - The installed hook object.
```

--------------------------------

### Install Player:RequestJoin hook

Source: https://docs.veniceunleashed.net/vext/ref/server/hook/player_requestjoin

Install a hook for the Player:RequestJoin event. The hook function receives the join mode, account GUID, player GUID, and player name as arguments. Use this to intercept and handle player join requests.

```lua
Hooks:Install('Player:RequestJoin', 1, function(hook, joinMode, accountGuid, playerGuid, playerName)
    -- Do stuff here.
end)

```

--------------------------------

### Launch the server with -serverInstancePath

Source: https://docs.veniceunleashed.net/hosting/config

Use the -serverInstancePath argument to specify the server instance directory on Linux or to host multiple servers on one machine.

```bash
vu.exe -serverInstancePath <path> -server -dedicated
```

--------------------------------

### Install UI:DrawNametags hook

Source: https://docs.veniceunleashed.net/vext/ref/client/hook/ui_drawnametags

Installs a hook for the UI:DrawNametags event. The callback function is executed when the event occurs. The example shows the basic structure for hooking into this event.

```lua
Hooks:Install('UI:DrawNametags', 1, function(hook)
    -- Do stuff here.
end)

```

--------------------------------

### Build the bundle and superbundle

Source: https://docs.veniceunleashed.net/vext/guides/custom-content

Use the build command to finalize the bundle and then the superbundle.

```text
build
```

```text
build
```

--------------------------------

### Init()

Source: https://docs.veniceunleashed.net/vext/ref/client/library/webui

Initializes the WebUI.

```APIDOC
## Init()

### Description
Initializes the WebUI.

### Method
Init

### Parameters
None

### Returns
void
```

--------------------------------

### MapList.txt single map example

Source: https://docs.veniceunleashed.net/hosting/config

Example configuration for loading Operation Metro in Conquest 64 for one round.

```text
MP_Subway ConquestLarge0 1
```

--------------------------------

### Install Client:UpdateClientGameViewTransform hook

Source: https://docs.veniceunleashed.net/vext/ref/client/hook/client_updateclientgameviewtransform

Use this snippet to install a hook for the Client:UpdateClientGameViewTransform event. The hook function receives the hook name and a LinearTransform parameter. The example includes a placeholder comment for custom logic.

```lua
Hooks:Install('Client:UpdateClientGameViewTransform', 1, function(hook, transform)
    -- Do stuff here.
end)

```

--------------------------------

### Build a new superbundle

Source: https://docs.veniceunleashed.net/vext/guides/custom-content

Use the build_sb command in the Rime REPL to initialize a new superbundle. The name must start with Win32/.

```text
build_sb Win32/My/Amazing/Superbundle Frostbite2_0 C:/SbOutput
```

--------------------------------

### Install ResourceManager:LoadBundles hook

Source: https://docs.veniceunleashed.net/vext/ref/shared/hook/resourcemanager_loadbundles

Use this snippet to hook into the ResourceManager:LoadBundles event. The hook function receives the hook name, a table of bundles, and a ResourceCompartment. The example shows the basic structure for adding custom logic.

```lua
Hooks:Install('ResourceManager:LoadBundles', 1, function(hook, bundles, compartment)
    -- Do stuff here.
end)

```

--------------------------------

### Launch multiple VU server instances

Source: https://docs.veniceunleashed.net/hosting/config

Run multiple servers by specifying a unique instance path and custom ports using -serverInstancePath, -listen, and -mHarmonyPort.

```bash
vu.exe -server -dedicated -serverInstancePath <path> -listen 0.0.0.0:25201 -mHarmonyPort 7949
```

--------------------------------

### Install(hookName: string, priority: int, callback: callable): Hook

Source: https://docs.veniceunleashed.net/vext/ref/shared/library/hooks

Installs a callback for a given hook name with a specified priority. Returns a Hook object.

```APIDOC
## Install(hookName: string, priority: int, callback: callable): Hook

### Description
Installs a callback for a given hook name with a specified priority. Returns a Hook object.

### Method
Install

### Parameters
- **hookName** (string) - Required - The name of the hook to install the callback for.
- **priority** (int) - Required - The priority of the callback.
- **callback** (callable) - Required - The callback function to be invoked.

### Returns
- **Hook** - The installed hook object.
```

--------------------------------

### Get created EntityBus via hookCtx:Call in EntityFactory:CreateFromBlueprint hook

Source: https://docs.veniceunleashed.net/vext/guides/entities

Installs a hook on EntityFactory:CreateFromBlueprint and uses hookCtx:Call() to obtain the created EntityBus. This allows access to the spawned bus after the engine creates it. The comment indicates where to use the createdBus variable.

```lua
Hooks:Install('EntityFactory:CreateFromBlueprint', 100, function(hookCtx, blueprint, transform, variation, parentRepresentative)
  local createdBus = hookCtx:Call()
  -- Do something with createdBus.
end)

```

--------------------------------

### Guid(guid: string, format: string = 'D')

Source: https://docs.veniceunleashed.net/vext/ref/shared/type/guid

Constructs a Guid object by parsing a GUID string. The format parameter specifies the string format.

```APIDOC
## Guid(guid: string, format: string = 'D')

### Description
Parses a GUID string into a Guid type. The `format` parameter dictates how to parse the string.

### Constructor
Guid(guid: string, format: string = 'D')

### Parameters
- **guid** (string) - Required - The GUID string to parse.
- **format** (string) - Optional - The format of the GUID string. Default is 'D'. Supported values: 'D', 'N', 'B', 'P'.

### Format Values
- `D`: GUID with dashes (e.g., `68F0A461-A947-40E1-BEC4-992EFDFF3735`)
- `N`: GUID without dashes (e.g., `68F0A461A94740E1BEC4992EFDFF3735`)
- `B`: GUID with dashes and braces (e.g., `{68F0A461-A947-40E1-BEC4-992EFDFF3735}`)
- `P`: GUID with dashes and parentheses (e.g., `(68F0A461-A947-40E1-BEC4-992EFDFF3735)`)
```

--------------------------------

### Install required packages and VC++ 2008 redistributable

Source: https://docs.veniceunleashed.net/hosting/setup-linux

Installs required packages (xvfb, unzip), downloads the Visual C++ 2008 redistributable, and runs it with Wine under Xvfb. Errors or warnings from the final command can be safely ignored.

```bash
sudo apt install -y xvfb unzip
cd /tmp
wget -nc https://download.microsoft.com/download/5/D/8/5D8C65CB-C849-4025-8E95-C3966CAFD8AE/vcredist_x86.exe
xvfb-run wine /tmp/vcredist_x86.exe /q

```

--------------------------------

### DataToggleNode(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/datatogglenode

Creates a new DataToggleNode instance and assigns it the provided Guid.

```APIDOC
## DataToggleNode(guid: Guid)

### Description
Creates a new DataToggleNode frostbite instance and assigns it the provided Guid.

### Constructor
**DataToggleNode**(guid: Guid)

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.
```

--------------------------------

### Initialize WebUI in Lua

Source: https://docs.veniceunleashed.net/modding/custom-ui

Subscribe to the Extension:Loaded event in your client script to initialize the WebUI on startup.

```lua
Events:Subscribe('Extension:Loaded', function()
    WebUI:Init()
end)
```

--------------------------------

### Startup.txt password protection

Source: https://docs.veniceunleashed.net/hosting/config

Set a password for the server using the vars.gamePassword variable.

```text
vars.gamePassword "<password>"
```

--------------------------------

### ClimbLadderBinding(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/climbladderbinding

Creates a new ClimbLadderBinding frostbite instance with the provided Guid.

```APIDOC
## ClimbLadderBinding(guid: Guid)

### Description
Creates a new ClimbLadderBinding frostbite instance and assigns it the provided Guid.

### Constructor
ClimbLadderBinding(guid: Guid)

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
ClimbLadderBinding
```

--------------------------------

### Clone(guid: Guid): DataContainer

Source: https://docs.veniceunleashed.net/vext/ref/shared/type/datacontainer

Creates a shallow clone of this instance and assigns it the provided Guid.

```APIDOC
## Clone(guid: Guid): DataContainer

### Description
Creates a shallow clone of this instance and assigns it the provided Guid, which is essentially the equivalent of creating a new instance of the same type with the provided Guid and assigning the values of this instance to all of its properties. Any properties that contain structure types (eg. Vec3) will be cloned when assigning, while properties that contain instance types (eg. DataContainer) will be referencing the same instance.

### Method
Clone

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the cloned instance.

### Returns
- **DataContainer** - The newly created instance.
```

--------------------------------

### Create index.html entry point

Source: https://docs.veniceunleashed.net/modding/custom-ui

The basic HTML structure required as the entry point for your custom UI.

```html
<!DOCTYPE html>
<html>
<body>
    Hello world!
</body>
</html>
```

--------------------------------

### FindInstance(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/shared/type/databasepartition

Tries to find and retrieve an instance with a matching guid from the current partition.

```APIDOC
## FindInstance(guid: Guid)

### Description
Tries to find and retrieve an instance with a matching `guid` from the current partition.

### Method
FindInstance

### Parameters
- **guid** (Guid) - Required - The Guid of the instance to find.

### Returns
- **DataContainer** | **nil** - The found instance or nil if not found.

```

--------------------------------

### WeaponSwitchingMapData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponswitchingmapdata

Creates a new WeaponSwitchingMapData frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponSwitchingMapData(guid: Guid)

### Description
Creates a new WeaponSwitchingMapData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
WeaponSwitchingMapData - The newly created instance.
```

--------------------------------

### Launch VU server in 60Hz high frequency mode

Source: https://docs.veniceunleashed.net/hosting/config

Use the -high60 argument to run the server at a 60Hz update frequency for more responsive gameplay.

```bash
vu.exe -server -dedicated -high60
```

--------------------------------

### ZoomLevelSpecificTransitionTime(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/zoomlevelspecifictransitiontime

Creates a new ZoomLevelSpecificTransitionTime frostbite instance and assigns it the provided Guid.

```APIDOC
## ZoomLevelSpecificTransitionTime(guid: Guid)

### Description
Creates a new ZoomLevelSpecificTransitionTime frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
#### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
ZoomLevelSpecificTransitionTime - The newly created instance.
```

--------------------------------

### Run a dedicated VU server with Wine

Source: https://docs.veniceunleashed.net/hosting/setup-linux

Starts a dedicated VU server using Wine. The server becomes joinable shortly after launch; periodic restarts are recommended to receive updates and fixes.

```bash
wine ~/vu/client/vu.com -gamepath ~/bf3 -serverInstancePath "$(winepath -w ~/vu/instance)" -server -dedicated

```

--------------------------------

### ZoomLevelData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/zoomleveldata

Creates a new ZoomLevelData frostbite instance and assigns it the provided Guid.

```APIDOC
## ZoomLevelData(guid: Guid)

### Description
Creates a new ZoomLevelData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Response
No return value.

```

--------------------------------

### LevelSetup(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/levelsetup

Creates a new LevelSetup frostbite instance and assigns it the provided Guid.

```APIDOC
## LevelSetup(guid: Guid)

### Description
Creates a new LevelSetup frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
A new LevelSetup instance with the specified Guid.
```

--------------------------------

### WorldData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/worlddata

Creates a new WorldData frostbite instance and assigns it the provided Guid.

```APIDOC
## WorldData(guid: Guid)

### Description
Creates a new WorldData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
A new WorldData instance with the assigned Guid.
```

--------------------------------

### LevelSetupOption(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/levelsetupoption

Creates a new LevelSetupOption frostbite instance and assigns it the provided Guid.

```APIDOC
## LevelSetupOption(guid: Guid)

### Description
Creates a new LevelSetupOption frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
None

```

--------------------------------

### WeaponZoomModifier(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponzoommodifier

Creates a new WeaponZoomModifier frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponZoomModifier(guid: Guid)

### Description
Creates a new WeaponZoomModifier frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
WeaponZoomModifier - The newly created instance.

```

--------------------------------

### WeaponShotModifier(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponshotmodifier

Creates a new WeaponShotModifier frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponShotModifier(guid: Guid)

### Description
Creates a new WeaponShotModifier frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
#### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
WeaponShotModifier - The newly created instance.

```

--------------------------------

### Subscribe to Player:KitPickup event

Source: https://docs.veniceunleashed.net/vext/ref/server/event/player_kitpickup

Example of subscribing to the Player:KitPickup event.

```lua
Events:Subscribe('Player:KitPickup', function(player, newCustomization)
    -- Do stuff here.
end)
```

--------------------------------

### WeaponUnlockPickupData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponunlockpickupdata

Creates a new WeaponUnlockPickupData frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponUnlockPickupData(guid: Guid)

### Description
Creates a new WeaponUnlockPickupData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
WeaponUnlockPickupData - The newly created instance.

```

--------------------------------

### Create 32-bit Wine prefix with WINEARCH=win32

Source: https://docs.veniceunleashed.net/hosting/setup-linux

Creates a 32-bit Wine prefix as the default user prefix. Run as the user created in the previous step. Errors and warnings on a headless environment can be safely ignored.

```bash
WINEARCH=win32 wine wineboot

```

--------------------------------

### WidgetEventQueryPair(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/widgeteventquerypair

Creates a new WidgetEventQueryPair frostbite instance and assigns it the provided Guid.

```APIDOC
## WidgetEventQueryPair(guid: Guid)

### Description
Creates a new WidgetEventQueryPair frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
None
```

--------------------------------

### Install Wine staging (winehq-staging)

Source: https://docs.veniceunleashed.net/hosting/setup-linux

Alternative installation for the latest Wine staging builds, which may be used with the liquorix kernel and fsync patches.

```bash
sudo apt update
sudo apt install --install-recommends -y winehq-staging

```

--------------------------------

### WeaponStateData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponstatedata

Creates a new WeaponStateData frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponStateData(guid: Guid)

### Description
Creates a new WeaponStateData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Signature
WeaponStateData(guid: Guid)

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
WeaponStateData - The newly created instance.
```

--------------------------------

### WeaponModifierData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponmodifierdata

Creates a new WeaponModifierData frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponModifierData(guid: Guid)

### Description
Creates a new WeaponModifierData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
WeaponModifierData - The newly created instance.
```

--------------------------------

### BFAISystem(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/bfaisystem

Creates a new BFAISystem frostbite instance and assigns it the provided Guid.

```APIDOC
## BFAISystem(guid: Guid)

### Description
Creates a new BFAISystem frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Signature
`BFAISystem(guid: Guid)`

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
A new BFAISystem instance with the specified Guid.
```

--------------------------------

### LevelSetup()

Source: https://docs.veniceunleashed.net/vext/ref/fb/levelsetup

Creates a new LevelSetup frostbite instance.

```APIDOC
## LevelSetup()

### Description
Creates a new LevelSetup frostbite instance.

### Method
Constructor

### Parameters
None

### Returns
A new LevelSetup instance.
```

--------------------------------

### WaypointData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/waypointdata

Creates a new WaypointData frostbite instance and assigns it the provided Guid.

```APIDOC
## WaypointData(guid: Guid)

### Description
Creates a new WaypointData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
A new WaypointData instance with the specified Guid.
```

--------------------------------

### WeaponLagEffectSpringData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponlageffectspringdata

Creates a new WeaponLagEffectSpringData frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponLagEffectSpringData(guid: Guid)

### Description
Creates a new WeaponLagEffectSpringData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Signature
`WeaponLagEffectSpringData(guid: Guid)`

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
A new WeaponLagEffectSpringData instance with the assigned Guid.
```

--------------------------------

### SamplerPlugins(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/samplerplugins

Creates a new SamplerPlugins frostbite instance and assigns it the provided Guid.

```APIDOC
## SamplerPlugins(guid: Guid)

### Description
Creates a new SamplerPlugins frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
None

```

--------------------------------

### Server instance directory structure

Source: https://docs.veniceunleashed.net/hosting/config

The server instance directory contains the server.key file and an Admin folder housing the primary configuration files.

```text
/ server.key
/ Admin /
    / MapList.txt
    / Startup.txt
    / ModList.txt
```

--------------------------------

### WeaponLagEffectForceData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/weaponlageffectforcedata

Creates a new WeaponLagEffectForceData frostbite instance and assigns it the provided Guid.

```APIDOC
## WeaponLagEffectForceData(guid: Guid)

### Description
Creates a new WeaponLagEffectForceData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
WeaponLagEffectForceData - The newly created instance.
```

--------------------------------

### Client and shared scripts: __init__.lua and common.lua

Source: https://docs.veniceunleashed.net/modding/your-first-mod

These four files form the client/shared script example. The shared __init__.lua prints a message, common.lua declares the global MyModVersion, and the client and server __init__.lua files require common.lua via __shared/common and print the variable. The require path __shared tells VeniceEXT to look in the Shared folder.

```lua
print('Hello from the shared world!')

```

```lua
MyModVersion = '1.0.0'

```

```lua
require('__shared/common')

print('Hello dear client!')
print(MyModVersion)

```

```lua
require('__shared/common')

print('Hello world!')
print(MyModVersion)

```

--------------------------------

### VisualEnvironmentEntityData(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/visualenvironmententitydata

Creates a new VisualEnvironmentEntityData frostbite instance and assigns it the provided Guid.

```APIDOC
## VisualEnvironmentEntityData(guid: Guid)

### Description
Creates a new VisualEnvironmentEntityData frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
A new VisualEnvironmentEntityData instance with the specified Guid.
```

--------------------------------

### VoiceOverManuscriptLanguageColumns(guid: Guid)

Source: https://docs.veniceunleashed.net/vext/ref/fb/voiceovermanuscriptlanguagecolumns

Creates a new VoiceOverManuscriptLanguageColumns frostbite instance and assigns it the provided Guid.

```APIDOC
## VoiceOverManuscriptLanguageColumns(guid: Guid)

### Description
Creates a new VoiceOverManuscriptLanguageColumns frostbite instance and assigns it the provided Guid.

### Method
Constructor

### Parameters
- **guid** (Guid) - Required - The Guid to assign to the newly created instance.

### Returns
None

```

--------------------------------

### Run VU server in headless mode with -headless or vu.com

Source: https://docs.veniceunleashed.net/hosting/setup-win

Runs the VU server in headless mode, which uses a standard console window instead of a GUI. Two equivalent methods are shown: passing the -headless argument to vu.exe, or using the vu.com executable.

```text
vu.exe -server -dedicated -headless

```

```text
vu.com -server -dedicated

```
Tokens:
Raw