{
"vn-fnc-ambient-audio-loop": {
"title": "VN fnc ambient audio loop",
"callable": "VN_fnc_ambient_audio_loop",
"slug": "vn-fnc-ambient-audio-loop",
"description": "Creates and adds a loop to the internal BIS_fnc_loop which will check if any sounds should be playing.",
"syntax": "[] call VN_fnc_ambient_audio_loop;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call vn_fnc_ambient_audio_loop;"
],
"groups": [
"ambient_audio_functions"
],
"groupLabels": [
"Audio (ambient)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_ambient_audio_loop"
]
},
"vn-fnc-artillery-actions": {
"title": "VN fnc artillery actions",
"callable": "VN_fnc_artillery_actions",
"slug": "vn-fnc-artillery-actions",
"description": "Adds radio action to players and the respawn eventhandler to add actions when they respawn.",
"syntax": "[] call VN_fnc_artillery_actions;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Action added to player passed."
},
"examples": [
"[] call vn_fnc_artillery_actions;"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_actions"
]
},
"vn-fnc-artillery-arc-light": {
"title": "VN fnc artillery arc light",
"callable": "VN_fnc_artillery_arc_light",
"slug": "vn-fnc-artillery-arc-light",
"description": "Function which spawns the bombs for the Arc Light artillery mission.",
"syntax": "[_start_pos,_unit,_end_pos] call VN_fnc_artillery_arc_light;",
"params": [
{
"name": "_start_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Position at which the bombing run should start",
"optional": false,
"default": ""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit which called in the run",
"optional": false,
"default": ""
},
{
"name": "_end_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Position at which the bombing run should end",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[ [0,0,0],player,[100,100,0] ] call vn_fnc_artillery_arc_light;"
],
"groups": [
"artillery_ammo_functions"
],
"groupLabels": [
"Artillery (ammunition)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_arc_light"
]
},
"vn-fnc-artillery-bomb-guide": {
"title": "VN fnc artillery bomb guide",
"callable": "VN_fnc_artillery_bomb_guide",
"slug": "vn-fnc-artillery-bomb-guide",
"description": "Guides a bomb through velocity transformation so it always hits the target.",
"syntax": "[_projectile,_target] call VN_fnc_artillery_bomb_guide;",
"params": [
{
"name": "_projectile",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Projectile object",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_target",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Target object",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[bomb, player] call vn_fnc_artillery_bomb_guide;"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_bomb_guide"
]
},
"vn-fnc-artillery-bombard": {
"title": "VN fnc artillery bombard",
"callable": "VN_fnc_artillery_bombard",
"slug": "vn-fnc-artillery-bombard",
"description": "Main bombard function",
"syntax": "[_start_pos,_end_pos,_unit,_params] call VN_fnc_artillery_bombard;",
"params": [
{
"name": "_start_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Starting position",
"optional": false,
"default": ""
},
{
"name": "_end_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Ending position",
"optional": false,
"default": ""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit who called in the request",
"optional": false,
"default": ""
},
{
"name": "_params",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Params array which contains the index's for the selected values",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[ [0,100,0],[0,100,0],man1,[0,0],\"Aero 1-3\"] call vn_fnc_artillery_bombard;"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_bombard"
]
},
"vn-fnc-artillery-commando-vault": {
"title": "VN fnc artillery commando vault",
"callable": "VN_fnc_artillery_commando_vault",
"slug": "vn-fnc-artillery-commando-vault",
"description": "Runs the commando vault function.",
"syntax": "[_position] call VN_fnc_artillery_commando_vault;",
"params": [
{
"name": "_position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Position at which to spawn the bomb",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[ [0,0,0] ] call vn_fnc_artillery_commando_vault;"
],
"groups": [
"artillery_ammo_functions"
],
"groupLabels": [
"Artillery (ammunition)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_commando_vault"
]
},
"vn-fnc-artillery-dawn-1": {
"title": "VN fnc artillery dawn 1",
"callable": "VN_fnc_artillery_dawn_1",
"slug": "vn-fnc-artillery-dawn-1",
"description": "Spawns the illumination rounds for the scripted illumination artillery rounds.",
"syntax": "[_position] call VN_fnc_artillery_dawn_1;",
"params": [
{
"name": "_position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Position which will be used to determine where the illumination.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[ [0,0,0] ] call vn_fnc_artillery_dawn_1"
],
"groups": [
"artillery_ammo_functions"
],
"groupLabels": [
"Artillery (ammunition)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_dawn_1"
]
},
"vn-fnc-artillery-heli": {
"title": "VN fnc artillery heli",
"callable": "VN_fnc_artillery_heli",
"slug": "vn-fnc-artillery-heli",
"description": "Spawns a helicopter with predetermined settings from the artillery module GUI",
"syntax": "[\n _i,\n _planeCfg,\n _vehicle_class,\n _start_pos,\n _end_pos,\n _amount_index,\n _magazine,\n _unit,\n _illumination\n] call VN_fnc_artillery_heli;",
"params": [
{
"name": "_i",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Index of this heli's run",
"optional": false,
"default": ""
},
{
"name": "_planeCfg",
"type": "Config",
"typeMarkdown": "[Config](https://community.bistudio.com/wiki/Config)",
"description": "Heli config",
"optional": false,
"default": ""
},
{
"name": "_vehicle_class",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Plane classname",
"optional": false,
"default": ""
},
{
"name": "_start_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Start position for the run",
"optional": false,
"default": ""
},
{
"name": "_end_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "End position for the run",
"optional": false,
"default": ""
},
{
"name": "_amount_index",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Number of total runs",
"optional": false,
"default": ""
},
{
"name": "_magazine",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of magazines which will be fired from the vehicle",
"optional": false,
"default": ""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit that called the artillery",
"optional": false,
"default": ""
},
{
"name": "_illumination",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is the artillery run an illumination run",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[0, configfile >> \"cfgvehicles\" >> \"aircraft_class\", \"aircraft_class\", [0,0,0], [100,100,0], 0, [\"rockets\"], player, false] call vn_fnc_artillery_heli"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_heli"
]
},
"vn-fnc-artillery-init": {
"title": "VN fnc artillery init",
"callable": "VN_fnc_artillery_init",
"slug": "vn-fnc-artillery-init",
"description": "Init function for artillery module.",
"syntax": "[] call VN_fnc_artillery_init;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"call vn_fnc_artillery_init;"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_init"
]
},
"vn-fnc-artillery-menu": {
"title": "VN fnc artillery menu",
"callable": "VN_fnc_artillery_menu",
"slug": "vn-fnc-artillery-menu",
"description": "Artillery Menu master function",
"syntax": "[mode, params] call VN_fnc_artillery_menu",
"params": [
{
"name": "mode",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "mode to call for the menu. Case-insensitive. Can be one of:
• `\"init\"`
• `\"draw\"`
• `\"radio:type\"`
• `\"onLoad\"`
• `\"onUnload\"`
• `\"lbSelChanged\"`
• `\"mouseButtonDown\"`
• `\"mouseButtonUp\"`
• `\"mouseMoving\"`
• `\"gui:setup\"`
• `\"gui:clear\"`
• `\"gui:combo:ammo\"`
• `\"gui:combo:callsign\"`
• `\"gui:combo:amount\"`
• `\"gui:combo:callsign\"`
• `\"gui:button:bombardment\"`",
"optional": true,
"default": "\"\""
},
{
"name": "params",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "arguments. Can be:
• for `\"init\"` and `\"onLoad\"`: [[Display](https://community.bistudio.com/wiki/Display)]
• for `\"lbSelChanged\"`: [Array](https://community.bistudio.com/wiki/Array) of [Numbers](https://community.bistudio.com/wiki/Number), format [ctrlIndex, lbIndex]
• for `\"mouseButtonDown\"` and `\"mouseButtonUp\"`: same as [their respective event handlers](https://community.bistudio.com/wiki/User_Interface_Event_Handlers#onMouseButtonDown), e.g [\"_ctrl\", \"_button\", \"_xPos\", \"_yPos\", \"_shift\", \"_ctrl\", \"_alt\"]
• for `\"mouseMoving\"`: same as [its respective event handler](https://community.bistudio.com/wiki/User_Interface_Event_Handlers#onMouseMoving), e.g [\"_ctrl\", \"_xPos\", \"_yPos\", \"_mouseOver\"]",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function reached the end"
},
"examples": [
"[\"init\"] call VN_fnc_artillery_menu;"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_menu"
]
},
"vn-fnc-artillery-message": {
"title": "VN fnc artillery message",
"callable": "VN_fnc_artillery_message",
"slug": "vn-fnc-artillery-message",
"description": "Artillery message function which plays a message in side chat for the player.",
"syntax": "[_type,_id,_unit] call VN_fnc_artillery_message;",
"params": [
{
"name": "_type",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Artillery type",
"optional": true,
"default": "\"\""
},
{
"name": "_id",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "ID/Group name",
"optional": true,
"default": "\"\""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit calling in the request",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_message"
]
},
"vn-fnc-artillery-plane": {
"title": "VN fnc artillery plane",
"callable": "VN_fnc_artillery_plane",
"slug": "vn-fnc-artillery-plane",
"description": "Spawns a plane with predetermined settings from the artillery module GUI.",
"syntax": "[\n _i,\n _planeCfg,\n _vehicle_class,\n _start_pos,\n _end_pos,\n _amount_index,\n _magazine,\n _unit,\n _illumination\n] call VN_fnc_artillery_plane;",
"params": [
{
"name": "_i",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Index of this plane's run",
"optional": false,
"default": ""
},
{
"name": "_planeCfg",
"type": "Config",
"typeMarkdown": "[Config](https://community.bistudio.com/wiki/Config)",
"description": "Plane config",
"optional": false,
"default": ""
},
{
"name": "_vehicle_class",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Plane classname",
"optional": false,
"default": ""
},
{
"name": "_start_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "End position for the run",
"optional": false,
"default": ""
},
{
"name": "_end_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Index of this plane's run",
"optional": false,
"default": ""
},
{
"name": "_amount_index",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Number of total runs",
"optional": false,
"default": ""
},
{
"name": "_magazine",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of magazines which will be fired from the vehicle.",
"optional": false,
"default": ""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit that called the artillery.",
"optional": false,
"default": ""
},
{
"name": "_illumination",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Is the artillery run an illumination run",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[0, configfile >> \"cfgvehicles\" >> \"aircraft_class\", \"aircraft_class\", [0,0,0], [100,100,0], 0, [\"rockets\"], player, 0] call vn_fnc_artillery_plane"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_plane"
]
},
"vn-fnc-artillery-radio": {
"title": "VN fnc artillery radio",
"callable": "VN_fnc_artillery_radio",
"slug": "vn-fnc-artillery-radio",
"description": "Function to determine if the player has access to the artillery menu request.",
"syntax": "[_unit] call VN_fnc_artillery_radio;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit attempting to call the request.",
"optional": true,
"default": "PLAYER"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "If the player has a radio based on config settings."
},
"examples": [
"[player] call vn_fnc_artillery_radio;"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_radio"
]
},
"vn-fnc-artillery-resupply": {
"title": "VN fnc artillery resupply",
"callable": "VN_fnc_artillery_resupply",
"slug": "vn-fnc-artillery-resupply",
"description": "Server side script for resupply call from a player.",
"syntax": "[_params, _start_pos, _end_pos, _unit] call VN_fnc_artillery_resupply;",
"params": [
{
"name": "_params",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Combo box index array.",
"optional": false,
"default": ""
},
{
"name": "_start_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Starting position.",
"optional": false,
"default": ""
},
{
"name": "_end_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Ending position.",
"optional": false,
"default": ""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "The unit calling in the request.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_resupply"
]
},
"vn-fnc-artillery-score-set": {
"title": "VN fnc artillery score set",
"callable": "VN_fnc_artillery_score_set",
"slug": "vn-fnc-artillery-score-set",
"description": "Sets the score variable +/- the cost that is passed through to the function.",
"syntax": "[_cost] call VN_fnc_artillery_score_set;",
"params": [
{
"name": "_cost",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Cost of the request.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[666] call VN_fnc_artillery_score_set;"
],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_score_set"
]
},
"vn-fnc-artillery-server-check": {
"title": "VN fnc artillery server check",
"callable": "VN_fnc_artillery_server_check",
"slug": "vn-fnc-artillery-server-check",
"description": "Server side check for the artillery request, makes sure the request isn't in a safezone or near a respawn point.",
"syntax": "[_params,_start_pos,_end_pos,_unit] call VN_fnc_artillery_server_check;",
"params": [
{
"name": "_params",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Combo box index array.",
"optional": false,
"default": ""
},
{
"name": "_start_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Starting position.",
"optional": false,
"default": ""
},
{
"name": "_end_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Ending position.",
"optional": false,
"default": ""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "The unit calling in the request.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_server_check"
]
},
"vn-fnc-artillery-transport": {
"title": "VN fnc artillery transport",
"callable": "VN_fnc_artillery_transport",
"slug": "vn-fnc-artillery-transport",
"description": "Server side script for transport call from a player.",
"syntax": "[_params, _start_pos, _end_pos, _unit] call VN_fnc_artillery_transport;",
"params": [
{
"name": "_params",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Combo box index array.",
"optional": false,
"default": ""
},
{
"name": "_start_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Starting position.",
"optional": false,
"default": ""
},
{
"name": "_end_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Ending position.",
"optional": false,
"default": ""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "The unit calling in the request.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [],
"groups": [
"artillery_functions"
],
"groupLabels": [
"Artillery"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_artillery_transport"
]
},
"vn-fnc-bicycle-02-handle-pedals": {
"title": "VN fnc bicycle 02 handle pedals",
"callable": "VN_fnc_bicycle_02_handle_pedals",
"slug": "vn-fnc-bicycle-02-handle-pedals",
"description": "Handles animations of bicycle pedals.",
"syntax": "[_vehicle, _engineState] call VN_fnc_bicycle_02_handle_pedals;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Bicycle",
"optional": true,
"default": "objNull"
},
{
"name": "_engineState",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Current engine state",
"optional": true,
"default": "false"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[bicycle, true] call vn_fnc_bicycle_handle_pedals"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Reyhard, 3CB, modified for SGD by veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_bicycle_02_handle_pedals"
]
},
"vn-fnc-bicycle-handle-pedals": {
"title": "VN fnc bicycle handle pedals",
"callable": "VN_fnc_bicycle_handle_pedals",
"slug": "vn-fnc-bicycle-handle-pedals",
"description": "Handles animations of bicycle pedals.",
"syntax": "[_vehicle, _engineState] call VN_fnc_bicycle_handle_pedals;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Bicycle",
"optional": true,
"default": "objNull"
},
{
"name": "_engineState",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Current engine state",
"optional": true,
"default": "false"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[bicycle, true] call vn_fnc_bicycle_handle_pedals"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Reyhard, 3CB, modified for SGD by veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_bicycle_handle_pedals"
]
},
"vn-fnc-bolt-click": {
"title": "VN fnc bolt click",
"callable": "VN_fnc_bolt_click",
"slug": "vn-fnc-bolt-click",
"description": "Bolt action audio player.",
"syntax": "[] call VN_fnc_bolt_click;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit firing the weapon.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_audio",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Audio to play.",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player, \"vn_boltclick\"] call vn_fnc_bolt_click;"
],
"groups": [
"vn_weapons_functions"
],
"groupLabels": [
"Weapon handling"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_bolt_click"
]
},
"vn-fnc-bolt-fired": {
"title": "VN fnc bolt fired",
"callable": "VN_fnc_bolt_fired",
"slug": "vn-fnc-bolt-fired",
"description": "Function called when a weapon is fired, plays an animation and plays a sound.",
"syntax": "[_ehArgs,_animation,_sound,_wait] call VN_fnc_bolt_fired;",
"params": [
{
"name": "_ehArgs",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array containing the eventhandler data.",
"optional": true,
"default": "[]"
},
{
"name": "_animation",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Animation to play when weapon is fired.",
"optional": true,
"default": "\"\""
},
{
"name": "_sound",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Sound to play when the weapon is fired.",
"optional": true,
"default": "\"\""
},
{
"name": "_wait",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should the function wait until the fired key is not held.",
"optional": true,
"default": "FALSE"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[_this, \"vn_animation\", \"vn_sound\", true] call vn_fnc_bolt_fired;"
],
"groups": [
"vn_weapons_functions"
],
"groupLabels": [
"Weapon handling"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_bolt_fired"
]
},
"vn-fnc-bomb-blu82": {
"title": "VN fnc bomb blu82",
"callable": "VN_fnc_bomb_blu82",
"slug": "vn-fnc-bomb-blu82",
"description": "Spawns bomb and either attaches a parachute or spawns a parachute to attach.",
"syntax": "[_position,_height,_parachute,_owner] call VN_fnc_bomb_blu82;",
"params": [
{
"name": "_position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Position for the bomb to land at.",
"optional": true,
"default": "[]"
},
{
"name": "_height",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Height to spawn the bomb at, minimum 150 meters.",
"optional": true,
"default": "300"
},
{
"name": "_parachute",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Parachute object that will be attachted to the bomb.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_owner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object which will be set as the owner of the bomb, use this to give players credit for kills from the bomb.",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "[OBJECT,OBJECT]",
"typeMarkdown": "[OBJECT,OBJECT]",
"description": "Array containing bomb and parachute object."
},
"examples": [
"[ [100,200,0], 300 ] call vn_fnc_bomb_blu82"
],
"groups": [
"vn_bomb_functions"
],
"groupLabels": [
"Bombs"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_bomb_blu82"
]
},
"vn-fnc-bomb-hit-blu82": {
"title": "VN fnc bomb hit blu82",
"callable": "VN_fnc_bomb_hit_blu82",
"slug": "vn-fnc-bomb-hit-blu82",
"description": "Handles bomb hitting the target and creates craters.\nThis is called by a eventhandler, don't recommend calling it yourself.",
"syntax": "[] call VN_fnc_bomb_hit_blu82;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call vn_fnc_bomb_hit_blu82"
],
"groups": [
"vn_bomb_hit_functions"
],
"groupLabels": [
"Bombs (impact)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_bomb_hit_blu82"
]
},
"vn-fnc-burnit-action": {
"title": "VN fnc burnit action",
"callable": "VN_fnc_burnit_action",
"slug": "vn-fnc-burnit-action",
"description": "Function called when user uses the \"Burn Hut\" action on a building",
"syntax": "[] call VN_fnc_burnit_action;",
"params": [
{
"name": "_hut",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Building object",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Player's object",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[building_01, player] call vn_fnc_burnit_action"
],
"groups": [
"vn_functions"
],
"groupLabels": [
"Miscellaneous (core)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_burnit_action"
]
},
"vn-fnc-cinematic-play": {
"title": "VN fnc cinematic play",
"callable": "VN_fnc_cinematic_play",
"slug": "vn-fnc-cinematic-play",
"description": "Cinematic playing function, plays cinematic based off synced camera shots to the master cinematic module.",
"syntax": "[module] call VN_fnc_cinematic_play",
"params": [
{
"name": "module",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "master cinematic module, a.k.a the \"head\" of the module snake",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[VN_cinematicModule] call VN_fnc_cinematic_play"
],
"groups": [
"cinematic_functions"
],
"groupLabels": [
"Cinematics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_cinematic_play"
]
},
"vn-fnc-cmdol-check": {
"title": "VN fnc cmdOL check",
"callable": "VN_fnc_cmdOL_check",
"slug": "vn-fnc-cmdol-check",
"description": "- Start the Masterloop for the Command Overlay.\n- Will wait, until an Item is added to \"vn_cmdOL_ctrlToAdd\"",
"syntax": "[] call VN_fnc_cmdOL_check;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] spawn vn_fnc_cmdOL_check;"
],
"groups": [
"cmdOverlay"
],
"groupLabels": [
"Command overlay"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_cmdOL_check"
]
},
"vn-fnc-cmdol-init": {
"title": "VN fnc cmdOL init",
"callable": "VN_fnc_cmdOL_init",
"slug": "vn-fnc-cmdol-init",
"description": "Prepare all the data for the \"Command Overlay\".",
"syntax": "[_isReset] call VN_fnc_cmdOL_init;",
"params": [
{
"name": "_isReset",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "If, for whatever reason, the Overlay needs a reset (e.g. some other script removes all cutRsc) -> Do not reset the Icon Index Variable",
"optional": true,
"default": "FALSE"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[FALSE] call vn_fnc_cmdOL_init;"
],
"groups": [
"cmdOverlay"
],
"groupLabels": [
"Command overlay"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_cmdOL_init"
]
},
"vn-fnc-cmdol-receive": {
"title": "VN fnc cmdOL receive",
"callable": "VN_fnc_cmdOL_receive",
"slug": "vn-fnc-cmdol-receive",
"description": "Adding the Texture/Icon to the \"ActiveIcons\"-list, nothing else. Rest will be handled by \"vn_fnc_cmdOL_check\".",
"syntax": "[_UsedIcon,_senderName,_actionName] call VN_fnc_cmdOL_receive;",
"params": [
{
"name": "_UsedIcon",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Path to image/texture/Icon/whatever you wanna show there",
"optional": true,
"default": "\"\""
},
{
"name": "_senderName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Name of the person, that sent the \"command\"",
"optional": true,
"default": "\"\""
},
{
"name": "_actionName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Name of the action, that was executed",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[\n\"vn\\ui_f_vietnam\\ui\\wheelmenu\\img\\handsignals\\ui_wm_selector_hand_001_ca.paa\",\n\"playername A\",\n\"Take Cover\"\n] call vn_fnc_cmdOL_receive;"
],
"groups": [
"cmdOverlay"
],
"groupLabels": [
"Command overlay"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_cmdOL_receive"
]
},
"vn-fnc-credits": {
"title": "VN fnc credits",
"callable": "VN_fnc_credits",
"slug": "vn-fnc-credits",
"description": "Plays credits scene over game display.",
"syntax": "[_continued_text,_end_code] call VN_fnc_credits;",
"params": [
{
"name": "_continued_text",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should the \"To be continued\" text be shown.",
"optional": true,
"default": "false"
},
{
"name": "_end_code",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "Code to run when credits ends.",
"optional": true,
"default": "{true}"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[true, { hint \"Credits done!\"; }] call vn_fnc_credits;"
],
"groups": [
"vn_end_functions"
],
"groupLabels": [
"Mission end (in mission)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_credits"
]
},
"vn-fnc-debug-message": {
"title": "VN fnc debug message",
"callable": "VN_fnc_debug_message",
"slug": "vn-fnc-debug-message",
"description": "Show internal debug message and log to rpt file",
"syntax": "[_message] call VN_fnc_debug_message;",
"params": [
{
"name": "_message",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Text to be sent.",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[\"Example Error\"] call vn_fnc_debug_message;"
],
"groups": [
"vn_debug_functions"
],
"groupLabels": [
"Debug (core)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_debug_message"
]
},
"vn-fnc-drm-delete-audio": {
"title": "VN fnc drm delete audio",
"callable": "VN_fnc_drm_delete_audio",
"slug": "vn-fnc-drm-delete-audio",
"description": "Stops object or player from playing audio.",
"syntax": "[_object] call VN_fnc_drm_delete_audio;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object which is playing audio",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player] call vn_fnc_drm_delete_audio;"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_delete_audio"
]
},
"vn-fnc-drm-localuseractions": {
"title": "VN fnc drm localuseractions",
"callable": "VN_fnc_drm_localuseractions",
"slug": "vn-fnc-drm-localuseractions",
"description": "Adds actions for the DRM system to the object.",
"syntax": "[_object] call VN_fnc_drm_localuseractions;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object to add actions to.",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[object] call VN_fnc_drm_localuseractions;"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_localuseractions"
]
},
"vn-fnc-drm-play-clients": {
"title": "VN fnc drm play clients",
"callable": "vn_fnc_drm_play_clients",
"slug": "vn-fnc-drm-play-clients",
"description": "Plays audio from an object for the client.",
"syntax": "[_config, _time, _side] call vn_fnc_drm_play_clients;",
"params": [
{
"name": "_config",
"type": "Config",
"typeMarkdown": "[Config](https://community.bistudio.com/wiki/Config)",
"description": "Config entry for the sound",
"optional": true,
"default": "CONFIGNULL"
},
{
"name": "_time",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Syncronization time",
"optional": true,
"default": "0"
},
{
"name": "_side",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Side of the audio channel that is playing",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[config_entry, 0, 0] call vn_fnc_drm_play_clients;"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_play_clients"
]
},
"vn-fnc-drm-request-audio": {
"title": "VN fnc drm request audio",
"callable": "VN_fnc_drm_request_audio",
"slug": "vn-fnc-drm-request-audio",
"description": "No description added yet.",
"syntax": "[_object,_channel] call VN_fnc_drm_request_audio;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object which is requesting the audio.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_channel",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Channel index",
"optional": true,
"default": "-1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[radio, 0] call vn_fnc_drm_request_audio;"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_request_audio"
]
},
"vn-fnc-drm-setup-client": {
"title": "VN fnc drm setup client",
"callable": "VN_fnc_drm_setup_client",
"slug": "vn-fnc-drm-setup-client",
"description": "Sets up audio objects for backpack radio on clients when they join the server.",
"syntax": "[] spawn VN_fnc_drm_setup_client;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] spawn vn_fnc_drm_setup_client"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_setup_client"
]
},
"vn-fnc-drm-setup-server": {
"title": "VN fnc drm setup server",
"callable": "VN_fnc_drm_setup_server",
"slug": "vn-fnc-drm-setup-server",
"description": "Sets up the DRM channels on the server and sets all the audio clips that can play for each.",
"syntax": "[] call VN_fnc_drm_setup_server;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call vn_fnc_drm_setup_server"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_setup_server"
]
},
"vn-fnc-drm-useractions": {
"title": "VN fnc drm useractions",
"callable": "VN_fnc_drm_useractions",
"slug": "vn-fnc-drm-useractions",
"description": "Adds actions for the DRM system which the player interacts with.",
"syntax": "[] call VN_fnc_drm_useractions;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call vn_fnc_drm_useractions;"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_useractions"
]
},
"vn-fnc-drm-usereventhandlers": {
"title": "VN fnc drm usereventhandlers",
"callable": "VN_fnc_drm_usereventhandlers",
"slug": "vn-fnc-drm-usereventhandlers",
"description": "Adds eventhandlers for all the needed things for DRM.",
"syntax": "[] call VN_fnc_drm_usereventhandlers;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call VN_fnc_drm_usereventhandlers;"
],
"groups": [
"dynamic_radio_music_functions"
],
"groupLabels": [
"Audio (radio music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_drm_usereventhandlers"
]
},
"vn-fnc-empty-click": {
"title": "VN fnc empty click",
"callable": "VN_fnc_empty_click",
"slug": "vn-fnc-empty-click",
"description": "Checks if weapon ammo is empty, plays an empty sound if it is.",
"syntax": "[] call VN_fnc_empty_click;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit firing the weapon.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_audio",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Audio to play.",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[player, \"vn_emptysound\"] call vn_fnc_empty_click;"
],
"groups": [
"vn_weapons_functions"
],
"groupLabels": [
"Weapon handling"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_empty_click"
]
},
"vn-fnc-end-script": {
"title": "VN fnc end script",
"callable": "VN_fnc_end_script",
"slug": "vn-fnc-end-script",
"description": "Internal script used by the ending ui to play effects on screen, has no use outside of this context.",
"syntax": "[_ui,_type] call VN_fnc_end_script;",
"params": [
{
"name": "_ui",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array containing UI display.",
"optional": true,
"default": "[]"
},
{
"name": "_type",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Switch case.",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[_this,\"onload\"] call vn_fnc_end_script;"
],
"groups": [
"vn_end_functions"
],
"groupLabels": [
"Mission end (in mission)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_end_script"
]
},
"vn-fnc-endmission": {
"title": "VN fnc endMission",
"callable": "VN_fnc_endMission",
"slug": "vn-fnc-endmission",
"description": "End mission with either a fade to black or a cinematic outro.",
"syntax": "[_endName,_win,_fade,_playMusic,_cancelTasks,_end_code] call VN_fnc_endMission;",
"params": [
{
"name": "_endName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "CfgDebriefing class which is used as the mission ending template.",
"optional": true,
"default": "\"end1\""
},
{
"name": "_win",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Win/Loss.",
"optional": true,
"default": "true"
},
{
"name": "_fade",
"type": "Boolean/Number",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)/[Number](https://community.bistudio.com/wiki/Number)",
"description": "NUMBER to fade to black in X seconds (will not play music), BOOL to do special outro (with music if enabled).",
"optional": true,
"default": "true"
},
{
"name": "_playMusic",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "BOOL to play music.",
"optional": true,
"default": "true"
},
{
"name": "_cancelTasks",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "BOOL to cancel tasks that haven't been completed.",
"optional": true,
"default": "false"
},
{
"name": "_end_code",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "CODE to call after splash, but before debriefing screen shows.",
"optional": true,
"default": "{true}"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[\"end1\"] call vn_fnc_endMission;"
],
"groups": [
"vn_end_functions"
],
"groupLabels": [
"Mission end (in mission)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_endMission"
]
},
"vn-fnc-endmissionserver": {
"title": "VN fnc endMissionServer",
"callable": "VN_fnc_endMissionServer",
"slug": "vn-fnc-endmissionserver",
"description": "Ends mission for all clients on multiplayer server.",
"syntax": "[_endName,_win,_fade,_playMusic,_cancelTasks] call VN_fnc_endMissionServer;",
"params": [
{
"name": "_endName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "CfgDebriefing class which is used as the mission ending template.",
"optional": true,
"default": "\"end1\""
},
{
"name": "_win",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Win/Loss.",
"optional": true,
"default": "true"
},
{
"name": "_fade",
"type": "Boolean / Number",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean) / [Number](https://community.bistudio.com/wiki/Number)",
"description": "NUMBER to fade to black in X seconds, BOOL to do special outro.",
"optional": true,
"default": "true"
},
{
"name": "_playMusic",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "BOOL to play music.",
"optional": true,
"default": "true"
},
{
"name": "_cancelTasks",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "BOOL to cancel tasks that haven't been completed.",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[\"end1\"] call vn_fnc_endMissionServer;"
],
"groups": [
"vn_end_functions"
],
"groupLabels": [
"Mission end (in mission)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_endMissionServer"
]
},
"vn-fnc-fired-refuel": {
"title": "VN fnc fired refuel",
"callable": "VN_fnc_fired_refuel",
"slug": "vn-fnc-fired-refuel",
"description": "Fired eventhandler which will delete the projectile and refuel the vehicle back to full fuel.",
"syntax": "[\n _vehicle,\n _weapon,\n _muzzle,\n _mode,\n _ammo,\n _magazine,\n _projectile,\n _gunner,\n _drop\n] call VN_fnc_fired_refuel;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle firing the weapon",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_weapon",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Weapon that is fired",
"optional": true,
"default": "\"\""
},
{
"name": "_muzzle",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Weapon muzzle that is fired",
"optional": true,
"default": "\"\""
},
{
"name": "_mode",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Weapon mode",
"optional": true,
"default": "\"\""
},
{
"name": "_ammo",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Weapon ammo that is fired",
"optional": true,
"default": "\"\""
},
{
"name": "_magazine",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Weapon magazine that is fired",
"optional": true,
"default": "\"\""
},
{
"name": "_projectile",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Weapon magazine that is fired",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_gunner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object that fired the weapon",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_drop",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should the projectile be dropped",
"optional": true,
"default": "FALSE"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [],
"groups": [
"vn_fuel_functions"
],
"groupLabels": [
"Refuelling"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_fired_refuel"
]
},
"vn-fnc-fruit-destruct": {
"title": "VN fnc fruit destruct",
"callable": "VN_fnc_fruit_destruct",
"slug": "vn-fnc-fruit-destruct",
"description": "Play random hit sound. Sound can be customized by providing file path in 2nd parameter.",
"syntax": "[_obj,_soundType] call VN_fnc_fruit_destruct;",
"params": [
{
"name": "_obj",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object the script is attached to.",
"optional": false,
"default": ""
},
{
"name": "_soundType",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Path to sound file.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_orange_functions"
],
"groupLabels": [
"Destructible fruit"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_fruit_destruct"
]
},
"vn-fnc-fruit-hitpart": {
"title": "VN fnc fruit hitPart",
"callable": "VN_fnc_fruit_hitPart",
"slug": "vn-fnc-fruit-hitpart",
"description": "Handles damage dealt to fruits.",
"syntax": "[\"_obj\",\"_dmg\",\"_soundType\"] call VN_fnc_fruit_hitPart;",
"params": [
{
"name": "_obj",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_dmg",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_soundType",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_orange_functions"
],
"groupLabels": [
"Destructible fruit"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_fruit_hitPart"
]
},
"vn-fnc-getdlc": {
"title": "VN fnc getDLC",
"callable": "VN_fnc_getDLC",
"slug": "vn-fnc-getdlc",
"description": "Gets the modDir and mod classname from an item.",
"syntax": "[_config] call VN_fnc_getDLC;",
"params": [
{
"name": "_config",
"type": "Config",
"typeMarkdown": "[Config](https://community.bistudio.com/wiki/Config)",
"description": "Item config",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of [_folder, _mod] where _folder is the modDir (for modParams), and _mod the classname in CfgMods [ARRAY] _folder and _mod are always the same (otherwise it's not a DLC)"
},
"examples": [],
"groups": [
"mainFunctions"
],
"groupLabels": [
"Shared helpers"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_getDLC"
]
},
"vn-fnc-getrelposdisp": {
"title": "VN fnc getRelPosDisp",
"callable": "VN_fnc_getRelPosDisp",
"slug": "vn-fnc-getrelposdisp",
"description": "Get relative Position on Display (4:3 to current AspectRatio).",
"syntax": "[_center,_distance,_angle,_angle_offset] call VN_fnc_getRelPosDisp;",
"params": [
{
"name": "_center",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "CenterPoint - Position to check",
"optional": true,
"default": "[0.5,0.5]"
},
{
"name": "_distance",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Distance to CenterPoint",
"optional": true,
"default": "0.1"
},
{
"name": "_angle",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Angle 0..360",
"optional": true,
"default": "0"
},
{
"name": "_angle_offset",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Offset to Angle",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "UI-Coords of relative Position"
},
"examples": [
"[ [0.5, 0.5], (pixelW * pixelGrid * 14.5), (360/10), -90] call vn_fnc_getRelPosDisp;"
],
"groups": [
"wheelmenu"
],
"groupLabels": [
"Wheel menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_getRelPosDisp"
]
},
"vn-fnc-getrevision": {
"title": "VN fnc getRevision",
"callable": "VN_fnc_getRevision",
"slug": "vn-fnc-getrevision",
"description": "Set the revision number on screen.",
"syntax": "[_control] call VN_fnc_getRevision;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Control where the text will be shown",
"optional": true,
"default": "controlNull"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"GUI"
],
"groupLabels": [
"GUI"
],
"version": "1.00",
"author": "Pieter De Stickere",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_getRevision"
]
},
"vn-fnc-holdactionadd": {
"title": "VN fnc holdActionAdd",
"callable": "VN_fnc_holdActionAdd",
"slug": "vn-fnc-holdactionadd",
"description": "Add a hold action. If the hold actions are not initialized yet, initialize the system first. See [BIS_fnc_holdActionAdd](https://community.bistudio.com/wiki/BIS_fnc_holdActionAdd).",
"syntax": "[\n target,\n title,\n iconIdle,\n iconProgress,\n condShow,\n condProgress,\n codeStart,\n codeProgress,\n codeCompleted,\n codeInterrupted,\n arguments,\n duration,\n priority,\n removeCompleted,\n showUnconscious,\n showWindow\n] call VN_fnc_holdActionAdd",
"params": [
{
"name": "target",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "object action is attached to",
"optional": true,
"default": "objNull"
},
{
"name": "title",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "action title text shown in action menu",
"optional": true,
"default": "\"MISSING TITLE\""
},
{
"name": "iconIdle",
"type": "String or Code",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String) or [Code](https://community.bistudio.com/wiki/Code)",
"description": "idle icon shown on screen; if [Code](https://community.bistudio.com/wiki/Code) is used, it needs to return the path to icon",
"optional": true,
"default": "\"\\A3\\Ui_f\\data\\IGUI\\Cfg\\HoldActions\\holdAction_revive_ca.paa\""
},
{
"name": "iconProgress",
"type": "String or Code",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String) or [Code](https://community.bistudio.com/wiki/Code)",
"description": "progress icon shown on screen; if [Code](https://community.bistudio.com/wiki/Code) is used, it needs to return the path to icon",
"optional": true,
"default": "\"\\A3\\Ui_f\\data\\IGUI\\Cfg\\HoldActions\\holdAction_revive_ca.paa\""
},
{
"name": "condShow",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "condition for the action to be shown; special variables passed to the script code are `_target` (unit to which action is attached to) and `_this` (caller/executing unit)",
"optional": true,
"default": "\"true\""
},
{
"name": "condProgress",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "condition for the action to progress; if [false](https://community.bistudio.com/wiki/false) is returned action progress is halted; arguments passed into it are: `_target`, `_caller`, `_id` and `_arguments`",
"optional": true,
"default": "\"true\""
},
{
"name": "codeStart",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "code executed on start; arguments passed *via* the `_this` variable are `[target, caller, ID, arguments]`:
• target: [Object](https://community.bistudio.com/wiki/Object) - (_this select 0) the object which the action is assigned to
• caller: [Object](https://community.bistudio.com/wiki/Object) - (_this select 1) the unit that activated the action
• id: [Number](https://community.bistudio.com/wiki/Number) - (_this select 2) id of the activated action (same as ID returned by [addAction](https://community.bistudio.com/wiki/addAction))
• arguments: [Array](https://community.bistudio.com/wiki/Array) - (_this select 3) - arguments given to the script if the extended syntax is used",
"optional": true,
"default": "{}"
},
{
"name": "codeProgress",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "code executed on every progress tick; arguments `[target, caller, ID, arguments, currentProgress]`; max progress is always 24",
"optional": true,
"default": "{}"
},
{
"name": "codeCompleted",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "code executed on completion; arguments `[target, caller, ID, arguments]`",
"optional": true,
"default": "{}"
},
{
"name": "codeInterrupted",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "code executed on interrupted; arguments `[target, caller, ID, arguments]`",
"optional": true,
"default": "{}"
},
{
"name": "arguments",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "arguments passed to the scripts",
"optional": true,
"default": "[]"
},
{
"name": "duration",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "action duration; how much time it takes to complete the action",
"optional": true,
"default": "10"
},
{
"name": "priority",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "actions are arranged in descending order according to this value",
"optional": true,
"default": "1000"
},
{
"name": "removeCompleted",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "remove on completion",
"optional": true,
"default": "true"
},
{
"name": "showUnconscious",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "show in unconscious state",
"optional": true,
"default": "false"
},
{
"name": "showWindow",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "show on screen; if false action needs to be selected from action menu to appear on screen",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "action id that can be used for removal or referencing from other functions"
},
"examples": [
"[\n\tplayer,\n\t\"Don't hold this action!\",\n\tnil,\n\tnil,\n\tnil,\n\tnil,\n\t\"hint 'please don't...\",\n\tnil,\n\t{ hint 'I -told- you!'; player setDamage 1 },\n\t{ hint \"phew, you didn't.\"; (_this select 0) removeAction (_this select 2) },\n\tnil,\n\t6\n] call VN_fnc_holdActionAdd"
],
"groups": [
"vn_hold_functions"
],
"groupLabels": [
"Hold actions"
],
"version": "1.00",
"author": "Jiri Wainar, edited by Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_holdActionAdd"
]
},
"vn-fnc-holdkey": {
"title": "VN fnc holdkey",
"callable": "VN_fnc_holdkey",
"slug": "vn-fnc-holdkey",
"description": "Function that exectues a user-defined code when a key has been held down for a long enough time.",
"syntax": "[_display,_keyToPress,_timeToPress,_code,_textControl] call VN_fnc_holdkey;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "On what display it should be working (map display is default)",
"optional": true,
"default": "findDisplay 12"
},
{
"name": "_keyToPress",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "What key to press",
"optional": true,
"default": "57"
},
{
"name": "_timeToPress",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "How long the key has to be held down",
"optional": true,
"default": "3"
},
{
"name": "_code",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "Code to be executed when key is held down for long enough",
"optional": true,
"default": "{}"
},
{
"name": "_textControl",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Text control to be used in place of the default \"Press X to skip\" control.",
"optional": true,
"default": "controlNull"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_end_functions"
],
"groupLabels": [
"Mission end (in mission)"
],
"version": "1.00",
"author": "ZoZo, modified by Riccardo Argiolas, mmodified further by Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_holdkey"
]
},
"vn-fnc-init": {
"title": "VN fnc init",
"callable": "VN_fnc_init",
"slug": "vn-fnc-init",
"description": "Initialize versioning system.",
"syntax": "[] call VN_fnc_init;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"versioning"
],
"groupLabels": [
"Versioning"
],
"version": "1.00",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_init"
]
},
"vn-fnc-initdisplay": {
"title": "VN fnc initDisplay",
"callable": "VN_fnc_initDisplay",
"slug": "vn-fnc-initdisplay",
"description": "No description added yet.",
"syntax": "[_data,_class] call VN_fnc_initDisplay;",
"params": [
{
"name": "_data",
"type": "Anything",
"typeMarkdown": "[Anything](https://community.bistudio.com/wiki/Anything)",
"description": "Unknown",
"optional": false,
"default": ""
},
{
"name": "_class",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Unknown",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"GUI"
],
"groupLabels": [
"GUI"
],
"version": "1.00",
"author": "Pieter De Stickere",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_initDisplay"
]
},
"vn-fnc-initdynamicradiomusic": {
"title": "VN fnc initdynamicradiomusic",
"callable": "VN_fnc_initdynamicradiomusic",
"slug": "vn-fnc-initdynamicradiomusic",
"description": "Gathers compatible sounds from cfgsounds then plays them as audio from radios placed around the mission.",
"syntax": "[] call VN_fnc_initdynamicradiomusic;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call vn_fnc_initdynamicradiomusic"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_initdynamicradiomusic"
]
},
"vn-fnc-initsituationalawareness": {
"title": "VN fnc initsituationalawareness",
"callable": "VN_fnc_initsituationalawareness",
"slug": "vn-fnc-initsituationalawareness",
"description": "Gathers compatible sounds from cfgsounds then plays them to simulate situational awareness for players.",
"syntax": "[] call VN_fnc_initsituationalawareness;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call vn_fnc_initsituationalawareness"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_initsituationalawareness"
]
},
"vn-fnc-kbm-eh-control-cancel-onbuttonclick": {
"title": "VN fnc kbm eh control cancel onButtonClick",
"callable": "VN_fnc_kbm_eh_control_cancel_onButtonClick",
"slug": "vn-fnc-kbm-eh-control-cancel-onbuttonclick",
"description": "Handles Cancel button click.",
"syntax": "[_control] call VN_fnc_kbm_eh_control_cancel_onButtonClick;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "A control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_eh_control_cancel_onButtonClick"
]
},
"vn-fnc-kbm-eh-control-default-onbuttonclick": {
"title": "VN fnc kbm eh control default onButtonClick",
"callable": "VN_fnc_kbm_eh_control_default_onButtonClick",
"slug": "vn-fnc-kbm-eh-control-default-onbuttonclick",
"description": "Handles Default button click.",
"syntax": "[_control] call VN_fnc_kbm_eh_control_default_onButtonClick;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "A control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_eh_control_default_onButtonClick"
]
},
"vn-fnc-kbm-eh-control-input-onkeydown": {
"title": "VN fnc kbm eh control input onkeyDown",
"callable": "VN_fnc_kbm_eh_control_input_onkeyDown",
"slug": "vn-fnc-kbm-eh-control-input-onkeydown",
"description": "No description added yet.",
"syntax": "[_control,_key,_shift,_ctrl,_alt] call VN_fnc_kbm_eh_control_input_onkeyDown;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Control attached to the event",
"optional": false,
"default": ""
},
{
"name": "_key",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "DIK Code of the pressed key",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is SHIFT pressed",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is CTRL pressed",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is ALT pressed",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Always returns true"
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_eh_control_input_onkeyDown"
]
},
"vn-fnc-kbm-eh-control-ok-onbuttonclick": {
"title": "VN fnc kbm eh control ok onButtonClick",
"callable": "VN_fnc_kbm_eh_control_ok_onButtonClick",
"slug": "vn-fnc-kbm-eh-control-ok-onbuttonclick",
"description": "Handles OK button click.",
"syntax": "[_control] call VN_fnc_kbm_eh_control_ok_onButtonClick;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "A control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_eh_control_ok_onButtonClick"
]
},
"vn-fnc-kbm-eh-display-onload": {
"title": "VN fnc kbm eh display onLoad",
"callable": "VN_fnc_kbm_eh_display_onLoad",
"slug": "vn-fnc-kbm-eh-display-onload",
"description": "Loads the display.",
"syntax": "[_display] call VN_fnc_kbm_eh_display_onLoad;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "A Display",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_eh_display_onLoad"
]
},
"vn-fnc-kbm-getkey": {
"title": "VN fnc kbm getKey",
"callable": "VN_fnc_kbm_getKey",
"slug": "vn-fnc-kbm-getkey",
"description": "Returns the currently assigned keybind to a specific action.",
"syntax": "[] call VN_fnc_kbm_getKey",
"params": [
{
"name": "action",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "name of the action as defined in config",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "format [key, shift, ctrl, alt]:
• key: [Number](https://community.bistudio.com/wiki/Number) - [DIK key code](https://community.bistudio.com/wiki/DIK_KeyCodes)
• shift: [Boolean](https://community.bistudio.com/wiki/Boolean) - shift modifier needed
• ctrl: [Boolean](https://community.bistudio.com/wiki/Boolean) - ctrl modifier needed
• alt: [Boolean](https://community.bistudio.com/wiki/Boolean) - alt modifier needed"
},
"examples": [
"private _data = [\"GestureMenu\"] call VN_fnc_kbm_getKey; // returns [15,false,false,false] (default)"
],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_getKey"
]
},
"vn-fnc-kbm-keyname": {
"title": "VN fnc kbm keyName",
"callable": "VN_fnc_kbm_keyName",
"slug": "vn-fnc-kbm-keyname",
"description": "Formats the key name with the modifiers.",
"syntax": "[_key,_shift,_ctrl,_alt] call VN_fnc_kbm_keyName;",
"params": [
{
"name": "_key",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "DIK Code",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Has SHIFT pressed",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Has CTRL pressed",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Has ALT pressed",
"optional": false,
"default": ""
}
],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Formated key name"
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_keyName"
]
},
"vn-fnc-kbm-load": {
"title": "VN fnc kbm load",
"callable": "VN_fnc_kbm_load",
"slug": "vn-fnc-kbm-load",
"description": "Initialize the keybindings loading and adds the event handler to the mission.",
"syntax": "[] call VN_fnc_kbm_load;",
"params": [],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": "Not used"
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_load"
]
},
"vn-fnc-kbm-loadkeys": {
"title": "VN fnc kbm loadKeys",
"callable": "VN_fnc_kbm_loadKeys",
"slug": "vn-fnc-kbm-loadkeys",
"description": "Loads the keybinds into the localNamespace.",
"syntax": "[] call VN_fnc_kbm_loadKeys;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_loadKeys"
]
},
"vn-fnc-kbm-loadtable": {
"title": "VN fnc kbm loadTable",
"callable": "VN_fnc_kbm_loadTable",
"slug": "vn-fnc-kbm-loadtable",
"description": "Populates the keybinding's menu table with the keybinds.",
"syntax": "[_control] call VN_fnc_kbm_loadTable;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Table Control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_loadTable"
]
},
"vn-fnc-kbm-onbuttonclick": {
"title": "VN fnc kbm onButtonClick",
"callable": "VN_fnc_kbm_onButtonClick",
"slug": "vn-fnc-kbm-onbuttonclick",
"description": "Handle a button click in the keybinding's menu.",
"syntax": "[_control] call VN_fnc_kbm_onButtonClick;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Button control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_onButtonClick"
]
},
"vn-fnc-kbm-onkey": {
"title": "VN fnc kbm onKey",
"callable": "VN_fnc_kbm_onKey",
"slug": "vn-fnc-kbm-onkey",
"description": "Handles the KeyDown / KeyUp event in the mission.",
"syntax": "[_isUp,_params,_display,_dik,_shift,_ctrl,_alt] call VN_fnc_kbm_onKey;",
"params": [
{
"name": "_isUp",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is KeyUp",
"optional": false,
"default": ""
},
{
"name": "_params",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Event params",
"optional": false,
"default": ""
},
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "Mission Display",
"optional": false,
"default": ""
},
{
"name": "_dik",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "DIK code of key pressed",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Shift key pressed",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Ctrl key pressed",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Alt key pressed",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_onKey"
]
},
"vn-fnc-kbm-onlbdblclick": {
"title": "VN fnc kbm onLBDblClick",
"callable": "VN_fnc_kbm_onLBDblClick",
"slug": "vn-fnc-kbm-onlbdblclick",
"description": "Handles LNB double-clicking to edit behavior.",
"syntax": "[_control, _index] call VN_fnc_kbm_onLBDblClick;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Table control",
"optional": false,
"default": ""
},
{
"name": "_index",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Row index",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_onLBDblClick"
]
},
"vn-fnc-kbm-onload": {
"title": "VN fnc kbm onLoad",
"callable": "VN_fnc_kbm_onLoad",
"slug": "vn-fnc-kbm-onload",
"description": "Keybindins menu load.",
"syntax": "[_control] call VN_fnc_kbm_onLoad;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Loader control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"keybinding"
],
"groupLabels": [
"Keybindings"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_kbm_onLoad"
]
},
"vn-fnc-log-getinventory": {
"title": "VN fnc log getInventory",
"callable": "VN_fnc_log_getInventory",
"slug": "vn-fnc-log-getinventory",
"description": "Returns the inventory of the provided vehicle.",
"syntax": "[vehicle] call VN_fnc_log_getInventory",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle or crate from which to get the inventory",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "list of inventory objects"
},
"examples": [
"[sogJeep] call VN_fnc_log_getInventory"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_getInventory"
]
},
"vn-fnc-log-isloaded": {
"title": "VN fnc log isLoaded",
"callable": "VN_fnc_log_isLoaded",
"slug": "vn-fnc-log-isloaded",
"description": "Checks if the object is loaded at all or if a vehicle is also passed checks if the object is loaded in the vehicle.\nIf *vehicle* is not provided then it will only check if the object is loaded in any vehicle.",
"syntax": "[object, vehicle] call VN_fnc_log_isLoaded",
"params": [
{
"name": "object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "object that may be loaded",
"optional": false,
"default": ""
},
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle inventory",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) if loaded, [false](https://community.bistudio.com/wiki/false) if not"
},
"examples": [
"[myCargo, sogJeep] call VN_fnc_log_isLoaded"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_isLoaded"
]
},
"vn-fnc-log-loadlogisticitem": {
"title": "VN fnc log loadLogisticItem",
"callable": "VN_fnc_log_loadLogisticItem",
"slug": "vn-fnc-log-loadlogisticitem",
"description": "Loads object into vehicle, removes it from the world.",
"syntax": "[player, objectToLoad] call VN_fnc_log_loadLogisticItem",
"params": [
{
"name": "player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "player object",
"optional": false,
"default": ""
},
{
"name": "objectToLoad",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "usually [cursorObject](https://community.bistudio.com/wiki/cursorObject)",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) on success, [false](https://community.bistudio.com/wiki/false) on error"
},
"examples": [
"[player, cursorObject] call VN_fnc_log_loadLogisticItem;"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_loadLogisticItem"
]
},
"vn-fnc-log-openlogisticsinventory": {
"title": "VN fnc log openLogisticsInventory",
"callable": "VN_fnc_log_openlogisticsinventory",
"slug": "vn-fnc-log-openlogisticsinventory",
"description": "Opens logistics inventory of the vehicle passed to this function.\nAlso used when inventory is reloaded e.g when an item is taken out of a inventory that is in use.",
"syntax": "[player, vehicle] call VN_fnc_log_openlogisticsinventory",
"params": [
{
"name": "player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "player object - mandatory but not used",
"optional": false,
"default": ""
},
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle from which inventory will be opened",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when"
},
"examples": [
"[player, sogJeep] call VN_fnc_log_openLogisticsInventory;"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_openLogisticsInventory"
]
},
"vn-fnc-log-pickuplogisticitem": {
"title": "VN fnc log pickupLogisticItem",
"callable": "VN_fnc_log_pickupLogisticItem",
"slug": "vn-fnc-log-pickuplogisticitem",
"description": "Picks up object the player is looking at. Creates a loop that moves the object in the direction of the players camera.\nStops when player dies, places object, gets into a vehicle or becomes incapacitated.",
"syntax": "[player, cursorObject] call VN_fnc_log_pickupLogisticItem",
"params": [
{
"name": "player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unit picking the item up",
"optional": false,
"default": ""
},
{
"name": "cursorObject",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "picked-up item",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) on success, [false](https://community.bistudio.com/wiki/false) on error"
},
"examples": [
"[player, sogJeep] call VN_fnc_log_pickupLogisticItem"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_pickupLogisticItem"
]
},
"vn-fnc-log-placelogisticitem": {
"title": "VN fnc log placeLogisticItem",
"callable": "VN_fnc_log_placeLogisticItem",
"slug": "vn-fnc-log-placelogisticitem",
"description": "Adds actions for players for the logistics module.",
"syntax": "[player, cursorObject] call VN_fnc_log_placeLogisticItem",
"params": [
{
"name": "player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unused, but must not be null",
"optional": false,
"default": ""
},
{
"name": "cursorObject",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unused",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) on success, [false](https://community.bistudio.com/wiki/false) on failure"
},
"examples": [
"[player] call VN_fnc_log_placeLogisticItem;"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_placeLogisticItem"
]
},
"vn-fnc-log-unloadlogisticitem": {
"title": "VN fnc log unloadLogisticItem",
"callable": "VN_fnc_log_unloadLogisticItem",
"slug": "vn-fnc-log-unloadlogisticitem",
"description": "Adds actions for players for the logistics module.",
"syntax": "[cursorObject, listIndex] call VN_fnc_log_unloadLogisticItem",
"params": [
{
"name": "cursorObject",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "object that has the object loaded into it",
"optional": false,
"default": ""
},
{
"name": "listIndex",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "index for the item in the listbox. Used for unloading & removal from the vehicle's virtual inventory",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) on success, [false](https://community.bistudio.com/wiki/false) on failure"
},
"examples": [
"[sogJeep, 3] call VN_fnc_log_unloadLogisticItem;"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_unloadLogisticItem"
]
},
"vn-fnc-log-useractions": {
"title": "VN fnc log userActions",
"callable": "VN_fnc_log_userActions",
"slug": "vn-fnc-log-useractions",
"description": "Adds actions for players for the logistics module.",
"syntax": "[] call VN_fnc_log_userActions",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_log_userActions"
],
"groups": [
"Logistics"
],
"groupLabels": [
"Logistics"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_log_userActions"
]
},
"vn-fnc-m151-towrackupdate": {
"title": "VN fnc m151 towRackUpdate",
"callable": "VN_fnc_m151_towRackUpdate",
"slug": "vn-fnc-m151-towrackupdate",
"description": "Hide spare TOW ammunition stored on M151 as rounds are fired.",
"syntax": "[_vehicle] call VN_fnc_m151_towRackUpdate;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle to update",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[truck] call vn_fnc_m151_towRackUpdate"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_m151_towRackUpdate"
]
},
"vn-fnc-m252-onload": {
"title": "VN fnc M252 onLoad",
"callable": "VN_fnc_M252_onLoad",
"slug": "vn-fnc-m252-onload",
"description": "Handles M252 load.",
"syntax": "[] call VN_fnc_M252_onLoad;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "The display passed down from the onLoad UIEH",
"optional": true,
"default": "NIL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Always returns true"
},
"examples": [
"onLoad = _this call vn_fnc_M252_onLoad; // Used in config"
],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Terra",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_M252_onLoad"
]
},
"vn-fnc-m72law": {
"title": "VN fnc m72law",
"callable": "VN_fnc_m72law",
"slug": "vn-fnc-m72law",
"description": "M72 LAW fired eventhandler function. Will wait until the player attempts to reload or stops holding the fire button.",
"syntax": "[\n _unit,\n _weapon,\n _muzzle,\n _mode,\n _ammo,\n _magazine,\n _projectile,\n _gunner\n] call VN_fnc_m72law;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit which the eventhandler is attached to.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_weapon",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Weapon classname of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_muzzle",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Muzzle of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_mode",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Mode of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_ammo",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Ammo of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_magazine",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Magazine of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_projectile",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Projectile of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_gunner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit that insigated the fired eventhandler.",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[player, \"weapon\", \"muzzle\", \"mode\", \"ammo\", \"magazine\", \"projectile\", gunner] call vn_fnc_myFunction;"
],
"groups": [
"vn_weapons_functions"
],
"groupLabels": [
"Weapon handling"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_m72law"
]
},
"vn-fnc-masterarm": {
"title": "VN fnc masterArm",
"callable": "VN_fnc_masterArm",
"slug": "vn-fnc-masterarm",
"description": "Master arm master function, setups and creates the display and everything it needs.",
"syntax": "[mode, arguments] call VN_fnc_masterArm",
"params": [
{
"name": "mode",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "case-insensitive. Can be:
• \"Draw3D\"
• \"Mouse\"
• \"MouseButtonDown\"
• \"MouseButtonUp\"
• \"MouseZChanged\"
• \"OnLoad\"
• \"OnUnload\"
• \"Init\"
• \"InitGUI\"
• \"Exit\"
• \"Exit:Revert\"
• \"Exit:Confirm\"
• \"Button:Rearm\"
• \"Button:Refuel\"
• \"Button:Repair\"
• \"Original\"
• \"ShowInfo\"
• \"ShowStats\"
• \"ShowMessage\"
• \"CalculateSupplies\"
• \"Preload\"
• \"Tab:Preload\"
• \"Tab:Select\"
• \"List:Select\"
• \"List:Reload\"
• \"Vehicle:Animate\"
• \"Vehicle:Texture\"
• \"Vehicle:Loadout\"",
"optional": false,
"default": ""
},
{
"name": "arguments",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "*mode* arguments",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[\"Init\"] call VN_fnc_masterArm;"
],
"groups": [
"MasterArm"
],
"groupLabels": [
"Master arm"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_masterArm"
]
},
"vn-fnc-masterarm-actions": {
"title": "VN fnc masterArm actions",
"callable": "VN_fnc_masterArm_actions",
"slug": "vn-fnc-masterarm-actions",
"description": "Adds Master Arm action to the player.",
"syntax": "[] call VN_fnc_masterArm_actions",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_masterArm_actions"
],
"groups": [
"MasterArm"
],
"groupLabels": [
"Master arm"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_masterArm_actions"
]
},
"vn-fnc-melee-action": {
"title": "VN fnc melee action",
"callable": "VN_fnc_melee_action",
"slug": "vn-fnc-melee-action",
"description": "Called when the player passes a melee action check, runs the melee code.",
"syntax": "[_player] call VN_fnc_melee_action;",
"params": [
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Player object",
"optional": true,
"default": "PLAYER"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player] call vn_fnc_melee_action;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_action"
]
},
"vn-fnc-melee-action-check": {
"title": "VN fnc melee action check",
"callable": "VN_fnc_melee_action_check",
"slug": "vn-fnc-melee-action-check",
"description": "Function called when keyhandler is activated, uses condition to check if player can melee.",
"syntax": "[] call VN_fnc_melee_action_check;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"call vn_fnc_melee_action_check;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_action_check"
]
},
"vn-fnc-melee-action-handgun": {
"title": "VN fnc melee action handgun",
"callable": "VN_fnc_melee_action_handgun",
"slug": "vn-fnc-melee-action-handgun",
"description": "Called when the player passes a melee action check, runs the melee code, handgun weapon specific.",
"syntax": "[] call VN_fnc_melee_action_handgun;",
"params": [
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Player object",
"optional": true,
"default": "PLAYER"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player] call vn_fnc_melee_action_handgun;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_action_handgun"
]
},
"vn-fnc-melee-damage": {
"title": "VN fnc melee damage",
"callable": "VN_fnc_melee_damage",
"slug": "vn-fnc-melee-damage",
"description": "Deal damage to the unit that has been intersected through the melee system.",
"syntax": "[\n _projectile,\n _impact_asl,\n _time,\n _normal,\n _object,\n _player,\n _evh,\n _start_time\n] call VN_fnc_melee_damage;",
"params": [
{
"name": "_projectile",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Projectile object",
"optional": false,
"default": ""
},
{
"name": "_impact_asl",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Impact ASL position",
"optional": false,
"default": ""
},
{
"name": "_time",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Current time",
"optional": false,
"default": ""
},
{
"name": "_normal",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Impact normal",
"optional": false,
"default": ""
},
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object that has been intersected",
"optional": false,
"default": ""
},
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Players object",
"optional": false,
"default": ""
},
{
"name": "_evh",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Eventhandler ID",
"optional": false,
"default": ""
},
{
"name": "_start_time",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Time at which the action started",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[bullet, [1,1,5], 15, [0,0,1], man1, player, \"melee_evh\", 10] call vn_fnc_melee_damage;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_damage"
]
},
"vn-fnc-melee-drainstamina": {
"title": "VN fnc melee drainstamina",
"callable": "VN_fnc_melee_drainstamina",
"slug": "vn-fnc-melee-drainstamina",
"description": "Drain players stamina when doing a melee action.",
"syntax": "[_player] call VN_fnc_melee_drainstamina;",
"params": [
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Players object.",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player] call vn_fnc_melee_drainstamina;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_drainstamina"
]
},
"vn-fnc-melee-draw": {
"title": "VN fnc melee draw",
"callable": "VN_fnc_melee_draw",
"slug": "vn-fnc-melee-draw",
"description": "Draw icons from melee debug system.",
"syntax": "[_posStart,_posEnd,_color,_label] call VN_fnc_melee_draw;",
"params": [
{
"name": "_posStart",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Start position",
"optional": true,
"default": "[]"
},
{
"name": "_posEnd",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "End position",
"optional": true,
"default": "[]"
},
{
"name": "_color",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Line color",
"optional": true,
"default": "[]"
},
{
"name": "_label",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Icon label",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[ [0,0,0],[1,1,1],[1,0,0],\"Hello :)\" ] call vn_fnc_melee_draw;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_draw"
]
},
"vn-fnc-melee-fired": {
"title": "VN fnc melee fired",
"callable": "VN_fnc_melee_fired",
"slug": "vn-fnc-melee-fired",
"description": "Function runs when player fires the melee action.",
"syntax": "[_position,_offset,_length,_player,_butt] call VN_fnc_melee_fired;",
"params": [
{
"name": "_projectile",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Projectile object",
"optional": false,
"default": ""
},
{
"name": "_offset",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Offset from the selection position",
"optional": false,
"default": ""
},
{
"name": "_length",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Length of the intersection",
"optional": false,
"default": ""
},
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Player object",
"optional": false,
"default": ""
},
{
"name": "_butt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is this a butt action",
"optional": true,
"default": "false"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[bullet, [0,1,0], 5, player, false] call vn_fnc_melee_fired"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_fired"
]
},
"vn-fnc-melee-init": {
"title": "VN fnc melee init",
"callable": "VN_fnc_melee_init",
"slug": "vn-fnc-melee-init",
"description": "Setup mission variables and sound config variables.",
"syntax": "[] call VN_fnc_melee_init;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"call vn_fnc_melee_init;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_init"
]
},
"vn-fnc-melee-offset": {
"title": "VN fnc melee offset",
"callable": "VN_fnc_melee_offset",
"slug": "vn-fnc-melee-offset",
"description": "Get position offset from selection.",
"syntax": "[\n _selection,\n _offset,\n _player,\n _handgun,\n _custom_dir_vector\n] call VN_fnc_melee_offset;",
"params": [
{
"name": "_selection",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Selection to use for the offset",
"optional": true,
"default": "\"\""
},
{
"name": "_offset",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Relative offset",
"optional": true,
"default": "[0,0,0]"
},
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Player object",
"optional": true,
"default": "PLAYER"
},
{
"name": "_handgun",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should the handgun angle offset be added",
"optional": true,
"default": "FALSE"
},
{
"name": "_custom_dir_vector",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Custom direction vector for special animaions",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Relative offset"
},
"examples": [
"[\"head\", [0,0,1], player, 90] call vn_fnc_melee_offset;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_offset"
]
},
"vn-fnc-melee-onload": {
"title": "VN fnc melee onload",
"callable": "VN_fnc_melee_onload",
"slug": "vn-fnc-melee-onload",
"description": "Setup keyhandlers and variables used in the melee action function(s) Add unload check to internal loop function.",
"syntax": "[_display] call VN_fnc_melee_onload;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "Main display",
"optional": true,
"default": "DISPLAYNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[findDisplay 46] call vn_fnc_melee_onload;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_onload"
]
},
"vn-fnc-melee-onunload": {
"title": "VN fnc melee onunload",
"callable": "VN_fnc_melee_onunload",
"slug": "vn-fnc-melee-onunload",
"description": "Remove keyhandlers and remove variables saved.",
"syntax": "[_display] call VN_fnc_melee_onunload;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "Main display",
"optional": true,
"default": "DISPLAYNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[findDisplay 46] call vn_fnc_melee_onunload;"
],
"groups": [
"vn_melee_functions"
],
"groupLabels": [
"Melee"
],
"version": "1.00",
"author": "Kerc/IFA3 & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_melee_onunload"
]
},
"vn-fnc-menu-credits": {
"title": "VN fnc menu credits",
"callable": "VN_fnc_menu_credits",
"slug": "vn-fnc-menu-credits",
"description": "Plays credits scene over menu display",
"syntax": "[_control] call VN_fnc_menu_credits;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[true, { hint \"Credits done!\"; }] call vn_fnc_credits"
],
"groups": [
"end"
],
"groupLabels": [
"Mission end (main menu)"
],
"version": "1.00",
"author": "Ethan Johnson, Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_menu_credits"
]
},
"vn-fnc-menu-music": {
"title": "VN fnc menu music",
"callable": "VN_fnc_menu_music",
"slug": "vn-fnc-menu-music",
"description": "Handles main menu music.",
"syntax": "[_playlist] call VN_fnc_menu_music;",
"params": [
{
"name": "_playlist",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of [_classname, _padding]",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"end"
],
"groupLabels": [
"Mission end (main menu)"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_menu_music"
]
},
"vn-fnc-module-advancedrevive": {
"title": "VN fnc module advancedRevive",
"callable": "VN_fnc_module_advancedRevive",
"slug": "vn-fnc-module-advancedrevive",
"description": "Master module function that starts the advanced revive system.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_advancedRevive",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_advancedRevive;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_advancedRevive"
]
},
"vn-fnc-module-ambient-audio": {
"title": "VN fnc module ambient audio",
"callable": "VN_fnc_module_ambient_audio",
"slug": "vn-fnc-module-ambient-audio",
"description": "No description added yet.",
"syntax": "[] call VN_fnc_module_ambient_audio;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Logic unit",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "List of units",
"optional": true,
"default": "[]"
},
{
"name": "_activated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Activated variable",
"optional": true,
"default": "TRUE"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[logic, [], true] call VN_fnc_module_ambient_audio"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_ambient_audio"
]
},
"vn-fnc-module-artillery": {
"title": "VN fnc module artillery",
"callable": "VN_fnc_module_artillery",
"slug": "vn-fnc-module-artillery",
"description": "Setup function for the artillery module system.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_artillery",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_artillery;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_artillery"
]
},
"vn-fnc-module-cinematic": {
"title": "VN fnc module cinematic",
"callable": "VN_fnc_module_cinematic",
"slug": "vn-fnc-module-cinematic",
"description": "Cinematic module base. Uses VN_fnc_cinematic_play.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_cinematic",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_cinematic;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_cinematic"
]
},
"vn-fnc-module-jukebox-disable": {
"title": "VN fnc module jukebox disable",
"callable": "VN_fnc_module_jukebox_disable",
"slug": "vn-fnc-module-jukebox-disable",
"description": "Disables the jukebox actions for the player",
"syntax": "[_logic, _units, _activated] call VN_fnc_module_jukebox_disable;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Logic unit",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "List of units",
"optional": true,
"default": "[]"
},
{
"name": "_activated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Activated variable",
"optional": true,
"default": "TRUE"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[logic, [], true] call vn_fnc_module_jukebox_disable;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_jukebox_disable"
]
},
"vn-fnc-module-logistics": {
"title": "VN fnc module logistics",
"callable": "VN_fnc_module_logistics",
"slug": "vn-fnc-module-logistics",
"description": "Module function for the logistics. Sets up variables for the item & vehicle list and adds the actions for clients *via* VN_fnc_log_userActions.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_logistics",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units, unused",
"optional": true,
"default": "[]"
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_logistics;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_logistics"
]
},
"vn-fnc-module-masterarm": {
"title": "VN fnc module masterArm",
"callable": "VN_fnc_module_masterarm",
"slug": "vn-fnc-module-masterarm",
"description": "Master arm setup module function, uses VN_fnc_masterArm_actions.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_masterarm",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units, unused",
"optional": true,
"default": "[]"
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_masterArm;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_masterArm"
]
},
"vn-fnc-module-onslaught": {
"title": "VN fnc module onslaught",
"callable": "VN_fnc_module_onslaught",
"slug": "vn-fnc-module-onslaught",
"description": "Module init for the Onslaught module system, gathers and spawns units at predefined spawn points and gives them their tactic orders.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_onslaught",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_onslaught"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_onslaught"
]
},
"vn-fnc-module-qol": {
"title": "VN fnc module QOL",
"callable": "VN_fnc_module_QOL",
"slug": "vn-fnc-module-qol",
"description": "**Q**uality **O**f **L**ife (ear plugs) module changes",
"syntax": "[logic, units, isActivated] call VN_fnc_module_QOL",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_QOL;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_QOL"
]
},
"vn-fnc-module-site": {
"title": "VN fnc module site",
"callable": "VN_fnc_module_site",
"slug": "vn-fnc-module-site",
"description": "Internal BIS function for sites",
"syntax": "[] call VN_fnc_module_site;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call VN_fnc_module_site;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_site"
]
},
"vn-fnc-module-tunnel": {
"title": "VN fnc module tunnel",
"callable": "VN_fnc_module_tunnel",
"slug": "vn-fnc-module-tunnel",
"description": "Tunnel entrance module.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_tunnel",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units, unused",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_tunnel;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_tunnel"
]
},
"vn-fnc-module-tunnel-init": {
"title": "VN fnc module tunnel init",
"callable": "VN_fnc_module_tunnel_init",
"slug": "vn-fnc-module-tunnel-init",
"description": "Function initializes a tunnel.",
"syntax": "[_logic, _units, _activated] call VN_fnc_module_tunnel_init;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Logic unit",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "List of units",
"optional": true,
"default": "[]"
},
{
"name": "_activated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Activated variable",
"optional": true,
"default": "TRUE"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[logic, [], true] call vn_fnc_module_tunnel_init"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_tunnel_init"
]
},
"vn-fnc-module-ui-gesturemenu-init": {
"title": "VN fnc module UI gestureMenu init",
"callable": "VN_fnc_module_UI_gestureMenu_init",
"slug": "vn-fnc-module-ui-gesturemenu-init",
"description": "Loads up the STANDARD Version for the Gesture-Wheelmenu and adds Keyhandler. Default key: Y (on a QWERTY keyboard).",
"syntax": "[logic, units, isActivated] call VN_fnc_module_UI_gestureMenu_init",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units, unused",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_UI_gestureMenu_init;"
],
"groups": [
"gesture_menu"
],
"groupLabels": [
"Gesture menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_UI_gestureMenu_init"
]
},
"vn-fnc-module-ui-gesturemenu-init-custom": {
"title": "VN fnc module UI gestureMenu init custom",
"callable": "VN_fnc_module_UI_gestureMenu_init_custom",
"slug": "vn-fnc-module-ui-gesturemenu-init-custom",
"description": "Loads up the CUSTOM Version for the Gesture-Wheelmenu and adds Keyhandler. Default key: Y (on a QWERTY keyboard).",
"syntax": "[logic, units, isActivated] call VN_fnc_module_UI_gestureMenu_init_custom",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_UI_gestureMenu_init_custom;"
],
"groups": [
"gesture_menu"
],
"groupLabels": [
"Gesture menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_UI_gestureMenu_init_custom"
]
},
"vn-fnc-module-ui-gesturemenu-keyhandler": {
"title": "VN fnc module UI gestureMenu KeyHandler",
"callable": "VN_fnc_module_UI_gestureMenu_KeyHandler",
"slug": "vn-fnc-module-ui-gesturemenu-keyhandler",
"description": "[\"keyUp\" UI Eventhandler](https://community.bistudio.com/wiki/User_Interface_Event_Handlers#onKeyUp) function, runs code and blocks standard key. Default key: Y (on a QWERTY keyboard).\nUses VN_fnc_kbm_getKey.",
"syntax": "[display, key, shift, ctrl, alt] call VN_fnc_module_UI_gestureMenu_KeyHandler",
"params": [
{
"name": "display",
"type": "Display or Control",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display) or [Control](https://community.bistudio.com/wiki/Control)",
"description": "EH display or control, unused",
"optional": true,
"default": "nil"
},
{
"name": "key",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "pressed key",
"optional": false,
"default": ""
},
{
"name": "shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is shift key pressed",
"optional": false,
"default": ""
},
{
"name": "ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is ctrl key pressed",
"optional": false,
"default": ""
},
{
"name": "alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is alt key pressed",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"(findDisplay 46) displayAddEventHandler [\"KeyUp\", { call VN_fnc_module_UI_gestureMenu_KeyHandler; }];"
],
"groups": [
"gesture_menu"
],
"groupLabels": [
"Gesture menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_UI_gestureMenu_KeyHandler"
]
},
"vn-fnc-module-water-fall": {
"title": "VN fnc module water fall",
"callable": "VN_fnc_module_water_fall",
"slug": "vn-fnc-module-water-fall",
"description": "No description added yet.",
"syntax": "[_logic, _units, _activated] call VN_fnc_module_water_fall;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Logic unit",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "List of units",
"optional": true,
"default": "[]"
},
{
"name": "_activated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Activated variable",
"optional": true,
"default": "TRUE"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[logic, [], true] call VN_fnc_module_water_fall;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_water_fall"
]
},
"vn-fnc-module-whitelistedarsenal": {
"title": "VN fnc module whitelistedArsenal",
"callable": "VN_fnc_module_whitelistedArsenal",
"slug": "vn-fnc-module-whitelistedarsenal",
"description": "Module function for whitelisted arsenal. Executes server-side code and triggers client initialisation.",
"syntax": "[logic, units, isActivated] call VN_fnc_module_whitelistedArsenal",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_module_whitelistedArsenal;"
],
"groups": [
"master_functions"
],
"groupLabels": [
"Module setup"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_module_whitelistedArsenal"
]
},
"vn-fnc-modulehvtinit": {
"title": "VN fnc moduleHvtInit",
"callable": "VN_fnc_moduleHvtInit",
"slug": "vn-fnc-modulehvtinit",
"description": "No description added yet.",
"syntax": "[] call VN_fnc_moduleHvtInit;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_endgame"
],
"groupLabels": [
"HVT objectives"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_moduleHvtInit"
]
},
"vn-fnc-modulehvtobjective": {
"title": "VN fnc moduleHvtObjective",
"callable": "VN_fnc_moduleHvtObjective",
"slug": "vn-fnc-modulehvtobjective",
"description": "No description added yet.",
"syntax": "[\"_action\", \"_parameters\"] call VN_fnc_moduleHvtObjectivesInstance;",
"params": [
{
"name": "_action",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "",
"optional": true,
"default": "\"\""
},
{
"name": "_parameters",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_endgame"
],
"groupLabels": [
"HVT objectives"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_moduleHvtObjective"
]
},
"vn-fnc-modulehvtobjectives": {
"title": "VN fnc moduleHvtObjectives",
"callable": "VN_fnc_moduleHvtObjectives",
"slug": "vn-fnc-modulehvtobjectives",
"description": "No description added yet.",
"syntax": "[\"_logic\", \"_units\", \"_activated\"] call VN_fnc_moduleHvtObjectives;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": true,
"default": "objNull"
},
{
"name": "_units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "",
"optional": true,
"default": "[]"
},
{
"name": "_activated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [],
"groups": [
"vn_endgame"
],
"groupLabels": [
"HVT objectives"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_moduleHvtObjectives"
]
},
"vn-fnc-modulehvtobjectivesinstance": {
"title": "VN fnc moduleHvtObjectivesInstance",
"callable": "VN_fnc_moduleHvtObjectivesInstance",
"slug": "vn-fnc-modulehvtobjectivesinstance",
"description": "No description added yet.",
"syntax": "[\"_action\", \"_parameters\"] call VN_fnc_moduleHvtObjectivesInstance;",
"params": [
{
"name": "_action",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "",
"optional": true,
"default": "\"\""
},
{
"name": "_parameters",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_endgame"
],
"groupLabels": [
"HVT objectives"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_moduleHvtObjectivesInstance"
]
},
"vn-fnc-music": {
"title": "VN fnc music",
"callable": "VN_fnc_music",
"slug": "vn-fnc-music",
"description": "Main function for the vehicle music system.",
"syntax": "[_mode,_params] call VN_fnc_music;",
"params": [
{
"name": "_mode",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Switch mode.",
"optional": true,
"default": "\"\""
},
{
"name": "_params",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Params array which contains variables for specific modes.",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[\"open\"] call vn_fnc_music;"
],
"groups": [
"vn_music_functions"
],
"groupLabels": [
"Audio (vehicle music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_music"
]
},
"vn-fnc-music-play": {
"title": "VN fnc music play",
"callable": "VN_fnc_music_play",
"slug": "vn-fnc-music-play",
"description": "say3D's the given audio from the given object, this function is made to be remote executed on clients.",
"syntax": "[_vehicle,_class] call VN_fnc_music_play;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "'Vehicle' which will play the sound",
"optional": false,
"default": ""
},
{
"name": "_class",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "CfgSounds classname which will be played.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[object_01,\"pingpong\"] call vn_fnc_music_play;"
],
"groups": [
"vn_music_functions"
],
"groupLabels": [
"Audio (vehicle music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_music_play"
]
},
"vn-fnc-music-stop": {
"title": "VN fnc music stop",
"callable": "VN_fnc_music_stop",
"slug": "vn-fnc-music-stop",
"description": "Stops audio from playing from the vehicle.",
"syntax": "[_vehicle] call VN_fnc_music_stop;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "'Vehicle' which will play the sound",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[object_01] call vn_fnc_music_stop;"
],
"groups": [
"vn_music_functions"
],
"groupLabels": [
"Audio (vehicle music)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_music_stop"
]
},
"vn-fnc-numbertobase": {
"title": "VN fnc numberToBase",
"callable": "VN_fnc_numberToBase",
"slug": "vn-fnc-numbertobase",
"description": "Converts a number from one base to another",
"syntax": "[_number,_base] call VN_fnc_numberToBase;",
"params": [
{
"name": "_number",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Number",
"optional": false,
"default": ""
},
{
"name": "_base",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Base",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of number in base"
},
"examples": [
"[255, 16] call vn_fnc_numberToBase; // [15, 15]"
],
"groups": [
"mainFunctions"
],
"groupLabels": [
"Shared helpers"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_numberToBase"
]
},
"vn-fnc-onarsenalopened": {
"title": "VN fnc onArsenalOpened",
"callable": "VN_fnc_onArsenalOpened",
"slug": "vn-fnc-onarsenalopened",
"description": "Handle arsenal display open.",
"syntax": "[_ctrl] call VN_fnc_onArsenalOpened;",
"params": [
{
"name": "_ctrl",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Dummy arsenal load handling control.",
"optional": true,
"default": "controlNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[] call vn_fnc_onArsenalOpened;"
],
"groups": [
"vn_weapons_functions"
],
"groupLabels": [
"Weapon handling"
],
"version": "1.00",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_onArsenalOpened"
]
},
"vn-fnc-player": {
"title": "VN fnc player",
"callable": "VN_fnc_player",
"slug": "vn-fnc-player",
"description": "Uses getVariable to get the current remoted controlled unit, if the player is not remote controlling a unit then the players unit is returned.\nUsed to get the current unit the player is controlling.",
"syntax": "[] call VN_fnc_player;",
"params": [],
"returns": {
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Player object"
},
"examples": [
"call vn_fnc_player"
],
"groups": [
"vn_player_functions"
],
"groupLabels": [
"Player object"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_player"
]
},
"vn-fnc-playgesture": {
"title": "VN fnc playGesture",
"callable": "VN_fnc_playGesture",
"slug": "vn-fnc-playgesture",
"description": "Play given animation and send the selected Icon (via CmdOverlay) to all Groupmembers within reach (\"vn_cmdOL_maxDistance\").",
"syntax": "[_UsedIcon,_gesture,_actionName,_showNotification] call VN_fnc_playGesture;",
"params": [
{
"name": "_UsedIcon",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "path to selected Icon",
"optional": true,
"default": "\"\""
},
{
"name": "_gesture",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Gesture",
"optional": true,
"default": "\"\""
},
{
"name": "_actionName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "String OR Stringtable - not beeing used atm, still keeping it for future-updates",
"optional": true,
"default": "\"\""
},
{
"name": "_showNotification",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Show in CmdOverlay or not",
"optional": true,
"default": "TRUE"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[\n\"vn\\ui_f_vietnam\\ui\\wheelmenu\\img\\handsignals\\ui_wm_selector_hand_001_ca.paa\",\n\"vn_handsignal_freeze\",\n\"STR_VN_UI_WM_SELECTOR_HAND_001_DN\"\t//\"I am a Text\",\ntrue\n] call vn_fnc_playGesture;"
],
"groups": [
"cmdOverlay"
],
"groupLabels": [
"Command overlay"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_playGesture"
]
},
"vn-fnc-prc77-onload": {
"title": "VN fnc PRC77 onLoad",
"callable": "VN_fnc_PRC77_onLoad",
"slug": "vn-fnc-prc77-onload",
"description": "Handles UI Loading.",
"syntax": "[] call VN_fnc_PRC77_onLoad;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "UI Display",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_onLoad"
]
},
"vn-fnc-prc77-onupdate": {
"title": "VN fnc PRC77 onUpdate",
"callable": "VN_fnc_PRC77_onUpdate",
"slug": "vn-fnc-prc77-onupdate",
"description": "Handles UI Updates.",
"syntax": "[] call VN_fnc_PRC77_onUpdate;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_onUpdate"
]
},
"vn-fnc-prc77-setadditional": {
"title": "VN fnc PRC77 setAdditional",
"callable": "VN_fnc_PRC77_setAdditional",
"slug": "vn-fnc-prc77-setadditional",
"description": "Sets additional frequency.",
"syntax": "[] call VN_fnc_PRC77_setAdditional;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setAdditional"
]
},
"vn-fnc-prc77-setaudio": {
"title": "VN fnc PRC77 setAudio",
"callable": "VN_fnc_PRC77_setAudio",
"slug": "vn-fnc-prc77-setaudio",
"description": "Sets audio speakers.",
"syntax": "[] call VN_fnc_PRC77_setAudio;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setAudio"
]
},
"vn-fnc-prc77-setchannel": {
"title": "VN fnc PRC77 setChannel",
"callable": "VN_fnc_PRC77_setChannel",
"slug": "vn-fnc-prc77-setchannel",
"description": "Sets channel.",
"syntax": "[] call VN_fnc_PRC77_setChannel;",
"params": [
{
"name": "onMouseButtonDown",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setChannel"
]
},
"vn-fnc-prc77-setfrequency": {
"title": "VN fnc PRC77 setFrequency",
"callable": "VN_fnc_PRC77_setFrequency",
"slug": "vn-fnc-prc77-setfrequency",
"description": "Sets frequency.",
"syntax": "[] call VN_fnc_PRC77_setFrequency;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setFrequency"
]
},
"vn-fnc-prc77-setkhz": {
"title": "VN fnc PRC77 setKHz",
"callable": "VN_fnc_PRC77_setKHz",
"slug": "vn-fnc-prc77-setkhz",
"description": "Sets KHzs. Parameter are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_PRC77_setKHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setKHz"
]
},
"vn-fnc-prc77-setmhz": {
"title": "VN fnc PRC77 setMHz",
"callable": "VN_fnc_PRC77_setMHz",
"slug": "vn-fnc-prc77-setmhz",
"description": "Sets MHzs. Parameter are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_PRC77_setMHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setMHz"
]
},
"vn-fnc-prc77-setstereo": {
"title": "VN fnc PRC77 setStereo",
"callable": "VN_fnc_PRC77_setStereo",
"slug": "vn-fnc-prc77-setstereo",
"description": "Sets stereo.",
"syntax": "[] call VN_fnc_PRC77_setStereo;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setStereo"
]
},
"vn-fnc-prc77-setvolume": {
"title": "VN fnc PRC77 setVolume",
"callable": "VN_fnc_PRC77_setVolume",
"slug": "vn-fnc-prc77-setvolume",
"description": "Sets volume. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_PRC77_setVolume;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_PRC77_setVolume"
]
},
"vn-fnc-qol-earplugs": {
"title": "VN fnc QOL earplugs",
"callable": "VN_fnc_QOL_earplugs",
"slug": "vn-fnc-qol-earplugs",
"description": "Gives player the earplugs action.",
"syntax": "[] call VN_fnc_QOL_earplugs",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_QOL_earplugs;"
],
"groups": [
"QOL"
],
"groupLabels": [
"Quality of life"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_QOL_earplugs"
]
},
"vn-fnc-radar-initdisplay": {
"title": "VN fnc radar initDisplay",
"callable": "VN_fnc_radar_initDisplay",
"slug": "vn-fnc-radar-initdisplay",
"description": "Automatically initialised on the RscInGameUI onLoad event for shantou and ptf, this function is used to manage any kind of UI manipulation while the player is inside the boat, particularly MFD rendering.",
"syntax": "[vehicle, unused, unit] call VN_fnc_radar_initDisplay",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle with display",
"optional": false,
"default": ""
},
{
"name": "unused",
"type": "",
"typeMarkdown": "",
"description": "unused argument",
"optional": false,
"default": ""
},
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "**has** to be [player](https://community.bistudio.com/wiki/player)!",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[sogBoat, nil, player] call VN_fnc_radar_initDisplay;"
],
"groups": [
"boat_functions"
],
"groupLabels": [
"Boats"
],
"version": "1.00",
"author": "",
"argumentsLocality": "local",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_radar_initDisplay"
]
},
"vn-fnc-remotesay3d": {
"title": "VN fnc remoteSay3D",
"callable": "VN_fnc_remoteSay3D",
"slug": "vn-fnc-remotesay3d",
"description": "Executes [say3D](https://community.bistudio.com/wiki/say3D) on all systems.",
"syntax": "[object, sound] call VN_fnc_remoteSay3D",
"params": [
{
"name": "object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "sound source",
"optional": false,
"default": ""
},
{
"name": "sound",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "always `\"\"` from [remoteExec](https://community.bistudio.com/wiki/remoteExec) usage"
},
"examples": [
"[player, \"holdFire\"] call VN_fnc_remoteSay3D; // identical to syntax player say3D \"holdFire\""
],
"groups": [
"vn_functions"
],
"groupLabels": [
"Miscellaneous (core)"
],
"version": "1.00",
"author": "TeTeT",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_remoteSay3D"
]
},
"vn-fnc-respawn-none": {
"title": "VN fnc respawn none",
"callable": "VN_fnc_respawn_none",
"slug": "vn-fnc-respawn-none",
"description": "Overwrite of the single player death screen.",
"syntax": "[] call VN_fnc_respawn_none;",
"params": [
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Killed unit",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_killer",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Killed unit",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[player, object_01] call vn_fnc_respawn_none;"
],
"groups": [
"vn_respawn_functions"
],
"groupLabels": [
"Respawn (core)"
],
"version": "1.00",
"author": "Karel Moricky & Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_respawn_none"
]
},
"vn-fnc-revive-action-dragplayer": {
"title": "VN fnc revive action dragPlayer",
"callable": "VN_fnc_revive_action_dragPlayer",
"slug": "vn-fnc-revive-action-dragplayer",
"description": "Main player dragging action function. Uses VN_fnc_revive_conversation and VN_fnc_revive_action_dragPlayer_client.",
"syntax": "[draggedUnit, type] call VN_fnc_revive_action_dragPlayer",
"params": [
{
"name": "draggedUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[cursorObject, 3] call VN_fnc_revive_action_dragPlayer;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_dragPlayer"
]
},
"vn-fnc-revive-action-dragplayer-client": {
"title": "VN fnc revive action dragPlayer client",
"callable": "VN_fnc_revive_action_dragPlayer_client",
"slug": "vn-fnc-revive-action-dragplayer-client",
"description": "Client function for the dragging of a player, sets their animation & changes their direction to make sure they face the correct direction.",
"syntax": "[dragged] call VN_fnc_revive_action_dragPlayer_client",
"params": [
{
"name": "dragged",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "dragged unit which will play animation & be turned around",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[cursorObject] call VN_fnc_revive_action_dragPlayer_client;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_dragPlayer_client"
]
},
"vn-fnc-revive-action-dropplayer": {
"title": "VN fnc revive action dropPlayer",
"callable": "VN_fnc_revive_action_dropPlayer",
"slug": "vn-fnc-revive-action-dropplayer",
"description": "Main player dropping action function. Uses VN_fnc_revive_conversation and VN_fnc_revive_detachUnit.",
"syntax": "[draggedUnit, type] call VN_fnc_revive_action_dropPlayer",
"params": [
{
"name": "draggedUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[cursorObject, 3] call VN_fnc_revive_action_dropPlayer;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_dropPlayer"
]
},
"vn-fnc-revive-action-grenade": {
"title": "VN fnc revive action grenade",
"callable": "VN_fnc_revive_action_grenade",
"slug": "vn-fnc-revive-action-grenade",
"description": "Player action function for grenade suicide.",
"syntax": "[suicider, type] call VN_fnc_revive_action_grenade",
"params": [
{
"name": "suicider",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "(Optional, not used - uses [player](https://community.bistudio.com/wiki/player)) the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[objNull, 3] call VN_fnc_revive_action_grenade;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_grenade"
]
},
"vn-fnc-revive-action-heal": {
"title": "VN fnc revive action heal",
"callable": "VN_fnc_revive_action_heal",
"slug": "vn-fnc-revive-action-heal",
"description": "Main player heal action function. Uses VN_fnc_revive_conversation.",
"syntax": "[healedUnit, type] call VN_fnc_revive_action_heal",
"params": [
{
"name": "healedUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[cursorObject, 3] call VN_fnc_revive_action_heal;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_heal"
]
},
"vn-fnc-revive-action-loadplayer": {
"title": "VN fnc revive action loadPlayer",
"callable": "VN_fnc_revive_action_loadPlayer",
"slug": "vn-fnc-revive-action-loadplayer",
"description": "Main player loading action function.",
"syntax": "[vehicle, type] call VN_fnc_revive_action_loadPlayer",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the vehicle that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[sogJeep, 3] call VN_fnc_revive_action_loadPlayer;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_loadPlayer"
]
},
"vn-fnc-revive-action-pickupplayer": {
"title": "VN fnc revive action pickupPlayer",
"callable": "VN_fnc_revive_action_pickupPlayer",
"slug": "vn-fnc-revive-action-pickupplayer",
"description": "Main player picking up action function. Uses VN_fnc_revive_conversation",
"syntax": "[pickedUpUnit, type] call VN_fnc_revive_action_pickupPlayer",
"params": [
{
"name": "pickedUpUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[cursorObject, 3] call VN_fnc_revive_action_pickupPlayer;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_pickupPlayer"
]
},
"vn-fnc-revive-action-respawn": {
"title": "VN fnc revive action respawn",
"callable": "VN_fnc_revive_action_respawn",
"slug": "vn-fnc-revive-action-respawn",
"description": "Main player respawn action function.",
"syntax": "[respawnedUnit, type] call VN_fnc_revive_action_respawn",
"params": [
{
"name": "respawnedUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[player, 3] call VN_fnc_revive_action_respawn;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_respawn"
]
},
"vn-fnc-revive-action-revive": {
"title": "VN fnc revive action revive",
"callable": "VN_fnc_revive_action_revive",
"slug": "vn-fnc-revive-action-revive",
"description": "Main player revive action function.",
"syntax": "[revivedUnit, type] call VN_fnc_revive_action_revive",
"params": [
{
"name": "revivedUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[cursorObject, 3] call VN_fnc_revive_action_revive;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_revive"
]
},
"vn-fnc-revive-action-roll": {
"title": "VN fnc revive action roll",
"callable": "VN_fnc_revive_action_roll",
"slug": "vn-fnc-revive-action-roll",
"description": "Player action function for roll onto back function.",
"syntax": "[rollUnit, type] call VN_fnc_revive_action_roll",
"params": [
{
"name": "rollUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "(Optional, unused - defaults to [player](https://community.bistudio.com/wiki/player)) the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[objNull, 3] call VN_fnc_revive_action_roll;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_roll"
]
},
"vn-fnc-revive-action-undragplayer": {
"title": "VN fnc revive action undragPlayer",
"callable": "VN_fnc_revive_action_undragPlayer",
"slug": "vn-fnc-revive-action-undragplayer",
"description": "Main player undragging action function.",
"syntax": "[] call VN_fnc_revive_action_undragPlayer",
"params": [
{
"name": "draggedUnit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "(Optional, unused) the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[objNull, 3] call VN_fnc_revive_action_undragPlayer;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_undragPlayer"
]
},
"vn-fnc-revive-action-unloadplayers": {
"title": "VN fnc revive action unloadPlayers",
"callable": "VN_fnc_revive_action_unloadPlayers",
"slug": "vn-fnc-revive-action-unloadplayers",
"description": "Main player unloading action function.",
"syntax": "[vehicle, type] call VN_fnc_revive_action_unloadPlayers",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the vehicle on which the action is performed",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[sogJeep, 3] call VN_fnc_revive_action_unloadPlayers;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_unloadPlayers"
]
},
"vn-fnc-revive-action-withstand": {
"title": "VN fnc revive action withstand",
"callable": "VN_fnc_revive_action_withstand",
"slug": "vn-fnc-revive-action-withstand",
"description": "Main player withstand action function.",
"syntax": "[unused, type] call VN_fnc_revive_action_withstand",
"params": [
{
"name": "unused",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "(Optional, unused - defaults to [player](https://community.bistudio.com/wiki/player)) the unit that the action is being performed on",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the type of performed action:
• 1: action started
• 2: action tick (see VN_fnc_holdActionAdd)
• 3: action completed
• 4: action interrupted",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) when done"
},
"examples": [
"[objNull, 3] call VN_fnc_revive_action_withstand;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_action_withstand"
]
},
"vn-fnc-revive-actions": {
"title": "VN fnc revive actions",
"callable": "VN_fnc_revive_actions",
"slug": "vn-fnc-revive-actions",
"description": "Master actions function, contains all the conditions for the advanded revive functions.",
"syntax": "[] call VN_fnc_revive_actions",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_revive_actions;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_actions"
]
},
"vn-fnc-revive-actions-local": {
"title": "VN fnc revive actions local",
"callable": "VN_fnc_revive_actions_local",
"slug": "vn-fnc-revive-actions-local",
"description": "Local action function for downed units and AI.",
"syntax": "[_unit,_remove,_ai] call VN_fnc_revive_actions_local;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit to add actions to.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_remove",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Do you want the actions removed from the object",
"optional": true,
"default": "FALSE"
},
{
"name": "_ai",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is this unit an AI",
"optional": true,
"default": "FALSE"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player,false,false] call vn_fnc_revive_actions_local;",
"[_ai,false,true] call vn_fnc_revive_actions_local;",
"[_dead_ai,true,true] call vn_fnc_revive_actions_local;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_actions_local"
]
},
"vn-fnc-revive-addeventhandlers": {
"title": "VN fnc revive addEventHandlers",
"callable": "VN_fnc_revive_addEventHandlers",
"slug": "vn-fnc-revive-addeventhandlers",
"description": "Master actions function, contains all the event handlers for the advanced revive functions.",
"syntax": "[] call VN_fnc_revive_addEventHandlers",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_revive_addEventHandlers"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_addEventHandlers"
]
},
"vn-fnc-revive-conversation": {
"title": "VN fnc revive conversation",
"callable": "VN_fnc_revive_conversation",
"slug": "vn-fnc-revive-conversation",
"description": "Main conversation function, remote execs dynamic audio function to clients. Uses VN_fnc_revive_dynamic_audio.",
"syntax": "[speaker, type] call VN_fnc_revive_conversation",
"params": [
{
"name": "speaker",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the object playing the audio",
"optional": false,
"default": ""
},
{
"name": "type",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "the action context to determine which audio to play. Can be one of:
• \"help\"
• \"heal\"
• \"unload_player\"
• \"drag_player\"
• \"undrag_player\"
• \"revive\"
• \"pickup_player\"
• \"drop_player\"
• \"load_player\"
• \"movement\"
• \"dragged\"
• \"carried\"
• \"healed\"
• \"general\"",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[player, \"heal\"] call VN_fnc_revive_conversation;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_conversation"
]
},
"vn-fnc-revive-coreinit": {
"title": "VN fnc revive coreinit",
"callable": "VN_fnc_revive_coreinit",
"slug": "vn-fnc-revive-coreinit",
"description": "The main advanced revive core loop.",
"syntax": "[_unit] call VN_fnc_revive_coreinit;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Description",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player] call vn_fnc_revive_coreinit"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_coreinit"
]
},
"vn-fnc-revive-detachunit": {
"title": "VN fnc revive detachunit",
"callable": "VN_fnc_revive_detachunit",
"slug": "vn-fnc-revive-detachunit",
"description": "Takes unit and detaches any attached objects which are incapicated players / ai.",
"syntax": "[_unit,_attached] call VN_fnc_revive_detachunit;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit that is the attached unit OR Unit that has others attached",
"optional": false,
"default": ""
},
{
"name": "_attached",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Use attached units from the original unit",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player, true] call vn_fnc_revive_detachunit"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_detachunit"
]
},
"vn-fnc-revive-detachunit-local": {
"title": "VN fnc revive detachunit local",
"callable": "VN_fnc_revive_detachunit_local",
"slug": "vn-fnc-revive-detachunit-local",
"description": "Client version of the detachunit function, uncons the player & fixes their animation.",
"syntax": "[_unit] call VN_fnc_revive_detachunit_local;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit which is detached from its carrier",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player] call vn_fnc_revive_detach_local;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_detachunit_local"
]
},
"vn-fnc-revive-dynamic-audio": {
"title": "VN fnc revive dynamic audio",
"callable": "VN_fnc_revive_dynamic_audio",
"slug": "vn-fnc-revive-dynamic-audio",
"description": "Play an audio file including long-distance (up to 200m from camera's position) version if required, works for normal play, Splendid™ Camera & Zeus.",
"syntax": "[speaker, soundClass, isLongDistance] call VN_fnc_revive_dynamic_audio",
"params": [
{
"name": "speaker",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "object that will [say3D](https://community.bistudio.com/wiki/say3D) *soundClass*",
"optional": false,
"default": ""
},
{
"name": "soundClass",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "audio class to `say3d` from the object",
"optional": false,
"default": ""
},
{
"name": "isLongDistance",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "if distance audio should be played. Should only use [true](https://community.bistudio.com/wiki/true) if action is \"help\" (from VN_fnc_revive_conversation)",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[driver sogJeep, \"helloThere\", false] call VN_fnc_revive_dynamic_audio;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_dynamic_audio"
]
},
"vn-fnc-revive-fix-movement": {
"title": "VN fnc revive fix movement",
"callable": "VN_fnc_revive_fix_movement",
"slug": "vn-fnc-revive-fix-movement",
"description": "Fixes the movement issues that occur with the incap animation system.",
"syntax": "[_unit] call VN_fnc_revive_fix_movement;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit to be checked",
"optional": true,
"default": "cursorObject"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[player] call vn_fnc_revive_fix_movement;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_fix_movement"
]
},
"vn-fnc-revive-handledamage": {
"title": "VN fnc revive handleDamage",
"callable": "VN_fnc_revive_handleDamage",
"slug": "vn-fnc-revive-handledamage",
"description": "Damage handler for the advanced revive. The unit is incapacitated if damage >= 0.9.",
"syntax": "[unit, unused, damage] call VN_fnc_revive_handleDamage",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit to which the eventhandler is assigned",
"optional": false,
"default": ""
},
{
"name": "unused",
"type": "",
"typeMarkdown": "",
"description": "unused argument index",
"optional": false,
"default": ""
},
{
"name": "damage",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "damage value",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Number or nil",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number) or [nil](https://community.bistudio.com/wiki/nil)",
"description": ""
},
"examples": [
"[player, nil, 0.25] call VN_fnc_revive_handleDamage;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_handleDamage"
]
},
"vn-fnc-revive-incap": {
"title": "VN fnc revive incap",
"callable": "VN_fnc_revive_incap",
"slug": "vn-fnc-revive-incap",
"description": "Checks if unit is incapacitated.",
"syntax": "[_unit] call VN_fnc_revive_incap;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit to be checked",
"optional": true,
"default": "cursorObject"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Unit is incapacitated"
},
"examples": [
"[player] call vn_fnc_revive_incap"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_incap"
]
},
"vn-fnc-revive-keydown": {
"title": "VN fnc revive keyDown",
"callable": "VN_fnc_revive_keyDown",
"slug": "vn-fnc-revive-keydown",
"description": "Key handler for the revive system. See also [KeyDown EH](https://community.bistudio.com/wiki/User_Interface_Event_Handlers#onKeyDown).",
"syntax": "[display, key, shift, ctrl, alt] call VN_fnc_revive_keyDown",
"params": [
{
"name": "display",
"type": "Display or Control",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display) or [Control](https://community.bistudio.com/wiki/Control)",
"description": "EH display or control, unused",
"optional": false,
"default": ""
},
{
"name": "key",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "pressed key",
"optional": false,
"default": ""
},
{
"name": "shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is shift key pressed",
"optional": false,
"default": ""
},
{
"name": "ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is ctrl key pressed",
"optional": false,
"default": ""
},
{
"name": "alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is alt key pressed",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) to intercept the original key function"
},
"examples": [
"[findDisplay 46, 42, false, false, false] call VN_fnc_revive_keyDown;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_keyDown"
]
},
"vn-fnc-revive-mousedown": {
"title": "VN fnc revive mouseDown",
"callable": "VN_fnc_revive_mouseDown",
"slug": "vn-fnc-revive-mousedown",
"description": "Mouse handler for the revive system. Does nothing, returns [false](https://community.bistudio.com/wiki/false).",
"syntax": "[] call VN_fnc_revive_mouseDown",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "returns [false](https://community.bistudio.com/wiki/false)"
},
"examples": [
"[] call VN_fnc_revive_mouseDown"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_mouseDown"
]
},
"vn-fnc-revive-moving": {
"title": "VN fnc revive moving",
"callable": "VN_fnc_revive_moving",
"slug": "vn-fnc-revive-moving",
"description": "Check function for checking that unit is not being moved/moving another unit.",
"syntax": "[_unit] call VN_fnc_revive_moving;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit to be checked",
"optional": true,
"default": "cursorObject"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Unit is not being moved/moving another object"
},
"examples": [
"[player] call vn_fnc_revive_moving;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_moving"
]
},
"vn-fnc-revive-setup-audio": {
"title": "VN fnc revive setup audio",
"callable": "VN_fnc_revive_setup_audio",
"slug": "vn-fnc-revive-setup-audio",
"description": "Revive audio setup function. Stores all the revive system sound classnames in a global [Array](https://community.bistudio.com/wiki/Array) named `VN_revive_audio` and stores their subtitles in [missionNamespace](https://community.bistudio.com/wiki/missionNamespace).",
"syntax": "[] call VN_fnc_revive_setup_audio",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_revive_setup_audio;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_setup_audio"
]
},
"vn-fnc-revive-terminal-animation": {
"title": "VN fnc revive terminal animation",
"callable": "VN_fnc_revive_terminal_animation",
"slug": "vn-fnc-revive-terminal-animation",
"description": "Plays revive animation for the specified unit.",
"syntax": "[_unit] call VN_fnc_revive_terminal_animation;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit to play animation on",
"optional": true,
"default": "objnull"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_terminal_animation"
]
},
"vn-fnc-revive-zeus-heal": {
"title": "VN fnc revive zeus heal",
"callable": "VN_fnc_revive_zeus_heal",
"slug": "vn-fnc-revive-zeus-heal",
"description": "Zeus healing module. Stops bleeding of the targeted unit.",
"syntax": "[logic, units, isActivated] call VN_fnc_revive_zeus_heal",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_revive_zeus_heal;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_zeus_heal"
]
},
"vn-fnc-revive-zeus-revive": {
"title": "VN fnc revive zeus revive",
"callable": "VN_fnc_revive_zeus_revive",
"slug": "vn-fnc-revive-zeus-revive",
"description": "Zeus revive module. Stops bleeding and incapacitated state of the targeted unit.",
"syntax": "[logic, units, isActivated] call VN_fnc_revive_zeus_revive",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_revive_zeus_revive;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_zeus_revive"
]
},
"vn-fnc-revive-zeus-uncon": {
"title": "VN fnc revive zeus uncon",
"callable": "VN_fnc_revive_zeus_uncon",
"slug": "vn-fnc-revive-zeus-uncon",
"description": "Zeus unconscious module, sets the targeted unit unconscious *via* VN_fnc_revive_zeus_uncon_client.",
"syntax": "[logic, units, isActivated] call VN_fnc_revive_zeus_uncon",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_revive_zeus_uncon;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_zeus_uncon"
]
},
"vn-fnc-revive-zeus-uncon-client": {
"title": "VN fnc revive zeus uncon client",
"callable": "VN_fnc_revive_zeus_uncon_client",
"slug": "vn-fnc-revive-zeus-uncon-client",
"description": "Zeus unconscious module client function. See VN_fnc_revive_zeus_uncon.",
"syntax": "[unit] call VN_fnc_revive_zeus_uncon_client",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unit which is being revived",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[player] call VN_fnc_revive_zeus_uncon_client;"
],
"groups": [
"advanced_revive_functions"
],
"groupLabels": [
"Revive"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_revive_zeus_uncon_client"
]
},
"vn-fnc-rgba100tohex": {
"title": "VN fnc rgba100toHex",
"callable": "VN_fnc_rgba100toHex",
"slug": "vn-fnc-rgba100tohex",
"description": "Converts an RGBA color to Hex",
"syntax": "[_r,_g,_b,_a] call VN_fnc_rgba100toHex;",
"params": [
{
"name": "_r",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Red value in % from 0 to 1",
"optional": false,
"default": ""
},
{
"name": "_g",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Green value in % from 0 to 1",
"optional": false,
"default": ""
},
{
"name": "_b",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Blue value in % from 0 to 1",
"optional": false,
"default": ""
},
{
"name": "_a",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Alpha value in % from 0 to 1",
"optional": false,
"default": ""
}
],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Hex color with \"#\" prefix"
},
"examples": [
"[1,1,1,1] call vn_fnc_RGBA100toHex // \"#FFFFFF\""
],
"groups": [
"mainFunctions"
],
"groupLabels": [
"Shared helpers"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_rgba100toHex"
]
},
"vn-fnc-rsna75-initdisplay": {
"title": "VN fnc rsna75 initDisplay",
"callable": "VN_fnc_rsna75_initDisplay",
"slug": "vn-fnc-rsna75-initdisplay",
"description": "This function is initialized on the RscInGameUI onLoad event for the fan song; it is used to manage any kind of UI manipulation while the player is inside the fan song, particularly interior MFD rendering.\n\nSee also VN_fnc_rsna75_updateDisplay.",
"syntax": "[] call VN_fnc_rsna75_initDisplay",
"params": [],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "[BIS_fnc_addStackedEventHandler](https://community.bistudio.com/wiki/BIS_fnc_addStackedEventHandler) event handler id"
},
"examples": [
"[] call VN_fnc_rsna75_initDisplay;"
],
"groups": [
"weapon_functions"
],
"groupLabels": [
"Weapon systems"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_rsna75_initDisplay"
]
},
"vn-fnc-rsna75-updatedisplay": {
"title": "VN fnc rsna75 updateDisplay",
"callable": "VN_fnc_rsna75_updateDisplay",
"slug": "vn-fnc-rsna75-updatedisplay",
"description": "This function usage is defined by VN_fnc_rsna75_initDisplay and is used to once per second update UI elements of the Fan Song MFDs.",
"syntax": "[] call VN_fnc_rsna75_updateDisplay",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_rsna75_updateDisplay;"
],
"groups": [
"weapon_functions"
],
"groupLabels": [
"Weapon systems"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_rsna75_updateDisplay"
]
},
"vn-fnc-sa2-fired": {
"title": "VN fnc sa2 fired",
"callable": "vn_fnc_sa2_fired",
"slug": "vn-fnc-sa2-fired",
"description": "SA2 fired eventhandler function, does not use all parameters from the fired eventhandler",
"syntax": "[\n player,\n \"weapon\",\n \"muzzle\",\n \"mode\",\n \"ammo\",\n \"magazine\",\n \"projectile\",\n gunner\n] call vn_fnc_sa2_fired",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit which the eventhandler is attached to.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_weapon",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Weapon classname of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_muzzle",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Muzzle of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_mode",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Mode of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_ammo",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Ammo of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_magazine",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Magazine of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_projectile",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Projectile of the fired weapon.",
"optional": true,
"default": "\"\""
},
{
"name": "_gunner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit that insigated the fired eventhandler.",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function reached the end"
},
"examples": [
"[player, \"weapon\", \"muzzle\", \"mode\", \"ammo\", \"magazine\", \"projectile\", gunner] call vn_fnc_sa2_fired"
],
"groups": [
"weapon_functions"
],
"groupLabels": [
"Weapon systems"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_sa2_fired"
]
},
"vn-fnc-sam-dynamic-audio": {
"title": "VN fnc sam dynamic audio",
"callable": "VN_fnc_sam_dynamic_audio",
"slug": "vn-fnc-sam-dynamic-audio",
"description": "Play situational awareness audio locally on user's client based on predefined conditions; works for normal play, Splendid Camera & Zeus.",
"syntax": "[source, soundClass] call VN_fnc_sam_dynamic_audio",
"params": [
{
"name": "source",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "soundClass",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[player, \"mySound\"] call VN_fnc_sam_dynamic_audio"
],
"groups": [
"situational_awareness_module_functions"
],
"groupLabels": [
"Audio (situational awareness)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_sam_dynamic_audio"
]
},
"vn-fnc-set-aperture-based-on-light-level": {
"title": "VN fnc set aperture based on light level",
"callable": "VN_fnc_set_aperture_based_on_light_level",
"slug": "vn-fnc-set-aperture-based-on-light-level",
"description": "Sets the player's aperture to enable night fighting on Cam Lao Nam, without the need for additional light sources.\nRun periodically to keep aperture up to date with day/night cycle.\nAperture requires reset at the end of each mission.",
"syntax": "[] call VN_fnc_set_aperture_based_on_light_level;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call vn_fnc_set_aperture_based_on_light_level;"
],
"groups": [
"vn_aperture_functions"
],
"groupLabels": [
"Camera aperture"
],
"version": "1.00",
"author": "Callum Spawforth",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_set_aperture_based_on_light_level"
]
},
"vn-fnc-setunitchestinsignia": {
"title": "VN fnc setunitchestinsignia",
"callable": "VN_fnc_setunitchestinsignia",
"slug": "vn-fnc-setunitchestinsignia",
"description": "Adds insignia to unit globablly for all clients including JIP clients.",
"syntax": "[_unit,_insignia,_hiddenselection] call VN_fnc_setunitchestinsignia;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit that will have the insignia added to them.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_insignia",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "CfgUnitInsignia classname which will be added to the unit.",
"optional": true,
"default": "\"\""
},
{
"name": "_hiddenselection",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Hidden selection name to add the texture to.",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Was insignia succesfully set."
},
"examples": [
"[player, \"bi\", \"d_pocket_l\"] call vn_fnc_setunitchestinsignia;"
],
"groups": [
"vn_insignia_functions"
],
"groupLabels": [
"Insignia"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_setunitchestinsignia"
]
},
"vn-fnc-showdebrief": {
"title": "VN fnc showDebrief",
"callable": "VN_fnc_showDebrief",
"slug": "vn-fnc-showdebrief",
"description": "Shows the Campaign Endscreen.",
"syntax": "[\n _name,\n _state,\n _task,\n _debrief,\n _note,\n _image,\n _background,\n _key\n] call VN_fnc_showDebrief;",
"params": [
{
"name": "_name",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Mission name",
"optional": true,
"default": " (command)"
},
{
"name": "_state",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Mission state (success, failure, ...)",
"optional": true,
"default": "\"\" (empty string)"
},
{
"name": "_task",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Task, will be parsed as a strucutredText",
"optional": true,
"default": "\"\" (empty string)"
},
{
"name": "_debrief",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Debriefing, will be parsed as a strucutredText",
"optional": true,
"default": "\"\" (empty string)"
},
{
"name": "_note",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Sticky note, will be parsed as a strucutredText",
"optional": true,
"default": "\"\" (empty string)"
},
{
"name": "_image",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Main image",
"optional": true,
"default": "\"\" (empty string)"
},
{
"name": "_background",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Background image",
"optional": true,
"default": "\"\" (empty string)"
},
{
"name": "_key",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "key to press",
"optional": true,
"default": "\"\" (empty string)"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[\n\"Eldest Son\",\n\"Success\",\nlocalize \"STR_VN_DEBRIEFING_CO01_OVERVIEW\",\nlocalize \"STR_VN_DEBRIEFING_CO01_FAILOBJECTIVE\",\nlocalize \"STR_VN_DEBRIEFING_CO01_NOTES\",\n\"\\vn\\missions_f_vietnam\\data\\img\\m01\\debrief_fail.jpg\",\n\"\\vn\\missions_f_vietnam\\data\\img\\m01\\debrief_fail.jpg\",\n\"Space\"\n] call VN_fnc_showDebrief"
],
"groups": [
"debriefing"
],
"groupLabels": [
"Debriefing"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_showDebrief"
]
},
"vn-fnc-showmultipleoptionsmodal": {
"title": "VN fnc showMultipleOptionsModal",
"callable": "VN_fnc_showMultipleOptionsModal",
"slug": "vn-fnc-showmultipleoptionsmodal",
"description": "Opens up a modal dialog that allows for single or multiple choices.",
"syntax": "[title, options, onExit, singleChoice] call VN_fnc_showMultipleOptionsModal",
"params": [
{
"name": "title",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "title of the vote",
"optional": false,
"default": ""
},
{
"name": "options",
"type": "Array of String",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [String](https://community.bistudio.com/wiki/String)",
"description": "options items are in format [title, action, arguments]:
• title: [String](https://community.bistudio.com/wiki/String)
• action: [Code](https://community.bistudio.com/wiki/Code)
• arguments: [Array](https://community.bistudio.com/wiki/Array)",
"optional": false,
"default": ""
},
{
"name": "onExit",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "function called when a player exits the modal, a nested array is passed to the function. Nested array is as follow: [_this: See [OnUnload EH](https://community.bistudio.com/wiki/User_Interface_Event_Handlers#onUnload), _selected: Array of selected option indexes]",
"optional": false,
"default": ""
},
{
"name": "singleChoice",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "if set to [true](https://community.bistudio.com/wiki/true), options act like a radio button (only one option can be selected); [false](https://community.bistudio.com/wiki/false) allows to select multiple options.",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[true](https://community.bistudio.com/wiki/true) if the dialog was successfully created. Empty title or no options will return [false](https://community.bistudio.com/wiki/false)"
},
"examples": [
"[\n\t\"Do you like pineapple on pizza?\",\n\t[\n\t\t[\"Yes\", { systemChat str _this; }, []],\n\t\t[\"No\", { systemChat str _this; }, []],\n\t\t[\"No, but I never tried\", { systemChat str _this; }, []],\n\t\t[\"Yes, but I never tried\", { systemChat str _this; }, []],\n\t\t[\"I am neutral\", { systemChat str _this; }, []]\n\t],\n\t{ systemChat str _this; },\n\ttrue\n] call VN_fnc_showMultipleOptionsModal;"
],
"groups": [
"multipleOptionsModal"
],
"groupLabels": [
"Options dialog"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_showMultipleOptionsModal"
]
},
"vn-fnc-showsubtitle": {
"title": "VN fnc showSubtitle",
"callable": "VN_fnc_showSubtitle",
"slug": "vn-fnc-showsubtitle",
"description": "Displays a subtitle at the bottom of the screen. See [BIS_fnc_showSubtitle](https://community.bistudio.com/wiki/BIS_fnc_showSubtitle).",
"syntax": "[from, text, useTitleRsc, useCamPos] call VN_fnc_showSubtitle",
"params": [
{
"name": "from",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "speaker's display name",
"optional": true,
"default": "\"\""
},
{
"name": "text",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "subtitle content",
"optional": true,
"default": "\"\""
},
{
"name": "useTitleRsc",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "forces [titleRsc](https://community.bistudio.com/wiki/titleRsc) usage for subtitles",
"optional": true,
"default": "false"
},
{
"name": "useCamPos",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "forces the text to the bottom of the [SafeZone](https://community.bistudio.com/wiki/SafeZone)",
"optional": true,
"default": "false"
}
],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": "script controlling the displayed subtitle"
},
"examples": [
"[name player, \"Wow, it's so warm here!\"] call VN_fnc_showSubtitle;"
],
"groups": [
"vn_subtitle_functions"
],
"groupLabels": [
"Subtitles"
],
"version": "1.00",
"author": "Ethan Johnson, from BIS_fnc_showSubtitle",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_showSubtitle"
]
},
"vn-fnc-switchableturrets-canswitch": {
"title": "VN fnc switchableTurrets canSwitch",
"callable": "VN_fnc_switchableTurrets_canSwitch",
"slug": "vn-fnc-switchableturrets-canswitch",
"description": "Check if unit can switch/is in specified turret class.",
"syntax": "[] call VN_fnc_switchableTurrets_canSwitch;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Can switch"
},
"examples": [
"[call vn_fnc_player, 'mg3_turret'] call vn_fnc_switchableTurrets_canSwitch;"
],
"groups": [
"vn_switchableTurrets_functions"
],
"groupLabels": [
"Switchable turrets"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_switchableTurrets_canSwitch"
]
},
"vn-fnc-switchableturrets-classtoturretpath": {
"title": "VN fnc switchableTurrets classToTurretPath",
"callable": "VN_fnc_switchableTurrets_classToTurretPath",
"slug": "vn-fnc-switchableturrets-classtoturretpath",
"description": "Get turret path of given turret class name. Case sensitive!",
"syntax": "[] call VN_fnc_switchableTurrets_classToTurretPath;",
"params": [],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Turret path"
},
"examples": [
"[vehicle player, \"mg4_turret\"] call VN_fnc_switchableTurrets_classToTurretPath;"
],
"groups": [
"vn_switchableTurrets_functions"
],
"groupLabels": [
"Switchable turrets"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_switchableTurrets_classToTurretPath"
]
},
"vn-fnc-switchableturrets-crewchanged": {
"title": "VN fnc switchableTurrets crewChanged",
"callable": "VN_fnc_switchableTurrets_crewChanged",
"slug": "vn-fnc-switchableturrets-crewchanged",
"description": "Detect crew changes in vehicle with switchable turrets.",
"syntax": "[_vehicle] call VN_fnc_switchableTurrets_crewChanged;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle with crew changes",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_switchableTurrets_functions"
],
"groupLabels": [
"Switchable turrets"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_switchableTurrets_crewChanged"
]
},
"vn-fnc-switchableturrets-init": {
"title": "VN fnc switchableTurrets init",
"callable": "VN_fnc_switchableTurrets_init",
"slug": "vn-fnc-switchableturrets-init",
"description": "Initialize vehicle switchable turrets.",
"syntax": "[_vehicle] call VN_fnc_switchableTurrets_init;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle to update",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Vehicle was initialized"
},
"examples": [],
"groups": [
"vn_switchableTurrets_functions"
],
"groupLabels": [
"Switchable turrets"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_switchableTurrets_init"
]
},
"vn-fnc-switchableturrets-lock": {
"title": "VN fnc switchableTurrets lock",
"callable": "VN_fnc_switchableTurrets_lock",
"slug": "vn-fnc-switchableturrets-lock",
"description": "Lock vehicle turret.",
"syntax": "[_vehicle, _turretPath, _state] call VN_fnc_switchableTurrets_lock;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle with the turret to lock",
"optional": false,
"default": ""
},
{
"name": "_turretPath",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Path of the turret to lock",
"optional": false,
"default": ""
},
{
"name": "_state",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Target state of the lock",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_switchableTurrets_functions"
],
"groupLabels": [
"Switchable turrets"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_switchableTurrets_lock"
]
},
"vn-fnc-switchableturrets-switch": {
"title": "VN fnc switchableTurrets switch",
"callable": "VN_fnc_switchableTurrets_switch",
"slug": "vn-fnc-switchableturrets-switch",
"description": "Switch turret user action.",
"syntax": "[] call VN_fnc_switchableTurrets_switch;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"vn_switchableTurrets_functions"
],
"groupLabels": [
"Switchable turrets"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_switchableTurrets_switch"
]
},
"vn-fnc-switchableturrets-turretpathtoconfig": {
"title": "VN fnc switchableTurrets turretPathToConfig",
"callable": "VN_fnc_switchableTurrets_turretPathToConfig",
"slug": "vn-fnc-switchableturrets-turretpathtoconfig",
"description": "Get Turret config for given turret path.",
"syntax": "[_vehicle,_turretPath] call VN_fnc_switchableTurrets_turretPathToConfig;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": true,
"default": "objNull"
},
{
"name": "_turretPath",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Config",
"typeMarkdown": "[Config](https://community.bistudio.com/wiki/Config)",
"description": "Config for given turret path"
},
"examples": [
"[vehicle player, [0,1]] call VN_fnc_switchableTurrets_turretPathToConfig"
],
"groups": [
"vn_switchableTurrets_functions"
],
"groupLabels": [
"Switchable turrets"
],
"version": "1.10",
"author": "veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_switchableTurrets_turretPathToConfig"
]
},
"vn-fnc-t102e-onload": {
"title": "VN fnc T102E onLoad",
"callable": "VN_fnc_T102E_onLoad",
"slug": "vn-fnc-t102e-onload",
"description": "Handles UI Loading.",
"syntax": "[_display] call VN_fnc_T102E_onLoad;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "UI Display",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_onLoad"
]
},
"vn-fnc-t102e-onupdate": {
"title": "VN fnc T102E onUpdate",
"callable": "VN_fnc_T102E_onUpdate",
"slug": "vn-fnc-t102e-onupdate",
"description": "Handles UI Updates.",
"syntax": "[] call VN_fnc_T102E_onUpdate;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_onUpdate"
]
},
"vn-fnc-t102e-setadditional": {
"title": "VN fnc T102E setAdditional",
"callable": "VN_fnc_T102E_setAdditional",
"slug": "vn-fnc-t102e-setadditional",
"description": "Sets additional frequency.",
"syntax": "[] call VN_fnc_T102E_setAdditional;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setAdditional"
]
},
"vn-fnc-t102e-setaudio": {
"title": "VN fnc T102E setAudio",
"callable": "VN_fnc_T102E_setAudio",
"slug": "vn-fnc-t102e-setaudio",
"description": "Sets audio speakers.",
"syntax": "[] call VN_fnc_T102E_setAudio;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setAudio"
]
},
"vn-fnc-t102e-setchannel": {
"title": "VN fnc T102E setChannel",
"callable": "VN_fnc_T102E_setChannel",
"slug": "vn-fnc-t102e-setchannel",
"description": "Sets channel. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T102E_setChannel;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setChannel"
]
},
"vn-fnc-t102e-setfrequency": {
"title": "VN fnc T102E setFrequency",
"callable": "VN_fnc_T102E_setFrequency",
"slug": "vn-fnc-t102e-setfrequency",
"description": "Sets the frequency",
"syntax": "[] call VN_fnc_T102E_setFrequency;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setFrequency"
]
},
"vn-fnc-t102e-setkhz": {
"title": "VN fnc T102E setKHz",
"callable": "VN_fnc_T102E_setKHz",
"slug": "vn-fnc-t102e-setkhz",
"description": "Sets KHzs. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T102E_setKHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setKHz"
]
},
"vn-fnc-t102e-setmhz": {
"title": "VN fnc T102E setMHz",
"callable": "VN_fnc_T102E_setMHz",
"slug": "vn-fnc-t102e-setmhz",
"description": "Sets MHzs. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T102E_setMHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setMHz"
]
},
"vn-fnc-t102e-setstereo": {
"title": "VN fnc T102E setStereo",
"callable": "VN_fnc_T102E_setStereo",
"slug": "vn-fnc-t102e-setstereo",
"description": "Sets stereo.",
"syntax": "[] call VN_fnc_T102E_setStereo;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setStereo"
]
},
"vn-fnc-t102e-setvolume": {
"title": "VN fnc T102E setVolume",
"callable": "VN_fnc_T102E_setVolume",
"slug": "vn-fnc-t102e-setvolume",
"description": "Sets volume. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T102E_setVolume;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T102E_setVolume"
]
},
"vn-fnc-t884-onload": {
"title": "VN fnc T884 onLoad",
"callable": "VN_fnc_T884_onLoad",
"slug": "vn-fnc-t884-onload",
"description": "Handles UI Loading.",
"syntax": "[] call VN_fnc_T884_onLoad;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "UI Display",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_onLoad"
]
},
"vn-fnc-t884-onupdate": {
"title": "VN fnc T884 onUpdate",
"callable": "VN_fnc_T884_onUpdate",
"slug": "vn-fnc-t884-onupdate",
"description": "Handles UI Updates.",
"syntax": "[] call VN_fnc_T884_onUpdate;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_onUpdate"
]
},
"vn-fnc-t884-setadditional": {
"title": "VN fnc T884 setAdditional",
"callable": "VN_fnc_T884_setAdditional",
"slug": "vn-fnc-t884-setadditional",
"description": "Sets additional frequency.",
"syntax": "[] call VN_fnc_T884_setAdditional;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setAdditional"
]
},
"vn-fnc-t884-setaudio": {
"title": "VN fnc T884 setAudio",
"callable": "VN_fnc_T884_setAudio",
"slug": "vn-fnc-t884-setaudio",
"description": "Sets audio speakers.",
"syntax": "[] call VN_fnc_T884_setAudio;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setAudio"
]
},
"vn-fnc-t884-setchannel": {
"title": "VN fnc T884 setChannel",
"callable": "VN_fnc_T884_setChannel",
"slug": "vn-fnc-t884-setchannel",
"description": "Sets the channel. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T884_setChannel;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setChannel"
]
},
"vn-fnc-t884-setfrequency": {
"title": "VN fnc T884 setFrequency",
"callable": "VN_fnc_T884_setFrequency",
"slug": "vn-fnc-t884-setfrequency",
"description": "Sets channel. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T884_setFrequency;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setFrequency"
]
},
"vn-fnc-t884-setkhz": {
"title": "VN fnc T884 setKHz",
"callable": "VN_fnc_T884_setKHz",
"slug": "vn-fnc-t884-setkhz",
"description": "Sets KHzs. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T884_setKHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setKHz"
]
},
"vn-fnc-t884-setmhz": {
"title": "VN fnc T884 setMHz",
"callable": "VN_fnc_T884_setMHz",
"slug": "vn-fnc-t884-setmhz",
"description": "Sets MHzs. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T884_setMHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setMHz"
]
},
"vn-fnc-t884-setstereo": {
"title": "VN fnc T884 setStereo",
"callable": "VN_fnc_T884_setStereo",
"slug": "vn-fnc-t884-setstereo",
"description": "Sets stereo.",
"syntax": "[] call VN_fnc_T884_setStereo;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setStereo"
]
},
"vn-fnc-t884-setvolume": {
"title": "VN fnc T884 setVolume",
"callable": "VN_fnc_T884_setVolume",
"slug": "vn-fnc-t884-setvolume",
"description": "Sets volume of T884. Parameter are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_T884_setVolume;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"([_this#0,0,0,0] + (uiNamespace getVariable ['@VN_RadioDialog_T884_State', [false,false,false]])) call VN_fnc_T884_setVolume"
],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_T884_setVolume"
]
},
"vn-fnc-tfar-isoldversion": {
"title": "VN fnc TFAR isOldVersion",
"callable": "VN_fnc_TFAR_isOldVersion",
"slug": "vn-fnc-tfar-isoldversion",
"description": "Checks if user is using an old version of TFAR",
"syntax": "[] call VN_fnc_TFAR_isOldVersion;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is an old version of TFAR"
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_TFAR_isOldVersion"
]
},
"vn-fnc-tow-sparemagupdate": {
"title": "VN fnc tow spareMagUpdate",
"callable": "VN_fnc_tow_spareMagUpdate",
"slug": "vn-fnc-tow-sparemagupdate",
"description": "Hide spare TOW magazines.",
"syntax": "[_vehicle] call VN_fnc_tow_spareMagUpdate;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle to update",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[truck] call vn_fnc_tow_spareMagUpdate"
],
"groups": [
"weapon_functions"
],
"groupLabels": [
"Weapon systems"
],
"version": "1.10",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_tow_spareMagUpdate"
]
},
"vn-fnc-traps-flare-tripwire": {
"title": "VN fnc traps flare tripwire",
"callable": "VN_fnc_traps_flare_tripwire",
"slug": "vn-fnc-traps-flare-tripwire",
"description": "Animates flare trip wire trap after it is set off.",
"syntax": "[_object,_owner,,_position] call VN_fnc_traps_flare_tripwire;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Trap object",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_owner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit who placed trap",
"optional": true,
"default": "OBJNULL"
},
{
"name": "UNKNOWN",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Mine position",
"optional": true,
"default": "[0,0,0]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"AmmoHit = \"_this call vn_fnc_traps_flare_tripwire;\";"
],
"groups": [
"vn_traps_functions"
],
"groupLabels": [
"Traps"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_traps_flare_tripwire"
]
},
"vn-fnc-traps-punji": {
"title": "VN fnc traps punji",
"callable": "VN_fnc_traps_punji",
"slug": "vn-fnc-traps-punji",
"description": "Animates punji trap after it is set off.",
"syntax": "[_object,_owner,,_position] call VN_fnc_traps_punji;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Trap object",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_owner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit who placed trap",
"optional": true,
"default": "OBJNULL"
},
{
"name": "UNKNOWN",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Mine position",
"optional": true,
"default": "[0,0,0]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"AmmoHit = \"_this call vn_fnc_traps_punji;\";"
],
"groups": [
"vn_traps_functions"
],
"groupLabels": [
"Traps"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_traps_punji"
]
},
"vn-fnc-traps-punji-tripwire": {
"title": "VN fnc traps punji tripwire",
"callable": "VN_fnc_traps_punji_tripwire",
"slug": "vn-fnc-traps-punji-tripwire",
"description": "Animates punji trip wire trap after it is set off.",
"syntax": "[_object,_owner,,_position] call VN_fnc_traps_punji_tripwire;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Trap object",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_owner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit who placed trap",
"optional": true,
"default": "OBJNULL"
},
{
"name": "UNKNOWN",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Mine position",
"optional": true,
"default": "[0,0,0]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"AmmoHit = \"_this call vn_fnc_traps_punji_tripwire;\";"
],
"groups": [
"vn_traps_functions"
],
"groupLabels": [
"Traps"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_traps_punji_tripwire"
]
},
"vn-fnc-tunnel-aperture": {
"title": "VN fnc tunnel aperture",
"callable": "VN_fnc_tunnel_aperture",
"slug": "vn-fnc-tunnel-aperture",
"description": "Sets the aperture of the users view camera which makes tunnels darker in the day without affecting other users/ the world.",
"syntax": "[] call VN_fnc_tunnel_aperture;",
"params": [
{
"name": "_value",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Value of the terrain brightness, used to determien how dark to make the aperture.",
"optional": true,
"default": "-1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[-1] call vn_fnc_tunnel_aperture;"
],
"groups": [
"tunnel_functions"
],
"groupLabels": [
"Tunnels"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_tunnel_aperture"
]
},
"vn-fnc-tunnel-exit": {
"title": "VN fnc tunnel exit",
"callable": "VN_fnc_tunnel_exit",
"slug": "vn-fnc-tunnel-exit",
"description": "Exits the player from the tunnel, if the player entered then they will be placed on their old position, if not then they will be teleported to the tunnel entrance object.",
"syntax": "[_tunnel,_caller] call VN_fnc_tunnel_exit;",
"params": [
{
"name": "_tunnel",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Tunnel object which will be used to get the entry object.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_caller",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit which is calling the action which will be teleported.",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[tunnel, player] call vn_fnc_tunnel_exit;"
],
"groups": [
"tunnel_functions"
],
"groupLabels": [
"Tunnels"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_tunnel_exit"
]
},
"vn-fnc-tunnel-init-actions": {
"title": "VN fnc tunnel init actions",
"callable": "VN_fnc_tunnel_init_actions",
"slug": "vn-fnc-tunnel-init-actions",
"description": "Client side actions function, includes action.",
"syntax": "[_tunnel_trapdoor] call VN_fnc_tunnel_init_actions;",
"params": [
{
"name": "_tunnel_trapdoor",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Entry object",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[trapdoor_01,trapdoor_02] call vn_fnc_init_actions;"
],
"groups": [
"tunnel_functions"
],
"groupLabels": [
"Tunnels"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_tunnel_init_actions"
]
},
"vn-fnc-tunnel-spawn-trap": {
"title": "VN fnc tunnel spawn trap",
"callable": "VN_fnc_tunnel_spawn_trap",
"slug": "vn-fnc-tunnel-spawn-trap",
"description": "Spawns a trap and explodes it to kill the player and anyone around them.",
"syntax": "[_object] call VN_fnc_tunnel_spawn_trap;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object which will be used as the position to spawn the explosive at",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[tunnel] call vn_fnc_tunnel_spawn_trap;"
],
"groups": [
"tunnel_functions"
],
"groupLabels": [
"Tunnels"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_tunnel_spawn_trap"
]
},
"vn-fnc-tunnel-spawn-units": {
"title": "VN fnc tunnel spawn units",
"callable": "VN_fnc_tunnel_spawn_units",
"slug": "vn-fnc-tunnel-spawn-units",
"description": "Spawns units in a single group in the groupt of tunnels provided to the function.",
"syntax": "[_tunnels,_side,_count,_classnames] call VN_fnc_tunnel_spawn_units;",
"params": [
{
"name": "_tunnels",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of tunnel objects",
"optional": true,
"default": "[]"
},
{
"name": "_side",
"type": "Side",
"typeMarkdown": "[Side](https://community.bistudio.com/wiki/Side)",
"description": "Side to spawn units in",
"optional": true,
"default": "EAST"
},
{
"name": "_count",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Number of units to spawn",
"optional": true,
"default": "16"
},
{
"name": "_classnames",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Number of units to spawn",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "Group created by the function"
},
"examples": [
"[_tunnels, [west,east,independent] select _garrison_side, _size, _classnames] call vn_fnc_tunnel_spawn_units;"
],
"groups": [
"tunnel_functions"
],
"groupLabels": [
"Tunnels"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_tunnel_spawn_units"
]
},
"vn-fnc-tunnel-trigger": {
"title": "VN fnc tunnel trigger",
"callable": "VN_fnc_tunnel_trigger",
"slug": "vn-fnc-tunnel-trigger",
"description": "No description added yet.",
"syntax": "[_position] call VN_fnc_tunnel_trigger;",
"params": [
{
"name": "_position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Position which will be used as the position for the trigger.",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"0,0,0 call vn_fnc_tunnel_trigger"
],
"groups": [
"tunnel_functions"
],
"groupLabels": [
"Tunnels"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_tunnel_trigger"
]
},
"vn-fnc-ui-checkfontsize": {
"title": "VN fnc UI checkFontSize",
"callable": "VN_fnc_UI_checkFontSize",
"slug": "vn-fnc-ui-checkfontsize",
"description": "- decreasing fontsize (sizeEx) for 1-line TextCtrls, to fit in the width of the given ctrl.\n- updates the ctrl at the end automaticaly (minimum: 0.02)",
"syntax": "[_ctrl,_text,_fontSize,_font] call VN_fnc_UI_checkFontSize;",
"params": [
{
"name": "_ctrl",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Control",
"optional": false,
"default": ""
},
{
"name": "_text",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Text",
"optional": false,
"default": ""
},
{
"name": "_fontSize",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "sizeEx to start with",
"optional": true,
"default": "0.12"
},
{
"name": "_font",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Font to use",
"optional": true,
"default": "USEDFONT"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"- [_RscTextCtrl, \"I am a long text wich probably doesn't fit in a tiny control\"] call vn_fnc_checkFontSize;\n- [_RscTextCtrl, \"I am a long text wich probably doesn't fit in a tiny control\", 0.5, \"RobotoCondensed\"] call vn_fnc_checkFontSize;"
],
"groups": [
"mainFunctions"
],
"groupLabels": [
"Shared helpers"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_UI_checkFontSize"
]
},
"vn-fnc-ui-oscar-hide": {
"title": "VN fnc ui oscar hide",
"callable": "VN_fnc_ui_oscar_hide",
"slug": "vn-fnc-ui-oscar-hide",
"description": "Hides plaque.",
"syntax": "[_removeBlack] call VN_fnc_ui_oscar_hide;",
"params": [
{
"name": "_removeBlack",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Remove background?",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] spawn vn_fnc_ui_oscar_hide;"
],
"groups": [
"oscar"
],
"groupLabels": [
"Plaque overlay"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_ui_oscar_hide"
]
},
"vn-fnc-ui-oscar-settext": {
"title": "VN fnc ui oscar setText",
"callable": "VN_fnc_ui_oscar_setText",
"slug": "vn-fnc-ui-oscar-settext",
"description": "Set the plaque's text",
"syntax": "[_control] call VN_fnc_ui_oscar_setText;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Structured Text Control",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"oscar"
],
"groupLabels": [
"Plaque overlay"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_ui_oscar_setText"
]
},
"vn-fnc-ui-oscar-show": {
"title": "VN fnc ui oscar show",
"callable": "VN_fnc_ui_oscar_show",
"slug": "vn-fnc-ui-oscar-show",
"description": "Shows plaque.",
"syntax": "[] call VN_fnc_ui_oscar_show;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] spawn vn_fnc_ui_oscar_show;"
],
"groups": [
"oscar"
],
"groupLabels": [
"Plaque overlay"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_ui_oscar_show"
]
},
"vn-fnc-ui-showmemoralslides": {
"title": "VN fnc ui showMemoralSlides",
"callable": "VN_fnc_ui_showMemoralSlides",
"slug": "vn-fnc-ui-showmemoralslides",
"description": "Shows the memorial slides.",
"syntax": "[\n _blackFade,\n _imageFade,\n _imageTime,\n _delayAfterBlack,\n _delayAfterImage,\n _delayAfterImageLast,\n _images,\n _callback\n] call VN_fnc_ui_showMemoralSlides;",
"params": [
{
"name": "_blackFade",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Dialog fade in time",
"optional": true,
"default": "1"
},
{
"name": "_imageFade",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Image fade in time",
"optional": true,
"default": "1"
},
{
"name": "_imageTime",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Image on screen duration (totally faded-in)",
"optional": true,
"default": "10"
},
{
"name": "_delayAfterBlack",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Delay after black fade in to start showing the images",
"optional": true,
"default": "1"
},
{
"name": "_delayAfterImage",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Delay after image fade out to show another image",
"optional": true,
"default": "1"
},
{
"name": "_delayAfterImageLast",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Delay after the last image to fade out the dialog",
"optional": true,
"default": "1"
},
{
"name": "_images",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of string pointing to images",
"optional": true,
"default": "[]"
},
{
"name": "_callback",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "Function called when the script is done, no parameters passed",
"optional": true,
"default": "{}"
}
],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": "ScriptHandle"
},
"examples": [
"Example(s):\n[\n 1,\n 1,\n 5,\n 1,\n 1,\n 1,\n [\"\\a3\\data_f_argo\\Images\\argo_contentBrowserPicture_co.paa\", \"\\a3\\data_f_argo\\Images\\AssetMaldenTerrain_co.paa\"],\n { systemChat \"End\"; }\n] spawn vn_fnc_ui_showMemoralSlides"
],
"groups": [
"memorialSlides"
],
"groupLabels": [
"Memorial slides"
],
"version": "1.10",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_ui_showMemoralSlides"
]
},
"vn-fnc-ui-updateimg": {
"title": "VN fnc UI UpdateImg",
"callable": "VN_fnc_UI_UpdateImg",
"slug": "vn-fnc-ui-updateimg",
"description": "Exchange the image of a control, if the Cursor enters or leaves the Area.\nImage paths are stored in the control itself (\"text\" & \"textUp\").\nScript will search the Mission AND Addon files for the control data.",
"syntax": "[_mode,_ctrl] call VN_fnc_UI_UpdateImg;",
"params": [
{
"name": "_mode",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "0 = normale Texture| 1 = alternative Texture",
"optional": true,
"default": "0"
},
{
"name": "_ctrl",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "Control to change the image",
"optional": true,
"default": "controlNull"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"mainFunctions"
],
"groupLabels": [
"Shared helpers"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_UI_UpdateImg"
]
},
"vn-fnc-urc10-onload": {
"title": "VN fnc URC10 onLoad",
"callable": "VN_fnc_URC10_onLoad",
"slug": "vn-fnc-urc10-onload",
"description": "Handles URC10 load.",
"syntax": "[] call VN_fnc_URC10_onLoad;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "Display from the onLoad UIEH",
"optional": true,
"default": "NIL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"onLoad = _this call vn_fnc_URC10_onLoad; // Used in config"
],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Terra",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_URC10_onLoad"
]
},
"vn-fnc-vehicle-boat-horn-reload": {
"title": "VN fnc vehicle boat horn reload",
"callable": "VN_fnc_vehicle_boat_horn_reload",
"slug": "vn-fnc-vehicle-boat-horn-reload",
"description": "\"Restocks\" the \"ammo\" for the \"horn\"-weapon back to 2. triggered via Eventhandler [\"fired\"]",
"syntax": "[] call VN_fnc_vehicle_boat_horn_reload;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [],
"groups": [
"vn_vehicles_functions"
],
"groupLabels": [
"Vehicle equipment"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vehicle_boat_horn_reload"
]
},
"vn-fnc-vehicle-emergency-flare": {
"title": "VN fnc vehicle emergency flare",
"callable": "VN_fnc_vehicle_emergency_flare",
"slug": "vn-fnc-vehicle-emergency-flare",
"description": "Fire emergency flare into the air from a vehicle.",
"syntax": "[_vehicle,_flare_offset,_flare_ammo] call VN_fnc_vehicle_emergency_flare;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle that fired the flare.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_flare_offset",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Flare offset position.",
"optional": true,
"default": "[0,0,3]"
},
{
"name": "_flare_ammo",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Flare ammo class.",
"optional": true,
"default": "\"vn_m127_rocket_ammo\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[vehicle player] call vn_fnc_vehicle_emergency_flare;"
],
"groups": [
"vn_vehicles_functions"
],
"groupLabels": [
"Vehicle equipment"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vehicle_emergency_flare"
]
},
"vn-fnc-vehicle-spareammoupdate": {
"title": "VN fnc vehicle spareAmmoUpdate",
"callable": "VN_fnc_vehicle_spareAmmoUpdate",
"slug": "vn-fnc-vehicle-spareammoupdate",
"description": "Hide spare ammunition stored on a vehicle as rounds are fired.",
"syntax": "[\n _vehicle,\n _magMaxCount,\n _magHideAnimSource,\n _magClass\n] call VN_fnc_vehicle_spareAmmoUpdate;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle to update",
"optional": true,
"default": "objNull"
},
{
"name": "_magMaxCount",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Full ammunition count in the magazine",
"optional": true,
"default": "0"
},
{
"name": "_magHideAnimSource",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "animationSource used for hiding the spare ammunition",
"optional": true,
"default": "\"\""
},
{
"name": "_magClass",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Magazine class",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[truck, 12, \"mag_he_hide\", \"vn_type56_v_12_he_mag\"] call fn_veh_spareAmmoUpdate;"
],
"groups": [
"vn_vehicles_functions"
],
"groupLabels": [
"Vehicle equipment"
],
"version": "1.10",
"author": "veteran29, Apollo",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vehicle_spareAmmoUpdate"
]
},
"vn-fnc-vehicle-tail-number": {
"title": "VN fnc vehicle tail number",
"callable": "VN_fnc_vehicle_tail_number",
"slug": "vn-fnc-vehicle-tail-number",
"description": "Adds random tail numbers to object and selections.",
"syntax": "[\n _object,\n _selections,\n _force,\n _template,\n _location\n] call VN_fnc_vehicle_tail_number;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object to apply texture to.",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_selections",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of selections to apply textures to.",
"optional": true,
"default": "[]"
},
{
"name": "_force",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Force add textures even if the original texture is not set.",
"optional": true,
"default": "FALSE"
},
{
"name": "_template",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "String of characters/template characters to apply to the selections array, A-Z 0-9 will be used exactly, $ will be a random number.",
"optional": true,
"default": "\"\""
},
{
"name": "_location",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "String of file location to look for images.",
"optional": true,
"default": "\"vn\\air_f_vietnam\\ch34\\decals\\yellow\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[heli_01, [\"a\",\"b\",\"c\",\"d\"],\"$$$$\"] call vn_fnc_vehicle_tail_number;"
],
"groups": [
"vn_vehicles_functions"
],
"groupLabels": [
"Vehicle equipment"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vehicle_tail_number"
]
},
"vn-fnc-versioninghudtoggle": {
"title": "VN fnc versioningHudToggle",
"callable": "VN_fnc_versioningHudToggle",
"slug": "vn-fnc-versioninghudtoggle",
"description": "Toggles the ingame revision overlay.",
"syntax": "[display] call VN_fnc_versioningHudToggle",
"params": [
{
"name": "display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "display on which to create the overlay enable/disable button.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "true"
},
"examples": [
"[sogDisplay] call VN_fnc_versioningHudToggle;"
],
"groups": [
"GUI"
],
"groupLabels": [
"GUI"
],
"version": "1.00",
"author": "Pieter 'Stickie' De Stickere",
"argumentsLocality": "local",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_versioningHudToggle"
]
},
"vn-fnc-vn-ah1g-canopy": {
"title": "VN fnc vn ah1g canopy",
"callable": "VN_fnc_vn_ah1g_canopy",
"slug": "vn-fnc-vn-ah1g-canopy",
"description": "Closes AH1G canopy doors",
"syntax": "[heli] call VN_fnc_vn_ah1g_canopy;",
"params": [
{
"name": "_heli",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Helicopter object",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[heli] call vn_fnc_vn_ah1g_canopy"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_ah1g_canopy"
]
},
"vn-fnc-vn-ch34-engineeh": {
"title": "VN fnc vn ch34 engineEH",
"callable": "VN_fnc_vn_ch34_engineEH",
"slug": "vn-fnc-vn-ch34-engineeh",
"description": "Disable CH-34 engine if the rotors are folded.",
"syntax": "[vehicle, isEngineOn] call VN_fnc_vn_ch34_engineEH",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the CH-34",
"optional": false,
"default": ""
},
{
"name": "isEngineOn",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "[isEngineOn](https://community.bistudio.com/wiki/isEngineOn) value",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[sogCH34, isEngineOn sogCH34] call VN_fnc_vn_ch34_engineEH; // if the engine is on and the helicopter is packed, turns the engine off"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_ch34_engineEH"
]
},
"vn-fnc-vn-close-doors-on-exit": {
"title": "VN fnc vn close doors on exit",
"callable": "VN_fnc_vn_close_doors_on_exit",
"slug": "vn-fnc-vn-close-doors-on-exit",
"description": "When a player leaves the vehicle, close the relevant doors if they're open.\nFixes a bug whereby `moveOut` before a door animation has completed leaves the door open.",
"syntax": "[_vehicle,_role,_unit,_turretPath] call VN_fnc_vn_close_doors_on_exit;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle that has doors",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_role",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Role of the unit that exited the vehicle",
"optional": true,
"default": "\"\""
},
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Unit the called the eventhandler",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_turretPath",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Role of the unit that exited the vehicle",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[_vehicle,_role,_unit,_turretPath] call VN_fnc_vn_close_doors_on_exit"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_close_doors_on_exit"
]
},
"vn-fnc-vn-eject-crewmember": {
"title": "VN fnc vn eject crewmember",
"callable": "VN_fnc_vn_eject_crewmember",
"slug": "vn-fnc-vn-eject-crewmember",
"description": "Ejects a single crewmember as part of the vn_ejection_2 script.",
"syntax": "[] call VN_fnc_vn_eject_crewmember;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_vn_eject_crewmember;"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Bravo Zero One development, John_Spartan",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_eject_crewmember"
]
},
"vn-fnc-vn-ejection-2": {
"title": "VN fnc vn ejection 2",
"callable": "VN_fnc_vn_ejection_2",
"slug": "vn-fnc-vn-ejection-2",
"description": "Adjusted [BIS_fnc_planeEjection](https://community.bistudio.com/wiki/BIS_fnc_planeEjection) for the F/A-18F and some Unsung planes as these vehicles are two-seaters.",
"syntax": "[plane] call VN_fnc_vn_ejection_2",
"params": [
{
"name": "plane",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the plane from which to eject",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[sogPlane] call VN_fnc_vn_ejection_2;"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Bravo Zero One development, adapted by TeTeT",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_ejection_2"
]
},
"vn-fnc-vn-f4-cockpit": {
"title": "VN fnc vn f4 cockpit",
"callable": "VN_fnc_vn_f4_cockpit",
"slug": "vn-fnc-vn-f4-cockpit",
"description": "Function is initialized on the getIn event for F4.\nFunction is used to manage any kind of UI manipulation while the player is inside the plane, particularly MFD rendering.",
"syntax": "[] call VN_fnc_vn_f4_cockpit;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_vn_f4_cockpit"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_f4_cockpit"
]
},
"vn-fnc-vn-f4-decals-numbers": {
"title": "VN fnc vn f4 decals numbers",
"callable": "VN_fnc_vn_f4_decals_numbers",
"slug": "vn-fnc-vn-f4-decals-numbers",
"description": "Applies random decal number to the vehicle",
"syntax": "[\"_vehicle\"] call VN_fnc_vn_f4_decals_numbers;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[\"_vehicle\"] call VN_fnc_vn_f4_decals_numbers;"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_f4_decals_numbers"
]
},
"vn-fnc-vn-f4-fired-gbu8": {
"title": "VN fnc vn f4 fired gbu8",
"callable": "VN_fnc_vn_f4_fired_gbu8",
"slug": "vn-fnc-vn-f4-fired-gbu8",
"description": "Handles F4 GBU-8 firing. Sets last GBU-8 fire time to current time.",
"syntax": "[] call VN_fnc_vn_f4_fired_gbu8;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_f4_fired_gbu8"
]
},
"vn-fnc-vn-f4-optics-gbu8": {
"title": "VN fnc vn f4 optics gbu8",
"callable": "VN_fnc_vn_f4_optics_gbu8",
"slug": "vn-fnc-vn-f4-optics-gbu8",
"description": "No description added yet.",
"syntax": "[\"_vehicle\", \"_target\", \"_lock\", \"_noLock\"] call VN_fnc_vn_f4_optics_gbu8;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_target",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_lock",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_noLock",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[\"_vehicle\", \"_target\", \"_lock\", \"_noLock\"] call VN_fnc_vn_f4_optics_gbu8"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_f4_optics_gbu8"
]
},
"vn-fnc-vn-sniper-tree-init": {
"title": "VN fnc vn sniper tree init",
"callable": "VN_fnc_vn_sniper_tree_init",
"slug": "vn-fnc-vn-sniper-tree-init",
"description": "Function called when the sniper tree is initilized at mission start. Will only run once per tree.",
"syntax": "[] call VN_fnc_vn_sniper_tree_init;",
"params": [
{
"name": "_data",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Data array which contains the tree object",
"optional": true,
"default": "[]"
},
{
"name": "_faction",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Side number for the units in the tree",
"optional": true,
"default": "0"
},
{
"name": "_traps",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should the tree spawn traps around it",
"optional": true,
"default": "FALSE"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[ [tree_01],0,false] call VN_fnc_sniper_tree_init"
],
"groups": [
"vn_functions"
],
"groupLabels": [
"Miscellaneous (core)"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_sniper_tree_init"
]
},
"vn-fnc-vn-uh1-doors": {
"title": "VN fnc vn uh1 doors",
"callable": "VN_fnc_vn_uh1_doors",
"slug": "vn-fnc-vn-uh1-doors",
"description": "Closes UH1 doors",
"syntax": "[heli] call VN_fnc_vn_uh1_doors;",
"params": [
{
"name": "_heli",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Helicopter object",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[heli] call vn_fnc_vn_uh1_doors"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_uh1_doors"
]
},
"vn-fnc-vn-wheeled-doors": {
"title": "VN fnc vn wheeled doors",
"callable": "vn_fnc_vn_wheeled_doors",
"slug": "vn-fnc-vn-wheeled-doors",
"description": "Closes all doors in the vehicle",
"syntax": "[_wheeled_doors] call vn_fnc_vn_wheeled_doors;",
"params": [
{
"name": "_wheeled_doors",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle which will be affected",
"optional": true,
"default": "OBJNULL"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[truck] call vn_fnc_vn_wheeled_doors"
],
"groups": [
"functions"
],
"groupLabels": [
"Vehicle scripts"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_vn_wheeled_doors"
]
},
"vn-fnc-vrc12-onload": {
"title": "VN fnc VRC12 onLoad",
"callable": "VN_fnc_VRC12_onLoad",
"slug": "vn-fnc-vrc12-onload",
"description": "Handles UI Loading.",
"syntax": "[] call VN_fnc_VRC12_onLoad;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "UI Display",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_onLoad"
]
},
"vn-fnc-vrc12-onupdate": {
"title": "VN fnc VRC12 onUpdate",
"callable": "VN_fnc_VRC12_onUpdate",
"slug": "vn-fnc-vrc12-onupdate",
"description": "Handles UI Updates.",
"syntax": "[] call VN_fnc_VRC12_onUpdate;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_onUpdate"
]
},
"vn-fnc-vrc12-setadditional": {
"title": "VN fnc VRC12 setAdditional",
"callable": "VN_fnc_VRC12_setAdditional",
"slug": "vn-fnc-vrc12-setadditional",
"description": "Sets additional frequency.",
"syntax": "[] call VN_fnc_VRC12_setAdditional;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setAdditional"
]
},
"vn-fnc-vrc12-setaudio": {
"title": "VN fnc VRC12 setAudio",
"callable": "VN_fnc_VRC12_setAudio",
"slug": "vn-fnc-vrc12-setaudio",
"description": "Sets audio speakers.",
"syntax": "[] call VN_fnc_VRC12_setAudio;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setAudio"
]
},
"vn-fnc-vrc12-setchannel": {
"title": "VN fnc VRC12 setChannel",
"callable": "VN_fnc_VRC12_setChannel",
"slug": "vn-fnc-vrc12-setchannel",
"description": "Sets the channel. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_VRC12_setChannel;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setChannel"
]
},
"vn-fnc-vrc12-setfrequency": {
"title": "VN fnc VRC12 setFrequency",
"callable": "VN_fnc_VRC12_setFrequency",
"slug": "vn-fnc-vrc12-setfrequency",
"description": "Sets channel. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_VRC12_setFrequency;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setFrequency"
]
},
"vn-fnc-vrc12-setkhz": {
"title": "VN fnc VRC12 setKHz",
"callable": "VN_fnc_VRC12_setKHz",
"slug": "vn-fnc-vrc12-setkhz",
"description": "Sets KHzs. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_VRC12_setKHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setKHz"
]
},
"vn-fnc-vrc12-setmhz": {
"title": "VN fnc VRC12 setMHz",
"callable": "VN_fnc_VRC12_setMHz",
"slug": "vn-fnc-vrc12-setmhz",
"description": "Sets MHzs. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_VRC12_setMHz;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setMHz"
]
},
"vn-fnc-vrc12-setstereo": {
"title": "VN fnc VRC12 setStereo",
"callable": "VN_fnc_VRC12_setStereo",
"slug": "vn-fnc-vrc12-setstereo",
"description": "Sets stereo.",
"syntax": "[] call VN_fnc_VRC12_setStereo;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setStereo"
]
},
"vn-fnc-vrc12-setvolume": {
"title": "VN fnc VRC12 setVolume",
"callable": "VN_fnc_VRC12_setVolume",
"slug": "vn-fnc-vrc12-setvolume",
"description": "Sets volume. Parameters are same as onMouseButtonDown",
"syntax": "[\n \"_control\",\n \"_button\",\n \"_xPos\",\n \"_yPos\",\n \"_shift\",\n \"_ctrl\",\n \"_alt\"\n] call VN_fnc_VRC12_setVolume;",
"params": [
{
"name": "_control",
"type": "Control",
"typeMarkdown": "[Control](https://community.bistudio.com/wiki/Control)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_button",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_xPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_yPos",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_shift",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_ctrl",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
},
{
"name": "_alt",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"radios"
],
"groupLabels": [
"Radios"
],
"version": "1.00",
"author": "Heyoxe",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_VRC12_setVolume"
]
},
"vn-fnc-water-fall": {
"title": "VN fnc water fall",
"callable": "VN_fnc_water_fall",
"slug": "vn-fnc-water-fall",
"description": "Main function for the water fall module.",
"syntax": "[_object,_speed,_size,_coeff,_lifetime] call VN_fnc_water_fall;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object which will handle the particle source",
"optional": true,
"default": "OBJNULL"
},
{
"name": "_speed",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Speed at which the particles should leave the source",
"optional": true,
"default": "1"
},
{
"name": "_size",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Size of the particles when they spawn",
"optional": true,
"default": "1"
},
{
"name": "_coeff",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Multiplier which will be used with the size of the particles at the end of the fall",
"optional": true,
"default": "10"
},
{
"name": "_lifetime",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Lifetime of the particles",
"optional": true,
"default": "5"
}
],
"returns": {
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Particle source object"
},
"examples": [
"[parameter] call vn_fnc_myFunction"
],
"groups": [
"water_fall_functions"
],
"groupLabels": [
"Waterfalls"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_water_fall"
]
},
"vn-fnc-whitelisted-arsenal-calculate-access": {
"title": "VN fnc whitelisted arsenal calculate access",
"callable": "VN_fnc_whitelisted_arsenal_calculate_access",
"slug": "vn-fnc-whitelisted-arsenal-calculate-access",
"description": "Updates `VN_whitelisted_arsenal_allowedItems` global variable for the whitelisted arsenal functions, depending on the *unit*'s rank.",
"syntax": "[unit] call VN_fnc_whitelisted_arsenal_calculate_access",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "rank-checked unit",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[player] call VN_fnc_whitelisted_arsenal_calculate_access;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_calculate_access"
]
},
"vn-fnc-whitelisted-arsenal-client": {
"title": "VN fnc whitelisted arsenal client",
"callable": "VN_fnc_whitelisted_arsenal_client",
"slug": "vn-fnc-whitelisted-arsenal-client",
"description": "Sets whitelisted arsenal event handlers.",
"syntax": "[] call VN_fnc_whitelisted_arsenal_client",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[] call VN_fnc_whitelisted_arsenal_client;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_client"
]
},
"vn-fnc-whitelisted-arsenal-copilot-check": {
"title": "VN fnc whitelisted arsenal copilot check",
"callable": "VN_fnc_whitelisted_arsenal_copilot_check",
"slug": "vn-fnc-whitelisted-arsenal-copilot-check",
"description": "Check if the provided unit is in a co-pilot seat.",
"syntax": "[unit] call VN_fnc_whitelisted_arsenal_copilot_check",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "checked unit",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": ""
},
"examples": [
"[player] call VN_fnc_whitelisted_arsenal_copilot_check;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_copilot_check"
]
},
"vn-fnc-whitelisted-arsenal-hint-message": {
"title": "VN fnc whitelisted arsenal hint message",
"callable": "VN_fnc_whitelisted_arsenal_hint_message",
"slug": "vn-fnc-whitelisted-arsenal-hint-message",
"description": "Gets the data from the unit and then compiles that into a message to the player.\nIncludes ranks that can use X vehicle.\nWill hint the message automatically at the end of the function.",
"syntax": "[unit] call VN_fnc_whitelisted_arsenal_hint_message",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unit that has gotten into the vehicle",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[player] call VN_fnc_whitelisted_arsenal_hint_message;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_hint_message"
]
},
"vn-fnc-whitelisted-arsenal-lbcolor": {
"title": "VN fnc whitelisted arsenal lbColor",
"callable": "VN_fnc_whitelisted_arsenal_lbColor",
"slug": "vn-fnc-whitelisted-arsenal-lbcolor",
"description": "Color codes loadouts in the arsenal based on the availability of the items inside them.",
"syntax": "[display] call VN_fnc_whitelisted_arsenal_lbColor",
"params": [
{
"name": "display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "Arsenal display that should be used for messages, gui etc.",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[_arsenalDisplay] call VN_fnc_whitelisted_arsenal_lbColor;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_lbColor"
]
},
"vn-fnc-whitelisted-arsenal-loadinventory": {
"title": "VN fnc whitelisted arsenal loadInventory",
"callable": "VN_fnc_whitelisted_arsenal_loadInventory",
"slug": "vn-fnc-whitelisted-arsenal-loadinventory",
"description": "Adds loadout to character while also listing objects that have been skipped.",
"syntax": "[crate, settings, allowedItems] call VN_fnc_whitelisted_arsenal_loadInventory",
"params": [
{
"name": "crate",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "object that will have the items added to it",
"optional": false,
"default": ""
},
{
"name": "settings",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "format [namespace, loadoutName] - settings that are used to get the inventory",
"optional": false,
"default": ""
},
{
"name": "allowedItems",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "list of whitelisted items",
"optional": false,
"default": ""
}
],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": ""
},
"examples": [
"[sogCrate, [missionNamespace, \"Rifleman\"], []] call VN_fnc_whitelisted_arsenal_loadInventory;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_loadInventory"
]
},
"vn-fnc-whitelisted-arsenal-override": {
"title": "VN fnc whitelisted arsenal override",
"callable": "VN_fnc_whitelisted_arsenal_override",
"slug": "vn-fnc-whitelisted-arsenal-override",
"description": "Master function that contains all the gui overrides for the arsenal when whitelisted arsenal is enabled.",
"syntax": "[display] call VN_fnc_whitelisted_arsenal_override",
"params": [
{
"name": "display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "Arsenal display for the override to run on",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[_arsenalDisplay] call VN_fnc_whitelisted_arsenal_override;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_override"
]
},
"vn-fnc-whitelisted-arsenal-templateokbutton": {
"title": "VN fnc whitelisted arsenal templateOkButton",
"callable": "VN_fnc_whitelisted_arsenal_templateOkButton",
"slug": "vn-fnc-whitelisted-arsenal-templateokbutton",
"description": "Takes over the confirm button for the loadouts and can do custom things on save/load.",
"syntax": "[display] call VN_fnc_whitelisted_arsenal_templateOkButton",
"params": [
{
"name": "display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "display for the Arsenal",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[_display] call VN_fnc_whitelisted_arsenal_templateOkButton;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "local",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_templateOkButton"
]
},
"vn-fnc-whitelisted-arsenal-vehicle-eject": {
"title": "VN fnc whitelisted arsenal vehicle eject",
"callable": "VN_fnc_whitelisted_arsenal_vehicle_eject",
"slug": "vn-fnc-whitelisted-arsenal-vehicle-eject",
"description": "Gets the vehicle the player has gotten into and checks it against the vehicles for their current rank and ejects the unit if needed.\nShould be used with the \"GetInMan\" & \"SeatSwitchedMan\" event handlers",
"syntax": "[vehicle] call VN_fnc_whitelisted_arsenal_vehicle_eject",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle the player has gotten into",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[sogJeep] call VN_fnc_whitelisted_arsenal_vehicle_eject;"
],
"groups": [
"whitelisted_arsenal_functions"
],
"groupLabels": [
"Whitelisted arsenal"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_whitelisted_arsenal_vehicle_eject"
]
},
"vn-fnc-wm-eh-closewm": {
"title": "VN fnc wm EH closeWM",
"callable": "VN_fnc_wm_EH_closeWM",
"slug": "vn-fnc-wm-eh-closewm",
"description": "Eventhandler: closes the Wheelmenu and blocks the input of that button (yeah, that's it).",
"syntax": "[] call VN_fnc_wm_EH_closeWM;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"VN_DISP_WHEELMENU displayAddEventHandler [\"KeyUp\", {call vn_fnc_wm_EH_closeWM;}];"
],
"groups": [
"wheelmenu"
],
"groupLabels": [
"Wheel menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_wm_EH_closeWM"
]
},
"vn-fnc-wm-eh-mousebup": {
"title": "VN fnc wm EH MouseBUp",
"callable": "VN_fnc_wm_EH_MouseBUp",
"slug": "vn-fnc-wm-eh-mousebup",
"description": "Eventhandler: Get the selected Function from \"vn_wm_SelectedFunction\" (defined in \"vn_fnc_wm_getMousePos\") and call or spawn it.",
"syntax": "[] call VN_fnc_wm_EH_MouseBUp;",
"params": [],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"Called in display Config:\n\"onMouseButtonUp = \"call vn_fnc_wm_EH_MouseBUp;\";\""
],
"groups": [
"wheelmenu"
],
"groupLabels": [
"Wheel menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_wm_EH_MouseBUp"
]
},
"vn-fnc-wm-getmousepos": {
"title": "VN fnc wm getMousePos",
"callable": "VN_fnc_wm_getMousePos",
"slug": "vn-fnc-wm-getmousepos",
"description": "- get mousePosition and check it's coordinates if it's inside of a zone\n- if mouse inside:\n - set selected Function and Icon for usage in Eventhandler: \"vn_fnc_wm_EH_MouseBUp\"\n- else:\n - reset everything to default\n - Set/Update of variable \"vn_wm_SelectedFunction\" & \"vn_wm_SelectedIcon\"",
"syntax": "[] call VN_fnc_wm_getMousePos;",
"params": [
{
"name": "_CtrlCheckList",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "each entry in that list, has the information about the used icons/functions",
"optional": true,
"default": "[]"
},
{
"name": "_selector_icons",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Icons",
"optional": true,
"default": "[]"
},
{
"name": "_selector_icons_0",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "path to selector Texture",
"optional": false,
"default": ""
},
{
"name": "_selector_icons_1",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "path to highlighted selector Texture",
"optional": false,
"default": ""
}
],
"returns": {
"type": "TYPE",
"typeMarkdown": "TYPE",
"description": "Return description"
},
"examples": [
"[\n_CtrlCheckList,\t//More details in \"vn_fnc_wm_init\"\n\t[\n\t\t\"\\vn\\ui_f_vietnam\\ui\\wheelmenu\\img\\ui_wm_selector_1_cal.paa\",\n\t\t\"\\vn\\ui_f_vietnam\\ui\\wheelmenu\\img\\ui_wm_selector_1_hit_cal.paa\"\n\t]\n] call vn_fnc_wm_getMousePos;"
],
"groups": [
"wheelmenu"
],
"groupLabels": [
"Wheel menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_wm_getMousePos"
]
},
"vn-fnc-wm-init": {
"title": "VN fnc wm init",
"callable": "VN_fnc_wm_init",
"slug": "vn-fnc-wm-init",
"description": "- initilization of the Wheelmenu (aka: Start this monstrosity!)\n- Set up all Selectors with Icons, Colors, Functions. Depending on the amount of Vars given to it (example)\n- autoadjusting the WM, depending on the amount of Entrys\n- Min: 2 Entrys\n- Max: 10 Entrys",
"syntax": "[\n _iconList,\n _n,\n _0,\n _1,\n _2,\n _2_0,\n _2_1,\n _2_2,\n _3,\n _3_0,\n _3_1,\n _4,\n _4_0,\n _4_1,\n _isModule\n] call VN_fnc_wm_init;",
"params": [
{
"name": "_iconList",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "List of Items/Vars to be added to the Menu",
"optional": true,
"default": "[]"
},
{
"name": "_n",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Parameters",
"optional": false,
"default": ""
},
{
"name": "_0",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Path to Icon normal",
"optional": false,
"default": ""
},
{
"name": "_1",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Path to Icon Highlighted (if desired)",
"optional": false,
"default": ""
},
{
"name": "_2",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "No description",
"optional": false,
"default": ""
},
{
"name": "_2_0",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Params to send over to the functions",
"optional": false,
"default": ""
},
{
"name": "_2_1",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Which function to call/spawn",
"optional": false,
"default": ""
},
{
"name": "_2_2",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Spawn (TRUE) or Call (FALSE)",
"optional": true,
"default": "FALSE"
},
{
"name": "_3",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "No description",
"optional": true,
"default": "[]"
},
{
"name": "_3_0",
"type": "COLOR",
"typeMarkdown": "COLOR",
"description": "Colorcode Array - Selector - Normal",
"optional": false,
"default": ""
},
{
"name": "_3_1",
"type": "COLOR",
"typeMarkdown": "COLOR",
"description": "Colorcode Array - Selector - highlighted",
"optional": false,
"default": ""
},
{
"name": "_4",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "No description",
"optional": true,
"default": "[]"
},
{
"name": "_4_0",
"type": "COLOR",
"typeMarkdown": "COLOR",
"description": "Colorcode Array - Icon - Normal",
"optional": false,
"default": ""
},
{
"name": "_4_1",
"type": "COLOR",
"typeMarkdown": "COLOR",
"description": "Colorcode Array - Icon - highlighted",
"optional": false,
"default": ""
},
{
"name": "_isModule",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Loaded via Module or not, so it selects the proper \"close functions\" (using the Key bound in the VN Keyhandler)",
"optional": true,
"default": "FALSE"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"MINIMAL:\t[\"vn\\ui_f_vietnam\\ui\\wheelmenu\\img\\handsignals\\ui_wm_selector_hand_001_ca.paa\", \"\",\t[ [\"vn_handsignal_freeze\",\"Text for centerCtrl\"],\t\"vn_fnc_playGesture\"] ]\n\t\tFULL:\t\t[\"vn\\ui_f_vietnam\\ui\\wheelmenu\\img\\handsignals\\ui_wm_selector_hand_001_ca.paa\", \"\",\t[ [\"vn_handsignal_freeze\",\"Text for centerCtrl\"],\t\"vn_fnc_playGesture\", false],[ _color_selector, _color_selector_hl ],\t[ _color_icon, _color_icon_hl ] ]\n\n\t\t[\n\t\t\t[\n\t\t\t\t[\n\t\t\t\t\t\"\\vn\\ui_f_vietnam\\ui\\wheelmenu\\img\\ui_icon_a_ca.paa\",\n\t\t\t\t\t\"\",\n\t\t\t\t\t[\n\t\t\t\t\t\t[\"gestureFreeze\",\"Text for centerCtrl\"],\n\t\t\t\t\t\t\"vn_fnc_playGesture\",\n\t\t\t\t\t\tFALSE\n\t\t\t\t\t],\n\t\t\t\t\t[\n\t\t\t\t\t\t[0,0,0,0],\n\t\t\t\t\t\t[0,0,0,0]\n\t\t\t\t\t],\n\t\t\t\t\t[\n\t\t\t\t\t\t[0,0,0,0],\n\t\t\t\t\t[0,0,0,0]\n\t\t\t\t\t]\n\t\t\t\t],\n\t\t\t\t... repeat\n\t\t\t]\n\t\t] call vn_fnc_wm_init;"
],
"groups": [
"wheelmenu"
],
"groupLabels": [
"Wheel menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_wm_init"
]
},
"vn-fnc-wm-text-adjustfontsize": {
"title": "VN fnc wm text adjustFontSize",
"callable": "VN_fnc_wm_text_adjustFontSize",
"slug": "vn-fnc-wm-text-adjustfontsize",
"description": "```sqf\nAdjusting the textsize (sizeEx) of control (type = 0), until it fit's in or it reaches the min. size.\n\t\t//////////////////// IMPORTANT:\n\t\t///// Waiting for \"getTextWidth\" to be implemented...\n\t\t///// Means: Ignore this file for now. It's a dirty/hacky way, but at least it works...\n\t\t///// \"ui_f_vietnam_c\\ui\\functions\\fn_checkFontSize.sqf\" <-- proper one\n\t\t////////////////////////////////////////////////////////////////////////////////\n```",
"syntax": "[_lastSelectorIDC] call VN_fnc_wm_text_adjustFontSize;",
"params": [
{
"name": "_lastSelectorIDC",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "IDC of the control, wich should be checked",
"optional": true,
"default": "-1"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[ctrlIDC _ctrl] call VN_fnc_WM_text_adjustFontSize;"
],
"groups": [
"wheelmenu"
],
"groupLabels": [
"Wheel menu"
],
"version": "1.00",
"author": "Dscha",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_wm_text_adjustFontSize"
]
},
"vn-fnc-zeus-ordnance": {
"title": "VN fnc zeus ordnance",
"callable": "VN_fnc_zeus_ordnance",
"slug": "vn-fnc-zeus-ordnance",
"description": "Ordnance function which allows zeus modules to fire ordnance.",
"syntax": "[logic, units, isActivated] call VN_fnc_zeus_ordnance",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[module, units group player, true] call VN_fnc_zeus_ordnance;"
],
"groups": [
"zeus_functions"
],
"groupLabels": [
"Zeus"
],
"version": "1.00",
"author": "Ethan Johnson",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_fnc_zeus_ordnance"
]
},
"vn-ms-fnc-addarsenalaction": {
"title": "Vn ms fnc addArsenalAction",
"callable": "vn_ms_fnc_addArsenalAction",
"slug": "vn-ms-fnc-addarsenalaction",
"description": "Adds arsenal action to given object, if VN arsenal is enabled.",
"syntax": "[_crate] call vn_ms_fnc_addArsenalAction;",
"params": [
{
"name": "_crate",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Crate to add the action to.",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[myCrate] call vn_ms_fnc_addArsenalAction"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_addArsenalAction"
]
},
"vn-ms-fnc-addmissingradio": {
"title": "Vn ms fnc addMissingRadio",
"callable": "vn_ms_fnc_addMissingRadio",
"slug": "vn-ms-fnc-addmissingradio",
"description": "Adds a default radio to the player, if he doesn't have a default, TFAR or ACRE radio equipped.",
"syntax": "[] call vn_ms_fnc_addMissingRadio;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[] call vn_ms_fnc_addMissingRadio;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_addMissingRadio"
]
},
"vn-ms-fnc-addropeattacheh": {
"title": "Vn ms fnc addRopeAttachEH",
"callable": "vn_ms_fnc_addRopeAttachEH",
"slug": "vn-ms-fnc-addropeattacheh",
"description": "Adds event handler to given object to ensure same locality for slingloaded cargo.",
"syntax": "[_obj] call vn_ms_fnc_addRopeAttachEH;",
"params": [
{
"name": "_obj",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object to add the EH for.",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[vn_veh_kingbee] call vn_ms_fnc_addRopeAttachEH;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_addRopeAttachEH"
]
},
"vn-ms-fnc-addteleportaction": {
"title": "VN ms fnc addTeleportAction",
"callable": "VN_ms_fnc_addTeleportAction",
"slug": "vn-ms-fnc-addteleportaction",
"description": "Adds action to teleport action caller to his group leader - uses VN_ms_fnc_aoTeleport.",
"syntax": "[gate] call VN_ms_fnc_addTeleportAction",
"params": [
{
"name": "gate",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "teleportation object",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[sogFlag] call VN_ms_fnc_addTeleportAction;",
"[player] call VN_ms_fnc_addTeleportAction;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_addTeleportAction"
]
},
"vn-ms-fnc-aihelitransport": {
"title": "Vn ms fnc aiHeliTransport",
"callable": "vn_ms_fnc_aiHeliTransport",
"slug": "vn-ms-fnc-aihelitransport",
"description": "No description added yet.",
"syntax": "[\n _group,\n _vehicle,\n _route,\n _lz,\n _goCondition,\n _unlock\n] call vn_ms_fnc_aiHeliTransport;",
"params": [
{
"name": "_group",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "",
"optional": true,
"default": "grpNull"
},
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": true,
"default": "objNull"
},
{
"name": "_route",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "",
"optional": true,
"default": "[]"
},
{
"name": "_lz",
"type": "String|Object|Array",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)|[Object](https://community.bistudio.com/wiki/Object)|[Array](https://community.bistudio.com/wiki/Array)",
"description": "",
"optional": true,
"default": "nil"
},
{
"name": "_goCondition",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "",
"optional": true,
"default": "{sleep 30; true}"
},
{
"name": "_unlock",
"type": "",
"typeMarkdown": "",
"description": "Should heli pilot/co-pilot be unlocked after AI is done with transport",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Insertion completed."
},
"examples": [
"[myGroup, myVehicle, [\"marker1\", \"marker2\"], myHelipad, {true}] call vn_ms_fnc_aiHeliTransport;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_aiHeliTransport"
]
},
"vn-ms-fnc-aihelitransportaddaction": {
"title": "VN ms fnc aiHeliTransportAddAction",
"callable": "VN_ms_fnc_aiHeliTransportAddAction",
"slug": "vn-ms-fnc-aihelitransportaddaction",
"description": "Add skip AI insertion travel hold action.",
"syntax": "[vehicle] call VN_ms_fnc_aiHeliTransportAddAction",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the vehicle to skip transport",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[sogChopper] call VN_ms_fnc_aiHeliTransportAddAction;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_aiHeliTransportAddAction",
"/index.php/Vn_ms_fnc_aiHeliTransportAddAction"
]
},
"vn-ms-fnc-aihelitransportskip": {
"title": "VN ms fnc aiHeliTransportSkip",
"callable": "VN_ms_fnc_aiHeliTransportSkip",
"slug": "vn-ms-fnc-aihelitransportskip",
"description": "Skip AI insertion travel - uses the group leader's vehicle. The fade to black lasts 1 second, the default black screen duration is 5 seconds and the black in takes 8 seconds.",
"syntax": "[group, delay] call VN_ms_fnc_aiHeliTransportSkip",
"params": [
{
"name": "group",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "group doing the insertion",
"optional": false,
"default": ""
},
{
"name": "delay",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "black screen additional duration",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[group player, 5] call VN_ms_fnc_aiHeliTransportSkip;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_aiHeliTransportSkip",
"/index.php/Vn_ms_fnc_aiHeliTransportSkip"
]
},
"vn-ms-fnc-aisetskill": {
"title": "VN ms fnc aiSetSkill",
"callable": "VN_ms_fnc_aiSetSkill",
"slug": "vn-ms-fnc-aisetskill",
"description": "Configure unit skills. These are tuned for infantry jungle-fighting, and may not work as well on vehicle crews.",
"syntax": "[unit] call VN_ms_fnc_aiSetSkill",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit to which to set skill",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[bob] call VN_ms_fnc_aiSetSkill;",
"private _pedestrians = allUnits select { isNull objectParent _x };\n{\n\t[_x] call VN_ms_fnc_aiSetSkill;\n} forEach _pedestrians;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29, Spoffy",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_aiSetSkill",
"/index.php/Vn_ms_fnc_aiSetSkill"
]
},
"vn-ms-fnc-aoteleport": {
"title": "VN ms fnc aoTeleport",
"callable": "VN_ms_fnc_aoTeleport",
"slug": "vn-ms-fnc-aoteleport",
"description": "Teleports the player to the given position. Can spawn an ambient helicopter (uses VN_ms_fnc_spawnAmbHeli).",
"syntax": "[pos, radius, heliClass] call VN_ms_fnc_aoTeleport",
"params": [
{
"name": "pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "centre position to which the unit should be teleported",
"optional": false,
"default": ""
},
{
"name": "radius",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "**exact distance** from *pos* at a random (360°) angle",
"optional": true,
"default": "10"
},
{
"name": "heliClass",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "helicopter classname - if empty, no helicopter will be spawned",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[getPos sogLeader, 5] call VN_ms_fnc_aoTeleport;",
"[getPos sogLeader, 5, \"VN_b_air_CH34_04_04\"] call VN_ms_fnc_aoTeleport;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_aoTeleport",
"/index.php/Vn_ms_fnc_aoTeleport"
]
},
"vn-ms-fnc-cachelayer": {
"title": "VN ms fnc cacheLayer",
"callable": "VN_ms_fnc_cacheLayer",
"slug": "vn-ms-fnc-cachelayer",
"description": "Toggle caching (disabling simulation) of editor layer.",
"syntax": "[layerName, cached] call VN_ms_fnc_cacheLayer",
"params": [
{
"name": "layerName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "layer name",
"optional": false,
"default": ""
},
{
"name": "cached",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "caching state",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[\"myEditorLayer\", false] call VN_ms_fnc_cacheLayer;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": true,
"aliases": [
"/index.php/VN_ms_fnc_cacheLayer",
"/index.php/Vn_ms_fnc_cacheLayer"
]
},
"vn-ms-fnc-casairstrike": {
"title": "Vn ms fnc casAirstrike",
"callable": "vn_ms_fnc_casAirstrike",
"slug": "vn-ms-fnc-casairstrike",
"description": "Spawn CAS plane to bomb target position.\nThe plane starts at marker \"vn_cas_start\" and despawns at \"vn_cas_stop\" (or 0,0,0 if no marker present).",
"syntax": "[_targetPos,_start,_captive,_fnc_onStrike] call vn_ms_fnc_casAirstrike;",
"params": [
{
"name": "_targetPos",
"type": "Object, Position",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object), [Position](https://community.bistudio.com/wiki/Position)",
"description": "Target position to bomb.",
"optional": true,
"default": "objNull"
},
{
"name": "_start",
"type": "Position",
"typeMarkdown": "[Position](https://community.bistudio.com/wiki/Position)",
"description": "Start position of the CAS plane.",
"optional": true,
"default": "markerPos \"vn_cas_start\""
},
{
"name": "_captive",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should the plane be captive.",
"optional": true,
"default": "false"
},
{
"name": "_fnc_onStrike",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "Function called right before bombs drop",
"optional": true,
"default": "{}"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[markerPos \"vn_wp07_camp\"] call vn_ms_fnc_casAirstrike"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_casAirstrike"
]
},
"vn-ms-fnc-createflare": {
"title": "VN ms fnc createFlare",
"callable": "VN_ms_fnc_createFlare",
"slug": "vn-ms-fnc-createflare",
"description": "Create ilumination flare on given position.",
"syntax": "[position, size] call VN_ms_fnc_createFlare",
"params": [
{
"name": "position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "the flare's position",
"optional": false,
"default": ""
},
{
"name": "size",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "the flare's size - can only be 0, 1 or 2 for small, medium and large",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the flare object"
},
"examples": [
"[getPos player vectorAdd [0, 0, 50], 2] call VN_ms_fnc_createFlare;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": true,
"aliases": [
"/index.php/VN_ms_fnc_createFlare",
"/index.php/Vn_ms_fnc_createFlare"
]
},
"vn-ms-fnc-debug": {
"title": "Vn ms fnc debug",
"callable": "vn_ms_fnc_debug",
"slug": "vn-ms-fnc-debug",
"description": "Enables debug for campaign.",
"syntax": "[] call vn_ms_fnc_debug;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call vn_ms_fnc_debug;"
],
"groups": [
"debug"
],
"groupLabels": [
"Debug (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_debug"
]
},
"vn-ms-fnc-debug-menu": {
"title": "Vn ms fnc debug menu",
"callable": "vn_ms_fnc_debug_menu",
"slug": "vn-ms-fnc-debug-menu",
"description": "Initialize debug functionalities in pause menu",
"syntax": "[] call vn_ms_fnc_debug_menu;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[] call vn_ms_fnc_debug_menu;"
],
"groups": [
"debug"
],
"groupLabels": [
"Debug (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_debug_menu"
]
},
"vn-ms-fnc-deletewaypoints": {
"title": "VN ms fnc deleteWaypoints",
"callable": "VN_ms_fnc_deleteWaypoints",
"slug": "vn-ms-fnc-deletewaypoints",
"description": "Remove all current group waypoints and reset their pathing.",
"syntax": "[group] call VN_ms_fnc_deleteWaypoints",
"params": [
{
"name": "group",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "group to strip from its waypoints",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[group player] call VN_ms_fnc_deleteWaypoints;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_deleteWaypoints",
"/index.php/Vn_ms_fnc_deleteWaypoints"
]
},
"vn-ms-fnc-dgbt-cratedeliver": {
"title": "VN ms fnc dgbt crateDeliver",
"callable": "VN_ms_fnc_dgbt_crateDeliver",
"slug": "vn-ms-fnc-dgbt-cratedeliver",
"description": "Starts the crate transport DGBT delivery phase with given parameters. Uses VN_ms_fnc_dgbt_generateTaskId.",
"syntax": "[group, pos, parentTask] call VN_ms_fnc_dgbt_crateDeliver",
"params": [
{
"name": "group",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "group that will receive the delivery task",
"optional": false,
"default": ""
},
{
"name": "pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "crate delivery position",
"optional": false,
"default": ""
},
{
"name": "parentTask",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "if provided, the task will be created as a child to *parentTask*",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "created task ID"
},
"examples": [
"[sogAirTeam, getMarkerPos \"SOG_delivery\", \"\"] call VN_ms_fnc_dgbt_crateDeliver;"
],
"groups": [
"dgbt"
],
"groupLabels": [
"Background tasks (DGBT)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_dgbt_crateDeliver"
]
},
"vn-ms-fnc-dgbt-cratestart": {
"title": "VN ms fnc dgbt crateStart",
"callable": "VN_ms_fnc_dgbt_crateStart",
"slug": "vn-ms-fnc-dgbt-cratestart",
"description": "Starts the crate transport DGBT pickup phase with given parameters. Uses VN_ms_fnc_dgbt_generateTaskId.",
"syntax": "[group, pos, parentTask, boxClass] call VN_ms_fnc_dgbt_crateStart",
"params": [
{
"name": "group",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "task bearer",
"optional": false,
"default": ""
},
{
"name": "pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "box spawn position",
"optional": false,
"default": ""
},
{
"name": "parentTask",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "if provided, the task will be parent task",
"optional": true,
"default": "\"\""
},
{
"name": "boxClass",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "box classname to be created",
"optional": true,
"default": "\"vn_b_ammobox_supply_05\""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "[crate, task] or empty array on failure"
},
"examples": [
"[group player, getMarkerPos \"crate_pos\", \"\", \"vn_b_ammobox_supply_04\"] call VN_ms_fnc_dgbt_crateStart;"
],
"groups": [
"dgbt"
],
"groupLabels": [
"Background tasks (DGBT)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_dgbt_crateStart",
"/index.php/Vn_ms_fnc_dgbt_crateStart"
]
},
"vn-ms-fnc-dgbt-createlocatemarker": {
"title": "Vn ms fnc dgbt createLocateMarker",
"callable": "vn_ms_fnc_dgbt_createLocateMarker",
"slug": "vn-ms-fnc-dgbt-createlocatemarker",
"description": "Creates an area marker around given position.",
"syntax": "[_pos,_markerName] call vn_ms_fnc_dgbt_createLocateMarker;",
"params": [
{
"name": "_pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Position where the marker should be created.",
"optional": true,
"default": "[0, 0, 0]"
},
{
"name": "_markerName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Name of the marker which should be created.",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[getPos player, \"fancyMarker\"] call vn_ms_fnc_dgbt_createLocateMarker"
],
"groups": [
"dgbt"
],
"groupLabels": [
"Background tasks (DGBT)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_dgbt_createLocateMarker"
]
},
"vn-ms-fnc-dgbt-generatetaskid": {
"title": "VN ms fnc dgbt generateTaskId",
"callable": "VN_ms_fnc_dgbt_generateTaskId",
"slug": "vn-ms-fnc-dgbt-generatetaskid",
"description": "Generates a dgbt-prefixed task ID - format `dgbt_t__`.",
"syntax": "[parentTask] call VN_ms_fnc_dgbt_generateTaskId",
"params": [
{
"name": "parentTask",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "if provided, task will be created as a child task to this one",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "format [task id, task creation argument] ([generatedId, generatedId] or [generatedId, [generatedId, parentTaskId]])"
},
"examples": [
"[] call VN_ms_fnc_dgbt_generateTaskId;",
"[\"theParentTask\"] call VN_ms_fnc_dgbt_generateTaskId;"
],
"groups": [
"dgbt"
],
"groupLabels": [
"Background tasks (DGBT)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_dgbt_generateTaskId",
"/index.php/Vn_ms_fnc_dgbt_generateTaskId"
]
},
"vn-ms-fnc-dgbt-squadboard": {
"title": "VN ms fnc dgbt squadBoard",
"callable": "VN_ms_fnc_dgbt_squadBoard",
"slug": "vn-ms-fnc-dgbt-squadboard",
"description": "Let the squad from current DGBT board the helicopter. Uses VN_ms_fnc_dgbt_generateTaskId.",
"syntax": "[\n taskedGroup,\n boardingGroup,\n helicopter,\n parentTask\n] call VN_ms_fnc_dgbt_squadBoard",
"params": [
{
"name": "taskedGroup",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "the group to receive the task",
"optional": false,
"default": ""
},
{
"name": "boardingGroup",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "group to board *helicopter*",
"optional": false,
"default": ""
},
{
"name": "helicopter",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the pick-up vehicle",
"optional": false,
"default": ""
},
{
"name": "parentTask",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "if provided, the task will be parent task",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "created task id"
},
"examples": [
"[heliGroup, sogGroup, ch34_1] call VN_ms_fnc_dgbt_squadBoard;"
],
"groups": [
"dgbt"
],
"groupLabels": [
"Background tasks (DGBT)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_dgbt_squadBoard",
"/index.php/Vn_ms_fnc_dgbt_squadBoard"
]
},
"vn-ms-fnc-dgbt-squadstart": {
"title": "VN ms fnc dgbt squadStart",
"callable": "VN_ms_fnc_dgbt_squadStart",
"slug": "vn-ms-fnc-dgbt-squadstart",
"description": "Starts the squad transport DGBT pickup phase - the random area being a square of 800m × 800m.",
"syntax": "[taskedGroup, pos, parentTask, unitClasses] call VN_ms_fnc_dgbt_squadStart",
"params": [
{
"name": "taskedGroup",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "the group to receive the task",
"optional": false,
"default": ""
},
{
"name": "pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "group to board *helicopter*",
"optional": false,
"default": ""
},
{
"name": "parentTask",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "if provided, the task will be created as child to that parent task",
"optional": true,
"default": "\"\""
},
{
"name": "unitClasses",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "transported units' classnames",
"optional": true,
"default": "[\"vn_b_men_army_02\", \"vn_b_men_army_08\", \"vn_b_men_army_03\", \"vn_b_men_army_10\", \"vn_b_men_army_06\", \"vn_b_men_army_05\"]"
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "format [squad group, units, currentTask, markerName]"
},
"examples": [
"[helicopterGroup, getMarkerPos \"LZ\", nil, [\"vn_b_men_army_01\", \"vn_b_men_army_02\", \"vn_b_men_army_03\"]] call VN_ms_fnc_dgbt_squadStart;"
],
"groups": [
"dgbt"
],
"groupLabels": [
"Background tasks (DGBT)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_dgbt_squadStart",
"/index.php/Vn_ms_fnc_dgbt_squadStart"
]
},
"vn-ms-fnc-driveoneditorpath": {
"title": "Vn ms fnc driveOnEditorPath",
"callable": "vn_ms_fnc_driveOnEditorPath",
"slug": "vn-ms-fnc-driveoneditorpath",
"description": "Order vehicle to follow the path created from objects placed in specified editor layer.\nVehicle will start from closest object to itself and continue to next closest one and so on.\nIt's recommended to use \"Sign_Sphere\" objects.",
"syntax": "[_vehicle,_layerName,_delete] call vn_ms_fnc_driveOnEditorPath;",
"params": [
{
"name": "_vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Vehicle that will follow the path.",
"optional": true,
"default": "objNull"
},
{
"name": "_layerName",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Layer that contains route objects.",
"optional": true,
"default": "\"\""
},
{
"name": "_delete",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should the route objects be deleted.",
"optional": true,
"default": "false"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[vn_sp01_jeep, \"jeep_path\"] call vn_ms_fnc_driveOnEditorPath;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_driveOnEditorPath"
]
},
"vn-ms-fnc-dropordnance": {
"title": "VN ms fnc dropOrdnance",
"callable": "VN_ms_fnc_dropOrdnance",
"slug": "vn-ms-fnc-dropordnance",
"description": "Drop (air) ordnance from the provided vehicle.",
"syntax": "[bomber, bombClasses, amount] call VN_ms_fnc_dropOrdnance",
"params": [
{
"name": "bomber",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "ordnance dropper",
"optional": false,
"default": ""
},
{
"name": "bombClasses",
"type": "Array of String",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [String](https://community.bistudio.com/wiki/String)",
"description": "array from which will be picked the ordnance class",
"optional": true,
"default": "ORDNANCES_ARRAY"
},
{
"name": "amount",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "amount of dropped ordnances",
"optional": true,
"default": "3"
}
],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": "the bombing script handle"
},
"examples": [
"[casAirplane, nil, 30] call VN_ms_fnc_dropOrdnance;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_dropOrdnance",
"/index.php/Vn_ms_fnc_dropOrdnance"
]
},
"vn-ms-fnc-enablesogtraits": {
"title": "Vn ms fnc enableSOGTraits",
"callable": "vn_ms_fnc_enableSOGTraits",
"slug": "vn-ms-fnc-enablesogtraits",
"description": "Initialize SOG traits for player.",
"syntax": "[] call vn_ms_fnc_enableSOGTraits;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Player traits were set up."
},
"examples": [
"[] call vn_ms_fnc_enableSOGTraits;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_enableSOGTraits"
]
},
"vn-ms-fnc-forcecampaignface": {
"title": "Vn ms fnc forceCampaignFace",
"callable": "vn_ms_fnc_forceCampaignFace",
"slug": "vn-ms-fnc-forcecampaignface",
"description": "Forces the desired face to the player unit for the campaign.",
"syntax": "[] call vn_ms_fnc_forceCampaignFace;",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[] call vn_ms_fnc_forceCampaignFace;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_forceCampaignFace"
]
},
"vn-ms-fnc-gui-onload-rscdisplaysogwatch": {
"title": "Vn ms fnc gui onLoad RscDisplaySOGWatch",
"callable": "vn_ms_fnc_gui_onLoad_RscDisplaySOGWatch",
"slug": "vn-ms-fnc-gui-onload-rscdisplaysogwatch",
"description": "Initialize RscDisplaySOGWatch.",
"syntax": "[_display] call vn_ms_fnc_gui_onLoad_RscDisplaySOGWatch;",
"params": [
{
"name": "_display",
"type": "Display",
"typeMarkdown": "[Display](https://community.bistudio.com/wiki/Display)",
"description": "Initialized display.",
"optional": true,
"default": "displayNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end."
},
"examples": [
"[display] call vn_ms_fnc_gui_onLoad_RscDisplaySOGWatch"
],
"groups": [
"gui"
],
"groupLabels": [
"GUI"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_gui_onLoad_RscDisplaySOGWatch"
]
},
"vn-ms-fnc-hasitems": {
"title": "Vn ms fnc hasItems",
"callable": "vn_ms_fnc_hasItems",
"slug": "vn-ms-fnc-hasitems",
"description": "Checks if given units have at least one of each given item in their inventory.",
"syntax": "[_units,_items,_all] call vn_ms_fnc_hasItems;",
"params": [
{
"name": "_units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of units and/or groups to check for the item.",
"optional": true,
"default": "[]"
},
{
"name": "_items",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Array of item classnames to check for in their inventories.",
"optional": true,
"default": "[]"
},
{
"name": "_all",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Selector if all items should be in the inventory at least once or just one of the items are needed.",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "At least one of each item is in the inventory of provided groups."
},
"examples": [
"[ [player], [\"vn_mine_m18_mag\", \"vn_mine_m18_x3_mag\"] ] call vn_ms_fnc_hasItems\n// Both listed items are need to be at least once in the inventory",
"[ [player], [\"vn_mine_m18_mag\", \"vn_mine_m18_x3_mag\"], false ] call vn_ms_fnc_hasItems\n// One of the listed items needs to be at least once in the inventory"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_hasItems",
"/index.php/VN_ms_fnc_hasItems"
]
},
"vn-ms-fnc-hiderespawnmarkers": {
"title": "VN ms fnc hideRespawnMarkers",
"callable": "VN_ms_fnc_hideRespawnMarkers",
"slug": "vn-ms-fnc-hiderespawnmarkers",
"description": "Hides all BI respawn markers for units.",
"syntax": "[] call VN_ms_fnc_hideRespawnMarkers",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[] call VN_ms_fnc_hideRespawnMarkers;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_hideRespawnMarkers",
"/index.php/Vn_ms_fnc_hideRespawnMarkers"
]
},
"vn-ms-fnc-isnear": {
"title": "VN ms fnc isNear",
"callable": "VN_ms_fnc_isNear",
"slug": "vn-ms-fnc-isnear",
"description": "Checks if most (> 50%) or any (at least 1) of the units are inside a given radius from a given object/position.",
"syntax": "[groupsAndUnits, centre, radius, any, distance3D] call VN_ms_fnc_isNear",
"params": [
{
"name": "groupsAndUnits",
"type": "Object, Group, Array of Object and/or Group",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object), [Group](https://community.bistudio.com/wiki/Group), [Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object) and/or [Group](https://community.bistudio.com/wiki/Group)",
"description": "array of groups and/or units",
"optional": false,
"default": ""
},
{
"name": "centre",
"type": "Array format Position or Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) format [Position](https://community.bistudio.com/wiki/Position) or [Object](https://community.bistudio.com/wiki/Object)",
"description": "the expected destination",
"optional": false,
"default": ""
},
{
"name": "radius",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "distance to check",
"optional": true,
"default": "15"
},
{
"name": "any",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "check if *any* unit is close",
"optional": true,
"default": "false"
},
{
"name": "distance3D",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the check done in 3D distance",
"optional": true,
"default": "false"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "are all (or any) provided units inside given radius from given centre"
},
"examples": [
"[[player, groupBravo], getMarkerPos \"destination\", 5, true, true] call VN_ms_fnc_isNear;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_isNear",
"/index.php/Vn_ms_fnc_isNear"
]
},
"vn-ms-fnc-params-aimcoef": {
"title": "VN ms fnc params aimCoef",
"callable": "VN_ms_fnc_params_aimCoef",
"slug": "vn-ms-fnc-params-aimcoef",
"description": "Sets player's VN aimCoef parameter (0.1 [aiming coefficient](https://community.bistudio.com/wiki/setCustomAimCoef)). Is reapplied on player's respawn.",
"syntax": "[parameter] call VN_ms_fnc_params_aimCoef",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "acts as a boolean; 1 = [setCustomAimCoef](https://community.bistudio.com/wiki/setCustomAimCoef) 0.1, any other value = 0 = no change.",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[1] call VN_ms_fnc_params_aimCoef;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_aimCoef",
"/index.php/Vn_ms_fnc_params_aimCoef"
]
},
"vn-ms-fnc-params-arsenal": {
"title": "VN ms fnc params arsenal",
"callable": "VN_ms_fnc_params_arsenal",
"slug": "vn-ms-fnc-params-arsenal",
"description": "Sets VN whitelisted arsenal enabled/disabled parameter.",
"syntax": "[parameter] call VN_ms_fnc_params_arsenal",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "acts as a boolean; 1 = enabled, any other value = 0 = disabled.",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[1] call VN_ms_fnc_params_arsenal;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_arsenal",
"/index.php/Vn_ms_fnc_params_arsenal"
]
},
"vn-ms-fnc-params-difficulty": {
"title": "VN ms fnc params difficulty",
"callable": "VN_ms_fnc_params_difficulty",
"slug": "vn-ms-fnc-params-difficulty",
"description": "Sets VN difficulty parameter and sets the weather server-side.",
"syntax": "[parameter] call VN_ms_fnc_params_difficulty",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "difficulty, as well as weather factor + 1",
"optional": true,
"default": "1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[2] call VN_ms_fnc_params_difficulty;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_difficulty",
"/index.php/Vn_ms_fnc_params_difficulty"
]
},
"vn-ms-fnc-params-failonwipe": {
"title": "VN ms fnc params failOnWipe",
"callable": "VN_ms_fnc_params_failOnWipe",
"slug": "vn-ms-fnc-params-failonwipe",
"description": "Sets VN mission failure on wipe parameter.",
"syntax": "[] call VN_ms_fnc_params_failOnWipe",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "",
"optional": true,
"default": "1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[0] call VN_ms_fnc_params_failOnWipe;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_failOnWipe",
"/index.php/Vn_ms_fnc_params_failOnWipe"
]
},
"vn-ms-fnc-params-hints": {
"title": "VN ms fnc params hints",
"callable": "VN_ms_fnc_params_hints",
"slug": "vn-ms-fnc-params-hints",
"description": "Sets VN hints parameter.",
"syntax": "[parameter] call VN_ms_fnc_params_hints",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "acts as a boolean; 1 = true, any other value = 0 = false",
"optional": true,
"default": "1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[255] call VN_ms_fnc_params_hints;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_hints",
"/index.php/Vn_ms_fnc_params_hints"
]
},
"vn-ms-fnc-params-respawndelay": {
"title": "VN ms fnc params respawnDelay",
"callable": "VN_ms_fnc_params_respawnDelay",
"slug": "vn-ms-fnc-params-respawndelay",
"description": "Sets VN Respawn delay parameter.",
"syntax": "[parameter] call VN_ms_fnc_params_respawnDelay",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "respawn delay",
"optional": true,
"default": "60"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[10] call VN_ms_fnc_params_respawnDelay;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_respawnDelay",
"/index.php/Vn_ms_fnc_params_respawnDelay"
]
},
"vn-ms-fnc-params-respawntickets": {
"title": "Vn ms fnc params respawnTickets",
"callable": "vn_ms_fnc_params_respawnTickets",
"slug": "vn-ms-fnc-params-respawntickets",
"description": "Handles VN Respawn tickets parameter.",
"syntax": "[_respawnTickets] call vn_ms_fnc_params_respawnTickets;",
"params": [
{
"name": "_respawnTickets",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "Amount of respawn tickets for player, -1 equals unlimited",
"optional": true,
"default": "-1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_params_respawnTickets"
]
},
"vn-ms-fnc-params-stamina": {
"title": "VN ms fnc params stamina",
"callable": "VN_ms_fnc_params_stamina",
"slug": "vn-ms-fnc-params-stamina",
"description": "Sets VN stamina parameter. Reapplied on player's respawn.",
"syntax": "[parameter] call VN_ms_fnc_params_stamina",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "acts as a boolean; 0 = disabled stamina, any other value = 1 = no change",
"optional": true,
"default": "1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[0] call VN_ms_fnc_params_stamina;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_stamina",
"/index.php/Vn_ms_fnc_params_stamina"
]
},
"vn-ms-fnc-params-teleportaction": {
"title": "VN ms fnc params teleportAction",
"callable": "VN_ms_fnc_params_teleportAction",
"slug": "vn-ms-fnc-params-teleportaction",
"description": "Sets VN teleport action at duty officer parameter.",
"syntax": "[] call VN_ms_fnc_params_teleportAction",
"params": [
{
"name": "parameter",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "",
"optional": true,
"default": "1"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[0] call VN_ms_fnc_params_teleportAction;"
],
"groups": [
"params"
],
"groupLabels": [
"Mission parameters"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_params_teleportAction",
"/index.php/Vn_ms_fnc_params_teleportAction"
]
},
"vn-ms-fnc-persistentplayergroups": {
"title": "VN ms fnc persistentPlayerGroups",
"callable": "VN_ms_fnc_persistentPlayerGroups",
"slug": "vn-ms-fnc-persistentplayergroups",
"description": "Prevents player groups from being deleted when the last group player unit disconnects from the server.",
"syntax": "[] call VN_ms_fnc_persistentPlayerGroups",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[] call VN_ms_fnc_persistentPlayerGroups"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": true,
"aliases": [
"/index.php/VN_ms_fnc_persistentPlayerGroups",
"/index.php/Vn_ms_fnc_persistentPlayerGroups"
]
},
"vn-ms-fnc-preventdestruction": {
"title": "Vn ms fnc preventDestruction",
"callable": "vn_ms_fnc_preventDestruction",
"slug": "vn-ms-fnc-preventdestruction",
"description": "Adds event handler preventing destruction of the vehicle. Works only if vehicle is local to executing machine.\nId of the EH is stored in vn_preventDamageEh variable on the object.\nIf variable \"vn_amplifyWheelDamage\" is set to true on the vehicle object the damage done to wheels will be highly amplified.",
"syntax": "[_object] call vn_ms_fnc_preventDestruction;",
"params": [
{
"name": "_object",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object to prevent destruction of.",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "HandleDamage EH ID"
},
"examples": [
"[this] call vn_ms_fnc_preventDestruction"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_preventDestruction",
"/index.php/VN_ms_fnc_preventDestruction"
]
},
"vn-ms-fnc-respawn-addgroup": {
"title": "VN ms fnc respawn addGroup",
"callable": "VN_ms_fnc_respawn_addGroup",
"slug": "vn-ms-fnc-respawn-addgroup",
"description": "Initializes group respawn on group.",
"syntax": "[respawnGroup, respawningGroup] call VN_ms_fnc_respawn_addGroup",
"params": [
{
"name": "respawnGroup",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "group on which respawn will happen",
"optional": false,
"default": ""
},
{
"name": "respawningGroup",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "group to respawn - if not provided, will be *respawnGroup*",
"optional": true,
"default": "grpNull"
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "format [target, id], respawn position output data - see [BIS_fnc_addRespawnPosition](https://community.bistudio.com/wiki/BIS_fnc_addRespawnPosition)"
},
"examples": [
"[sogGroup] call VN_ms_fnc_respawn_addGroup;"
],
"groups": [
"respawn"
],
"groupLabels": [
"Respawn (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_respawn_addGroup",
"/index.php/Vn_ms_fnc_respawn_addGroup"
]
},
"vn-ms-fnc-respawn-addsaveaction": {
"title": "VN ms fnc respawn addSaveAction",
"callable": "VN_ms_fnc_respawn_addSaveAction",
"slug": "vn-ms-fnc-respawn-addsaveaction",
"description": "Adds action to save the current loadout of the action caller as respawn loadout. Uses VN_ms_fnc_respawn_saveLoadout.",
"syntax": "[savingObject] call VN_ms_fnc_respawn_addSaveAction",
"params": [
{
"name": "savingObject",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "object that will receive the save loadout action",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[sogCrate] call VN_ms_fnc_respawn_addSaveAction;"
],
"groups": [
"respawn"
],
"groupLabels": [
"Respawn (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_respawn_addSaveAction",
"/index.php/Vn_ms_fnc_respawn_addSaveAction"
]
},
"vn-ms-fnc-respawn-handlejip": {
"title": "VN ms fnc respawn handleJIP",
"callable": "VN_ms_fnc_respawn_handleJIP",
"slug": "vn-ms-fnc-respawn-handlejip",
"description": "Triggers a player respawn if `vn_mission_jipRespawn` is defined.",
"syntax": "[] call VN_ms_fnc_respawn_handleJIP",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[] call VN_ms_fnc_respawn_handleJIP;"
],
"groups": [
"respawn"
],
"groupLabels": [
"Respawn (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_respawn_handleJIP",
"/index.php/Vn_ms_fnc_respawn_handleJIP"
]
},
"vn-ms-fnc-respawn-saveloadout": {
"title": "VN ms fnc respawn saveLoadout",
"callable": "VN_ms_fnc_respawn_saveLoadout",
"slug": "vn-ms-fnc-respawn-saveloadout",
"description": "Saves respawn loadout and makes it persistent.",
"syntax": "[unit, debugHint] call VN_ms_fnc_respawn_saveLoadout",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unit to save loadout",
"optional": true,
"default": "player"
},
{
"name": "debugHint",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "debug hint about loadout being saved",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[player, false] call VN_ms_fnc_respawn_saveLoadout;"
],
"groups": [
"respawn"
],
"groupLabels": [
"Respawn (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "local",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_respawn_saveLoadout",
"/index.php/Vn_ms_fnc_respawn_saveLoadout"
]
},
"vn-ms-fnc-sfx-playradioconv": {
"title": "Vn ms fnc sfx playRadioConv",
"callable": "vn_ms_fnc_sfx_playRadioConv",
"slug": "vn-ms-fnc-sfx-playradioconv",
"description": "Plays the given radio message via text and audio from the given entity.",
"syntax": "[\n _text,\n _sound,\n _entity,\n _global,\n _isRadio,\n _diaryEntry\n] call vn_ms_fnc_sfx_playRadioConv;",
"params": [
{
"name": "_text",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Localization key for text",
"optional": true,
"default": "\"\""
},
{
"name": "_sound",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Configname of the audio message",
"optional": true,
"default": "\"\""
},
{
"name": "_entity",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Entity to play the message from",
"optional": true,
"default": "objNull"
},
{
"name": "_global",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Switch to use global channel instead of side channel",
"optional": true,
"default": "false"
},
{
"name": "_isRadio",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Switch to either play it via radio or sound",
"optional": true,
"default": "true"
},
{
"name": "_diaryEntry",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Should message be added to the diary/conversation log",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [],
"groups": [
"sfx"
],
"groupLabels": [
"Effects (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_sfx_playRadioConv",
"/index.php/VN_ms_fnc_sfx_playRadioConv"
]
},
"vn-ms-fnc-sfx-radiohint": {
"title": "VN ms fnc sfx radioHint",
"callable": "VN_ms_fnc_sfx_radioHint",
"slug": "vn-ms-fnc-sfx-radiohint",
"description": "Plays given radio hint to given group. Requires a hint entity in the mission. Uses VN_ms_fnc_sfx_playRadioConv.",
"syntax": "[missionId, hintId, group] call VN_ms_fnc_sfx_radioHint",
"params": [
{
"name": "missionId",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "mission number",
"optional": false,
"default": ""
},
{
"name": "hintId",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "hint identifier",
"optional": false,
"default": ""
},
{
"name": "group",
"type": "Group or Array",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group) or [Array](https://community.bistudio.com/wiki/Array)",
"description": "the group to receive the hint",
"optional": true,
"default": "grpNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[\"01\", \"05\", sogGroup] call VN_ms_fnc_sfx_radioHint;"
],
"groups": [
"sfx"
],
"groupLabels": [
"Effects (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_sfx_radioHint",
"/index.php/Vn_ms_fnc_sfx_radioHint"
]
},
"vn-ms-fnc-sfx-typetext": {
"title": "Vn ms fnc sfx typeText",
"callable": "vn_ms_fnc_sfx_typeText",
"slug": "vn-ms-fnc-sfx-typetext",
"description": "Types a structured text on the screen, letter by letter.",
"syntax": "[_lines,_posX,_posY,_rootFormat] call vn_ms_fnc_sfx_typeText;",
"params": [
{
"name": "_lines",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "Multidimensional array of lines to write",
"optional": true,
"default": "[]"
},
{
"name": "_posX",
"type": "Number, Array",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number), [Array](https://community.bistudio.com/wiki/Array)",
"description": "Display position X, or X and W if an array",
"optional": true,
"default": "0"
},
{
"name": "_posY",
"type": "Number, Array",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number), [Array](https://community.bistudio.com/wiki/Array)",
"description": "Display position Y, or Y and H if an array",
"optional": true,
"default": "0"
},
{
"name": "_rootFormat",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Default structured text wrapper template around each line",
"optional": true,
"default": "\"%1\""
}
],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": "Script handle to typing text"
},
"examples": [
"[\n [\n [\"Operation: \", \"%1\"],\n [\"Eldest Son\"],\n [\"12th May 1969. 1600h\"],\n [\"SOG CCN, FOB 1, Phu Bai, South Vietnam\"],\n [\" \"],\n [\"Target AO: \", \"%1\"],\n [\"Whiskey 4\"]\n ]\n] spawn vn_ms_fnc_sfx_typeText;"
],
"groups": [
"sfx"
],
"groupLabels": [
"Effects (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_sfx_typeText"
]
},
"vn-ms-fnc-sfx-wakeup": {
"title": "VN ms fnc sfx wakeUp",
"callable": "VN_ms_fnc_sfx_wakeUp",
"slug": "vn-ms-fnc-sfx-wakeup",
"description": "Creates wakeup overlay effect.",
"syntax": "[] call VN_ms_fnc_sfx_wakeUp",
"params": [],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": ""
},
"examples": [
"[] call VN_ms_fnc_sfx_wakeUp;"
],
"groups": [
"sfx"
],
"groupLabels": [
"Effects (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "local",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_sfx_wakeUp",
"/index.php/Vn_ms_fnc_sfx_wakeUp"
]
},
"vn-ms-fnc-spawnambheli": {
"title": "VN ms fnc spawnAmbHeli",
"callable": "VN_ms_fnc_spawnAmbHeli",
"slug": "vn-ms-fnc-spawnambheli",
"description": "Spawn a helicopter (50m) in the air near a given position and let it fly away (towards [0,0,0]). The helicopter and its crew get deleted when 2000m away from their spawn position.",
"syntax": "[heliClass, pos] call VN_ms_fnc_spawnAmbHeli",
"params": [
{
"name": "heliClass",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "helicopter's classname",
"optional": false,
"default": ""
},
{
"name": "pos",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "spawn position",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[\"VN_B_air_UH1D_01_02\", getPos player] call VN_ms_fnc_spawnAmbHeli;"
],
"groups": [
"general"
],
"groupLabels": [
"General (mission system)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_spawnAmbHeli",
"/index.php/Vn_ms_fnc_spawnAmbHeli"
]
},
"vn-ms-fnc-spectator-enableclient": {
"title": "Vn ms fnc spectator enableClient",
"callable": "vn_ms_fnc_spectator_enableClient",
"slug": "vn-ms-fnc-spectator-enableclient",
"description": "Enable specatator and move player to spectator group.",
"syntax": "[_spectatorGroup] call vn_ms_fnc_spectator_enableClient;",
"params": [
{
"name": "_spectatorGroup",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "Spectator group to move player to",
"optional": true,
"default": "grpNull"
}
],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": "Specator enable script"
},
"examples": [
"[spectatorGroup] call vn_ms_fnc_spectator_enableClient"
],
"groups": [
"spectator"
],
"groupLabels": [
"Spectator"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_spectator_enableClient"
]
},
"vn-ms-fnc-spectator-enableserver": {
"title": "Vn ms fnc spectator enableServer",
"callable": "vn_ms_fnc_spectator_enableServer",
"slug": "vn-ms-fnc-spectator-enableserver",
"description": "Force target player into spectator.",
"syntax": "[_player] call vn_ms_fnc_spectator_enableServer;",
"params": [
{
"name": "_player",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Player to move into specatator",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "Spectators group"
},
"examples": [
"[player] call vn_ms_fnc_spectator_enableServer"
],
"groups": [
"spectator"
],
"groupLabels": [
"Spectator"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_spectator_enableServer"
]
},
"vn-ms-fnc-tracker-attackarea": {
"title": "VN ms fnc tracker attackArea",
"callable": "VN_ms_fnc_tracker_attackArea",
"slug": "vn-ms-fnc-tracker-attackarea",
"description": "Spawn waves attacking an area. Uses VN_ms_fnc_tracker_positionVisible, VN_ms_fnc_tracker_getHiddenPos and VN_ms_fnc_tracker_spawnGroup.",
"syntax": "[\n destination,\n posOrRadius,\n wavesCount,\n delay,\n condition,\n ao,\n side,\n groupSpawnCode,\n wpRadius,\n wpCompletion\n] call VN_ms_fnc_tracker_attackArea",
"params": [
{
"name": "destination",
"type": "Position",
"typeMarkdown": "[Position](https://community.bistudio.com/wiki/Position)",
"description": "attacked position",
"optional": false,
"default": ""
},
{
"name": "posOrRadius",
"type": "Array or Number",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) or [Number](https://community.bistudio.com/wiki/Number)",
"description": "attackers spawn position(s) or radius around *destination*",
"optional": true,
"default": "200"
},
{
"name": "wavesCount",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "amount of enemy waves",
"optional": true,
"default": "10"
},
{
"name": "delay",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "delay between waves - not a \"cooldown between waves\" but delay between spawning: previous wave dead or not",
"optional": true,
"default": "45"
},
{
"name": "condition",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "spawn condition code",
"optional": true,
"default": "{ true }"
},
{
"name": "ao",
"type": "String or Array",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String) or [Array](https://community.bistudio.com/wiki/Array)",
"description": "if provided, 50% chances of the spawned group to be of \"Avalanche\" kind (track enemy until killed)",
"optional": true,
"default": "\"\""
},
{
"name": "side",
"type": "Side",
"typeMarkdown": "[Side](https://community.bistudio.com/wiki/Side)",
"description": "waves side",
"optional": true,
"default": "east"
},
{
"name": "groupSpawnCode",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "code to be executed on each spawned groups (passed as `_this`)",
"optional": true,
"default": "{}"
},
{
"name": "wpRadius",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "attack waypoint completion radius",
"optional": true,
"default": "20"
},
{
"name": "wpCompletion",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "attack waypoint statement - if ommited, default Tracker/Avalanche behaviour is applied on completion (track enemy until killed)",
"optional": true,
"default": "nil"
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "spawned groups"
},
"examples": [
"[markerPos \"sog_base\", 150, 3, 15] call VN_ms_fnc_tracker_attackArea;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_attackArea",
"/index.php/Vn_ms_fnc_tracker_attackArea"
]
},
"vn-ms-fnc-tracker-getaoplayers": {
"title": "VN ms fnc tracker getAOPlayers",
"callable": "VN_ms_fnc_tracker_getAOPlayers",
"slug": "vn-ms-fnc-tracker-getaoplayers",
"description": "Gets players in a AO that are valid targets (alive and on foot).",
"syntax": "[area] call VN_ms_fnc_tracker_getAOPlayers",
"params": [
{
"name": "area",
"type": "String or Array",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String) or [Array](https://community.bistudio.com/wiki/Array)",
"description": "marker name or array format [center, a, b, angle*(, isRectangle, c)*] - see [inAreaArray](https://community.bistudio.com/wiki/inAreaArray#Syntax_2) syntax",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "returned players"
},
"examples": [
"[\"area\"] call VN_ms_fnc_tracker_getAOPlayers;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_getAOPlayers",
"/index.php/Vn_ms_fnc_tracker_getAOPlayers"
]
},
"vn-ms-fnc-tracker-gethiddenpos": {
"title": "VN ms fnc tracker getHiddenPos",
"callable": "VN_ms_fnc_tracker_getHiddenPos",
"slug": "vn-ms-fnc-tracker-gethiddenpos",
"description": "Search for hidden postion around target position.",
"syntax": "[pos, minDistance] call VN_ms_fnc_tracker_getHiddenPos",
"params": [
{
"name": "pos",
"type": "String or Position or Object",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String) or [Position](https://community.bistudio.com/wiki/Position) or [Object](https://community.bistudio.com/wiki/Object)",
"description": "target position",
"optional": false,
"default": ""
},
{
"name": "minDistance",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "distance from *pos*",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Position",
"typeMarkdown": "[Position](https://community.bistudio.com/wiki/Position)",
"description": "found position"
},
"examples": [
"[getPos player, 150] call VN_ms_fnc_tracker_getHiddenPos;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_getHiddenPos",
"/index.php/Vn_ms_fnc_tracker_getHiddenPos"
]
},
"vn-ms-fnc-tracker-getspiralpositions": {
"title": "VN ms fnc tracker getSpiralPositions",
"callable": "VN_ms_fnc_tracker_getSpiralPositions",
"slug": "vn-ms-fnc-tracker-getspiralpositions",
"description": "Get positions in spiral with given radius. Useful for patrols.\n\n```sqf\nparams [\n [\"_center\", getPos player, [[], objNull], 3],\n [\"_radius\", 500, [0]],\n [\"_steps\", 8, [0]],\n [\"_precision\", [0.3, 0.8, 1], [[]], 3],\n [\"_clockwise\", selectRandom [true, false], [false]]\n];\n```",
"syntax": "[\n centre,\n radius,\n steps,\n precision,\n clockwise\n] call VN_ms_fnc_tracker_getSpiralPositions",
"params": [
{
"name": "centre",
"type": "Object or Position",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object) or [Position](https://community.bistudio.com/wiki/Position)",
"description": "spiral centre",
"optional": true,
"default": "getPos player"
},
{
"name": "radius",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "spiral radius",
"optional": true,
"default": "500"
},
{
"name": "steps",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "steps per spiral (360° ÷ *steps*)",
"optional": true,
"default": "8"
},
{
"name": "precision",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "radius precision, 3-elements number array",
"optional": true,
"default": "[0.3, 0.8, 1]"
},
{
"name": "clockwise",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "spiral direction, true for clockwise, false for counter-clockwise",
"optional": true,
"default": "selectRandom [true, false]"
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "positions"
},
"examples": [
"private _spiralPositions = [nil, 100, 36, [0,0.25, 0.5], true] call VN_ms_fnc_tracker_getSpiralPositions;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_getSpiralPositions",
"/index.php/Vn_ms_fnc_tracker_getSpiralPositions"
]
},
"vn-ms-fnc-tracker-onplayerfired": {
"title": "Vn ms fnc tracker onPlayerFired",
"callable": "vn_ms_fnc_tracker_onPlayerFired",
"slug": "vn-ms-fnc-tracker-onplayerfired",
"description": "Handles fired event to notify patrolling units etc.",
"syntax": "[\n _unit,\n _weapon,\n _muzzle,\n _mode,\n _ammo,\n _magazine,\n _projectile,\n _gunner\n] call vn_ms_fnc_tracker_onPlayerFired;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object the event handler is assigned to",
"optional": false,
"default": ""
},
{
"name": "_weapon",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Fired weapon",
"optional": false,
"default": ""
},
{
"name": "_muzzle",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Muzzle that was used",
"optional": false,
"default": ""
},
{
"name": "_mode",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Current mode of the fired weapon",
"optional": false,
"default": ""
},
{
"name": "_ammo",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "Ammo used",
"optional": false,
"default": ""
},
{
"name": "_magazine",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "magazine name which was used",
"optional": false,
"default": ""
},
{
"name": "_projectile",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Object of the projectile that was shot out",
"optional": false,
"default": ""
},
{
"name": "_gunner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Gunner whose weapons are firing",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_tracker_onPlayerFired",
"/index.php/VN_ms_fnc_tracker_onPlayerFired"
]
},
"vn-ms-fnc-tracker-overlord-getgroups": {
"title": "VN ms fnc tracker overlord getGroups",
"callable": "VN_ms_fnc_tracker_overlord_getGroups",
"slug": "vn-ms-fnc-tracker-overlord-getgroups",
"description": "Get groups array from Overlord FSM.",
"syntax": "[fsmId] call VN_ms_fnc_tracker_overlord_getGroups",
"params": [
{
"name": "fsmId",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "array with Overlord FSM groups where index is alert level, last element contains all groups"
},
"examples": [
"private _alertedGroups = [1] call VN_ms_fnc_tracker_overlord_getGroups;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_overlord_getGroups",
"/index.php/Vn_ms_fnc_tracker_overlord_getGroups"
]
},
"vn-ms-fnc-tracker-overlord-init": {
"title": "VN ms fnc tracker overlord init",
"callable": "VN_ms_fnc_tracker_overlord_init",
"slug": "vn-ms-fnc-tracker-overlord-init",
"description": "Initializes Overlord on an area.",
"syntax": "[ao, enemySide, spawnCondition, alertLevel] call VN_ms_fnc_tracker_overlord_init",
"params": [
{
"name": "ao",
"type": "String or Array",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String) or [Array](https://community.bistudio.com/wiki/Array)",
"description": "marker name or array format [center, a, b, angle*(, isRectangle, c)*] - see [inAreaArray](https://community.bistudio.com/wiki/inAreaArray#Syntax_2) syntax",
"optional": false,
"default": ""
},
{
"name": "enemySide",
"type": "Side",
"typeMarkdown": "[Side](https://community.bistudio.com/wiki/Side)",
"description": "side of groups spawned by Overlord",
"optional": true,
"default": "east"
},
{
"name": "spawnCondition",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "condition checked before groups are spawned",
"optional": true,
"default": "{ true }"
},
{
"name": "alertLevel",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "starting alert value for Overlord",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "FSM id"
},
"examples": [
"[[getPos leader sogGroup, 500, 500, 0], east, { allPlayers findIf { alive _x } != -1 }, 2] call VN_ms_fnc_tracker_overlord_init;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_overlord_init",
"/index.php/Vn_ms_fnc_tracker_overlord_init"
]
},
"vn-ms-fnc-tracker-positionvalid": {
"title": "VN ms fnc tracker positionValid",
"callable": "VN_ms_fnc_tracker_positionValid",
"slug": "vn-ms-fnc-tracker-positionvalid",
"description": "Checks if position is valid for AI group spawn.",
"syntax": "[area, pos, targets] call VN_ms_fnc_tracker_positionValid",
"params": [
{
"name": "area",
"type": "String or Array",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String) or [Array](https://community.bistudio.com/wiki/Array)",
"description": "marker name or array format [center, a, b, angle*(, isRectangle, c)*] - see [inAreaArray](https://community.bistudio.com/wiki/inAreaArray#Syntax_2) syntax",
"optional": false,
"default": ""
},
{
"name": "pos",
"type": "Position",
"typeMarkdown": "[Position](https://community.bistudio.com/wiki/Position)",
"description": "wanted spawning position",
"optional": false,
"default": ""
},
{
"name": "targets",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "units that should not see the group spawning",
"optional": true,
"default": "[]"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": ""
},
"examples": [
"[\"enemy_respawn_area\", player modelToWorld [0,100,0], units group player] call VN_ms_fnc_tracker_positionValid;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_positionValid",
"/index.php/Vn_ms_fnc_tracker_positionValid"
]
},
"vn-ms-fnc-tracker-positionvisible": {
"title": "VN ms fnc tracker positionVisible",
"callable": "VN_ms_fnc_tracker_positionVisible",
"slug": "vn-ms-fnc-tracker-positionvisible",
"description": "Checks if position is visible for any of unit in group.",
"syntax": "[units, pos] call VN_ms_fnc_tracker_positionVisible",
"params": [
{
"name": "units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "units to check",
"optional": false,
"default": ""
},
{
"name": "pos",
"type": "PositionASL",
"typeMarkdown": "[PositionASL](https://community.bistudio.com/wiki/PositionASL)",
"description": "position to check",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "the position is visible by one of the units"
},
"examples": [
"[units sogGroup, getPosASL crashSite] call VN_ms_fnc_tracker_positionVisible;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_positionVisible",
"/index.php/Vn_ms_fnc_tracker_positionVisible"
]
},
"vn-ms-fnc-tracker-preinit": {
"title": "VN ms fnc tracker preInit",
"callable": "VN_ms_fnc_tracker_preInit",
"slug": "vn-ms-fnc-tracker-preinit",
"description": "Tracker system preInit. Uses VN_ms_fnc_tracker_tracksCreate and VN_ms_fnc_tracker_receiveNoise.",
"syntax": "[] call VN_ms_fnc_tracker_preInit",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[] call VN_ms_fnc_tracker_preInit;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_preInit",
"/index.php/Vn_ms_fnc_tracker_preInit"
]
},
"vn-ms-fnc-tracker-receivenoise": {
"title": "VN ms fnc tracker receiveNoise",
"callable": "VN_ms_fnc_tracker_receiveNoise",
"slug": "vn-ms-fnc-tracker-receivenoise",
"description": "Handle client generated noise - slightly (0.01) reveals the shooter to surrounding units, friends or foes.",
"syntax": "[unit, distance] call VN_ms_fnc_tracker_receiveNoise",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the unit that made a noise",
"optional": false,
"default": ""
},
{
"name": "distance",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "hearable noise distance",
"optional": true,
"default": "100"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[player, 50] call VN_ms_fnc_tracker_receiveNoise;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_receiveNoise",
"/index.php/Vn_ms_fnc_tracker_receiveNoise"
]
},
"vn-ms-fnc-tracker-spawngroup": {
"title": "VN ms fnc tracker spawnGroup",
"callable": "VN_ms_fnc_tracker_spawnGroup",
"slug": "vn-ms-fnc-tracker-spawngroup",
"description": "Spawns a group and potential vehicles based on `[configFile](https://community.bistudio.com/wiki/configFile) >> \"CfgTrackerArmies\" >> *army* >> \"alert_*alert*\"` config entry.",
"syntax": "[pos, alert, side, army] call VN_ms_fnc_tracker_spawnGroup",
"params": [
{
"name": "pos",
"type": "Position",
"typeMarkdown": "[Position](https://community.bistudio.com/wiki/Position)",
"description": "group spawn position",
"optional": false,
"default": ""
},
{
"name": "alert",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "group's alert level",
"optional": true,
"default": "0"
},
{
"name": "side",
"type": "Side",
"typeMarkdown": "[Side](https://community.bistudio.com/wiki/Side)",
"description": "group's side",
"optional": true,
"default": "east"
},
{
"name": "army",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "\"army\" as defined in \"CfgTrackerArmies\"",
"optional": true,
"default": "\"VN\""
}
],
"returns": {
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "the spawned group"
},
"examples": [
"[player modelToWorld [0,250,0], 1, east, \"VN\"] call VN_ms_fnc_tracker_spawnGroup;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_spawnGroup",
"/index.php/Vn_ms_fnc_tracker_spawnGroup"
]
},
"vn-ms-fnc-tracker-stalker-airshoot": {
"title": "VN ms fnc tracker stalker airShoot",
"callable": "VN_ms_fnc_tracker_stalker_airShoot",
"slug": "vn-ms-fnc-tracker-stalker-airshoot",
"description": "Forces unit to shoot into the sky.",
"syntax": "[unit] call VN_ms_fnc_tracker_stalker_airShoot",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unit to force fire",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Script (Handle)",
"typeMarkdown": "[Script (Handle)](https://community.bistudio.com/wiki/Script_(Handle))",
"description": ""
},
"examples": [
"[bob] call VN_ms_fnc_tracker_stalker_airShoot;"
],
"groups": [
"tracker_stalker"
],
"groupLabels": [
"Tracker (stalker)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "local",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_stalker_airShoot",
"/index.php/Vn_ms_fnc_tracker_stalker_airShoot"
]
},
"vn-ms-fnc-tracker-trackscreate": {
"title": "VN ms fnc tracker tracksCreate",
"callable": "VN_ms_fnc_tracker_tracksCreate",
"slug": "vn-ms-fnc-tracker-trackscreate",
"description": "Creates tracks marker on unit position.",
"syntax": "[unit] call VN_ms_fnc_tracker_tracksCreate",
"params": [
{
"name": "unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "unit leaving tracks",
"optional": false,
"default": ""
}
],
"returns": {
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "created marker, format \"vn_tracks_*number*\""
},
"examples": [
"[player] call VN_ms_fnc_tracker_tracksCreate;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_tracksCreate",
"/index.php/Vn_ms_fnc_tracker_tracksCreate"
]
},
"vn-ms-fnc-tracker-tracksloop": {
"title": "VN ms fnc tracker tracksLoop",
"callable": "VN_ms_fnc_tracker_tracksLoop",
"slug": "vn-ms-fnc-tracker-tracksloop",
"description": "Loop that monitors player speed and periodicaly leaves tracks on his position.",
"syntax": "[] call VN_ms_fnc_tracker_tracksLoop",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[] call VN_ms_fnc_tracker_tracksLoop;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_tracker_tracksLoop",
"/index.php/Vn_ms_fnc_tracker_tracksLoop"
]
},
"vn-ms-fnc-waypoint-artillery": {
"title": "VN ms fnc waypoint artillery",
"callable": "VN_ms_fnc_waypoint_artillery",
"slug": "vn-ms-fnc-waypoint-artillery",
"description": "Tells the group to fire artillery barrage on waypoint/position.\n\nFile path for scripted waypoint: `vn\\missions_f_vietnam\\functions\\waypoint\\fn_waypoint_Artillery.sqf`\n\nUses VN_ms_fnc_waypoint_doArtilleryFire.",
"syntax": "[\n group,\n position,\n owner,\n amount,\n magazine,\n radius\n] call VN_ms_fnc_waypoint_artillery",
"params": [
{
"name": "group",
"type": "Group",
"typeMarkdown": "[Group](https://community.bistudio.com/wiki/Group)",
"description": "artillery group",
"optional": false,
"default": ""
},
{
"name": "position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "artillery strike location",
"optional": false,
"default": ""
},
{
"name": "owner",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "will wait until *owner* has its simulation enabled",
"optional": true,
"default": "leader group"
},
{
"name": "amount",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "number of rounds to be fired by *every* artillery weapon",
"optional": true,
"default": "5 + random 3"
},
{
"name": "magazine",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "magazine to fire",
"optional": true,
"default": "first found magazine"
},
{
"name": "precision",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "strike precision radius, in meter",
"optional": true,
"default": "50"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[artiGrp, getMarkerPos \"enemyBase\", objNull, 50, , 125] call VN_ms_fnc_waypoint_artillery;"
],
"groups": [
"waypoint"
],
"groupLabels": [
"Waypoints"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_waypoint_artillery",
"/index.php/Vn_ms_fnc_waypoint_artillery"
]
},
"vn-ms-fnc-waypoint-capturedriveonpath": {
"title": "Vn ms fnc waypoint captureDriveOnPath",
"callable": "vn_ms_fnc_waypoint_captureDriveOnPath",
"slug": "vn-ms-fnc-waypoint-capturedriveonpath",
"description": "No description added yet.",
"syntax": "[_unit, _speed, _interval] call vn_ms_fnc_waypoint_captureDriveOnPath;",
"params": [
{
"name": "_unit",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "",
"optional": true,
"default": "objNull"
},
{
"name": "_speed",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": true,
"default": "false"
},
{
"name": "_interval",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "",
"optional": true,
"default": "0"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [
"[vehicle player, true] call vn_ms_fnc_waypoint_captureDriveOnPath"
],
"groups": [
"waypoint"
],
"groupLabels": [
"Waypoints"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_fnc_waypoint_captureDriveOnPath"
]
},
"vn-ms-fnc-waypoint-doartilleryfire": {
"title": "VN ms fnc waypoint doArtilleryFire",
"callable": "VN_ms_fnc_waypoint_doArtilleryFire",
"slug": "vn-ms-fnc-waypoint-doartilleryfire",
"description": "Tells the artillery unit to do a (90°) cone-shaped artillery barrage.",
"syntax": "[\n vehicle,\n position,\n rounds,\n magazine,\n radius\n] call VN_ms_fnc_waypoint_doArtilleryFire",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the artillery vehicle",
"optional": false,
"default": ""
},
{
"name": "position",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "strike position",
"optional": false,
"default": ""
},
{
"name": "rounds",
"type": "",
"typeMarkdown": "",
"description": "",
"optional": true,
"default": "5 + random 3"
},
{
"name": "magazine",
"type": "",
"typeMarkdown": "",
"description": "if not provided, the first found magazine is used",
"optional": true,
"default": "\"\""
},
{
"name": "radius",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "maximum cone length",
"optional": true,
"default": "55"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[arty_1, getMarkerPos \"strike\", 10, nil, 100] call VN_ms_fnc_waypoint_doArtilleryFire;"
],
"groups": [
"waypoint"
],
"groupLabels": [
"Waypoints"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_fnc_waypoint_doArtilleryFire",
"/index.php/Vn_ms_fnc_waypoint_doArtilleryFire"
]
},
"vn-ms-module-fnc-randomsite-executorinit": {
"title": "VN ms module fnc randomSite executorInit",
"callable": "VN_ms_module_fnc_randomSite_executorInit",
"slug": "vn-ms-module-fnc-randomsite-executorinit",
"description": "Executes user code from editor on objects synced to executor module.",
"syntax": "[logic] call VN_ms_module_fnc_randomSite_executorInit",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[module] call VN_ms_module_fnc_randomSite_executorInit;"
],
"groups": [
"RandomSite"
],
"groupLabels": [
"Random sites"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_randomSite_executorInit",
"/index.php/Vn_ms_module_fnc_randomSite_executorInit"
]
},
"vn-ms-module-fnc-randomsite-selectorinit": {
"title": "VN ms module fnc randomSite selectorInit",
"callable": "VN_ms_module_fnc_randomSite_selectorInit",
"slug": "vn-ms-module-fnc-randomsite-selectorinit",
"description": "Selects random sites liked to selector module.",
"syntax": "[logic] call VN_ms_module_fnc_randomSite_selectorInit",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[module] call VN_ms_module_fnc_randomSite_selectorInit;"
],
"groups": [
"RandomSite"
],
"groupLabels": [
"Random sites"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_randomSite_selectorInit",
"/index.php/Vn_ms_module_fnc_randomSite_selectorInit"
]
},
"vn-ms-module-fnc-randomsite-sitedelete": {
"title": "VN ms module fnc randomSite siteDelete",
"callable": "VN_ms_module_fnc_randomSite_siteDelete",
"slug": "vn-ms-module-fnc-randomsite-sitedelete",
"description": "Deletes site module and its associated objects.",
"syntax": "[logic] call VN_ms_module_fnc_randomSite_siteDelete",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[module] call VN_ms_module_fnc_randomSite_siteDelete;"
],
"groups": [
"RandomSite"
],
"groupLabels": [
"Random sites"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_randomSite_siteDelete",
"/index.php/Vn_ms_module_fnc_randomSite_siteDelete"
]
},
"vn-ms-module-fnc-randomsite-siteinit": {
"title": "VN ms module fnc randomSite siteInit",
"callable": "VN_ms_module_fnc_randomSite_siteInit",
"slug": "vn-ms-module-fnc-randomsite-siteinit",
"description": "Initializes site module.",
"syntax": "[logic] call VN_ms_module_fnc_randomSite_siteInit",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[module] call VN_ms_module_fnc_randomSite_siteInit;"
],
"groups": [
"RandomSite"
],
"groupLabels": [
"Random sites"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_randomSite_siteInit",
"/index.php/Vn_ms_module_fnc_randomSite_siteInit"
]
},
"vn-ms-module-fnc-tracker-ao": {
"title": "VN ms module fnc tracker ao",
"callable": "VN_ms_module_fnc_tracker_ao",
"slug": "vn-ms-module-fnc-tracker-ao",
"description": "Tracker Area of Operations module intialisation.",
"syntax": "[logic, units, isActivated] call VN_ms_module_fnc_tracker_ao",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "units",
"type": "Array of Object",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array) of [Object](https://community.bistudio.com/wiki/Object)",
"description": "synchronised units - unused",
"optional": false,
"default": ""
},
{
"name": "isActivated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's status"
},
"examples": [
"[module, units group player, true] call VN_ms_module_fnc_tracker_ao;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_tracker_ao",
"/index.php/Vn_ms_module_fnc_tracker_ao"
]
},
"vn-ms-module-fnc-tracker-aodynamicsimtoggle": {
"title": "VN ms module fnc tracker aoDynamicSimToggle",
"callable": "VN_ms_module_fnc_tracker_aoDynamicSimToggle",
"slug": "vn-ms-module-fnc-tracker-aodynamicsimtoggle",
"description": "Toggle [dynamic simulation](https://community.bistudio.com/wiki/enableDynamicSimulation) for **existing** groups - the setting will not apply to groups spawned after execution. Uses VN_ms_module_fnc_tracker_aoGroups.",
"syntax": "[logic, enabled] call VN_ms_module_fnc_tracker_aoDynamicSimToggle",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
},
{
"name": "enabled",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "processed groups"
},
"examples": [
"[vn_ms_overlord, true] call VN_ms_module_fnc_tracker_aoDynamicSimToggle;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_tracker_aoDynamicSimToggle",
"/index.php/Vn_ms_module_fnc_tracker_aoDynamicSimToggle"
]
},
"vn-ms-module-fnc-tracker-aogroups": {
"title": "VN ms module fnc tracker aoGroups",
"callable": "VN_ms_module_fnc_tracker_aoGroups",
"slug": "vn-ms-module-fnc-tracker-aogroups",
"description": "Get groups array from Overlord AO module.",
"syntax": "[logic] call VN_ms_module_fnc_tracker_aoGroups",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "array with Overlord AO groups where index is alert level, last element contains all groups"
},
"examples": [
"[module] call VN_ms_module_fnc_tracker_aoGroups;"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_tracker_aoGroups",
"/index.php/Vn_ms_module_fnc_tracker_aoGroups"
]
},
"vn-ms-module-fnc-tracker-aoremovegroups": {
"title": "Vn ms module fnc tracker aoRemoveGroups",
"callable": "vn_ms_module_fnc_tracker_aoRemoveGroups",
"slug": "vn-ms-module-fnc-tracker-aoremovegroups",
"description": "Remove EXISTING groups managed by Tracker AO module.",
"syntax": "[_logic] call vn_ms_module_fnc_tracker_aoRemoveGroups;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "AO Module with groups to remove",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Groups were removed"
},
"examples": [
"[vn_ms_overlord] call vn_ms_module_fnc_tracker_aoRemoveGroups"
],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_module_fnc_tracker_aoRemoveGroups"
]
},
"vn-ms-module-fnc-tracker-fortification": {
"title": "Vn ms module fnc tracker fortification",
"callable": "vn_ms_module_fnc_tracker_fortification",
"slug": "vn-ms-module-fnc-tracker-fortification",
"description": "Tracker Fortification position module intialization.",
"syntax": "[_logic] call vn_ms_module_fnc_tracker_fortification;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Tracker Fortification Logic",
"optional": true,
"default": "objNull"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Logic was initialised"
},
"examples": [],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_module_fnc_tracker_fortification"
]
},
"vn-ms-module-fnc-tracker-reinforcements": {
"title": "Vn ms module fnc tracker reinforcements",
"callable": "vn_ms_module_fnc_tracker_reinforcements",
"slug": "vn-ms-module-fnc-tracker-reinforcements",
"description": "No description added yet.",
"syntax": "[_logic,_units,_activated] call vn_ms_module_fnc_tracker_reinforcements;",
"params": [
{
"name": "_logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "Tracker Reinforcements Logic",
"optional": true,
"default": "objNull"
},
{
"name": "_units",
"type": "Array",
"typeMarkdown": "[Array](https://community.bistudio.com/wiki/Array)",
"description": "List of units affected by module (NOT USED)",
"optional": true,
"default": "[]"
},
{
"name": "_activated",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Is module activated",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "Function reached the end"
},
"examples": [],
"groups": [
"tracker"
],
"groupLabels": [
"Tracker (AI spawning)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/Vn_ms_module_fnc_tracker_reinforcements"
]
},
"vn-ms-module-fnc-vehiclerespawn-add": {
"title": "VN ms module fnc vehicleRespawn add",
"callable": "VN_ms_module_fnc_vehicleRespawn_add",
"slug": "vn-ms-module-fnc-vehiclerespawn-add",
"description": "Adds a vehicle to the VN Vehicle respawn system.",
"syntax": "[\n vehicle,\n delay,\n outDistance,\n outTime,\n ifDisabled,\n notify,\n initCode,\n name\n] call VN_ms_module_fnc_vehicleRespawn_add",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle to respawn",
"optional": false,
"default": ""
},
{
"name": "delay",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "respawn delay, in seconds",
"optional": true,
"default": "30"
},
{
"name": "outDistance",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "abandon distance",
"optional": true,
"default": "1000"
},
{
"name": "outTime",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "abandon time, in seconds (0 = disabled)",
"optional": true,
"default": "0"
},
{
"name": "ifDisabled",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "respawn when vehicle is unable to move",
"optional": true,
"default": "true"
},
{
"name": "notify",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "notify player of the vehicle's respawn",
"optional": false,
"default": ""
},
{
"name": "initCode",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "code to be executed upon respawn. Arguments: `params [\"_oldVehicle\", \"_newVehicle\"];`",
"optional": true,
"default": "{}"
},
{
"name": "name",
"type": "String",
"typeMarkdown": "[String](https://community.bistudio.com/wiki/String)",
"description": "name used in respawn notification",
"optional": true,
"default": "\"\""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[sogJeep, 10, 500, 300, true, true, {}, \"The Great™ Jeep\"] call VN_ms_module_fnc_vehicleRespawn_add;"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": true,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_add",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_add"
]
},
"vn-ms-module-fnc-vehiclerespawn-init": {
"title": "VN ms module fnc vehicleRespawn init",
"callable": "VN_ms_module_fnc_vehicleRespawn_init",
"slug": "vn-ms-module-fnc-vehiclerespawn-init",
"description": "Initialises synchronised vehicles respawn. Uses VN_ms_module_fnc_vehicleRespawn_add.",
"syntax": "[logic] call VN_ms_module_fnc_vehicleRespawn_init",
"params": [
{
"name": "logic",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the module logic",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[module] call VN_ms_module_fnc_vehicleRespawn_add;"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_init",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_init"
]
},
"vn-ms-module-fnc-vehiclerespawn-isabandoned": {
"title": "VN ms module fnc vehicleRespawn isAbandoned",
"callable": "VN_ms_module_fnc_vehicleRespawn_isAbandoned",
"slug": "vn-ms-module-fnc-vehiclerespawn-isabandoned",
"description": "Checks if vehicle is abandoned.",
"syntax": "[\n vehicle,\n distance,\n disabledCounts\n] call VN_ms_module_fnc_vehicleRespawn_isAbandoned",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle to check",
"optional": false,
"default": ""
},
{
"name": "distance",
"type": "Number",
"typeMarkdown": "[Number](https://community.bistudio.com/wiki/Number)",
"description": "distance to check",
"optional": true,
"default": "1000"
},
{
"name": "disabledCounts",
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "should immobilized vehicles count as abandoned",
"optional": true,
"default": "true"
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "is the vehicle abandoned"
},
"examples": [
"[sogJeep, 500, true] call VN_ms_module_fnc_vehicleRespawn_isAbandoned;"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_isAbandoned",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_isAbandoned"
]
},
"vn-ms-module-fnc-vehiclerespawn-loop": {
"title": "VN ms module fnc vehicleRespawn loop",
"callable": "VN_ms_module_fnc_vehicleRespawn_loop",
"slug": "vn-ms-module-fnc-vehiclerespawn-loop",
"description": "Starts vehicle respawn loop.",
"syntax": "[] call VN_ms_module_fnc_vehicleRespawn_loop",
"params": [],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[] call VN_ms_module_fnc_vehicleRespawn_loop;"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "",
"effectsLocality": "",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_loop",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_loop"
]
},
"vn-ms-module-fnc-vehiclerespawn-notify": {
"title": "VN ms module fnc vehicleRespawn notify",
"callable": "VN_ms_module_fnc_vehicleRespawn_notify",
"slug": "vn-ms-module-fnc-vehiclerespawn-notify",
"description": "Sends a notification to everyone about vehicle's respawn.",
"syntax": "[vehicle] call VN_ms_module_fnc_vehicleRespawn_notify",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle respawned",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[sogJeep] call VN_ms_module_fnc_vehicleRespawn_notify;"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_notify",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_notify"
]
},
"vn-ms-module-fnc-vehiclerespawn-remove": {
"title": "VN ms module fnc vehicleRespawn remove",
"callable": "VN_ms_module_fnc_vehicleRespawn_remove",
"slug": "vn-ms-module-fnc-vehiclerespawn-remove",
"description": "Removes vehicle from VN Vehicle respawn system.",
"syntax": "[vehicle] call VN_ms_module_fnc_vehicleRespawn_remove",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle to remove from respawn",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Nothing",
"typeMarkdown": "[Nothing](https://community.bistudio.com/wiki/Nothing)",
"description": ""
},
"examples": [
"[sogJeep] call VN_ms_module_fnc_vehicleRespawn_remove;"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": true,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_remove",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_remove"
]
},
"vn-ms-module-fnc-vehiclerespawn-replacewreck": {
"title": "VN ms module fnc vehicleRespawn replaceWreck",
"callable": "VN_ms_module_fnc_vehicleRespawn_replaceWreck",
"slug": "vn-ms-module-fnc-vehiclerespawn-replacewreck",
"description": "Replaces wreck with a new object (in order to prevent interferences/issues with BIS respawn).",
"syntax": "[wreck] call VN_ms_module_fnc_vehicleRespawn_replaceWreck",
"params": [
{
"name": "wreck",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "wreck to be replaced",
"optional": false,
"default": ""
}
],
"returns": {
"type": "Boolean",
"typeMarkdown": "[Boolean](https://community.bistudio.com/wiki/Boolean)",
"description": "function's success"
},
"examples": [
"[destroyedSogJeep] call VN_ms_module_fnc_vehicleRespawn_replaceWreck"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_replaceWreck",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_replaceWreck"
]
},
"vn-ms-module-fnc-vehiclerespawn-respawn": {
"title": "VN ms module fnc vehicleRespawn respawn",
"callable": "VN_ms_module_fnc_vehicleRespawn_respawn",
"slug": "vn-ms-module-fnc-vehiclerespawn-respawn",
"description": "Respawns given vehicle.",
"syntax": "[vehicle, initCode] call VN_ms_module_fnc_vehicleRespawn_respawn",
"params": [
{
"name": "vehicle",
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "vehicle to respawn",
"optional": false,
"default": ""
},
{
"name": "initCode",
"type": "Code",
"typeMarkdown": "[Code](https://community.bistudio.com/wiki/Code)",
"description": "code to execute upon vehicle respawn",
"optional": true,
"default": "{}"
}
],
"returns": {
"type": "Object",
"typeMarkdown": "[Object](https://community.bistudio.com/wiki/Object)",
"description": "the new vehicle"
},
"examples": [
"[sogJeep, { hint \"respawned!\"; }] call VN_ms_module_fnc_vehicleRespawn_respawn;"
],
"groups": [
"VehicleRespawn"
],
"groupLabels": [
"Respawn (vehicles)"
],
"version": "1.00",
"author": "Wyqer, veteran29",
"argumentsLocality": "global",
"effectsLocality": "global",
"serverOnly": false,
"aliases": [
"/index.php/VN_ms_module_fnc_vehicleRespawn_respawn",
"/index.php/Vn_ms_module_fnc_vehicleRespawn_respawn"
]
}
}