Category:VBS: Scripting Commands by Functionality

From BISim Wiki
Jump to: navigation, search

Contents

Introduction

This page has been created to help you find the appropriate commands when you are dealing with specific scripting situations (e.g. all commands that have to do with triggers, or to control unit behaviour, etc.).

To make locating commands easier, some of them may appear in more than one category.

Note that the lists contain scripting functions, as well as scripting commands.
Functions can be identified by the prefix fn_vbs_, and require a special syntax. See the page on Scripting Functions for more info.

Categories

AAR

After Action Review
(e.g. AARplay, VBS_addEvent)

AAR

Activators

Triggers, actions and event handlers
(e.g. addEventHandler, createTrigger, addAction)

Cameras

Camera control for cut-scenes
(e.g. camCreate, camSetPos)

Configs

Config files and classes
(e.g. inheritsFrom, getText)

Debug

Optimize & debug scripts
(e.g. diag_fps, debugLog)

Debug

Editor

Real-Time Editor.
(e.g. editObject, getValue)

Editor

Groups

Groups, formations & sides
(e.g. formation, group, units)

Groups

Intel

Environmental & mission information
(e.g. setFog, setRain)

Intel

Interactions

Messages, dialogs, user-input & sounds
(e.g. hint, titleText, isKeyActive)

Locations

Set, modify & use locations
(e.g. createLocation, nearestLocation, setSize)

Markers

Set, modify & use markers
(e.g. createMarker, getMarkerType, setMarkerPos)

Objects

Units, vehicles & objects
(e.g. alive, combatMode, fuel, buildingPos)

Program Flow

Scripts execution & flow control
(e.g. exec, do, forEach, goto)

Flow

System

Commands that affect the whole game
(e.g. benchmark, loadFile, saveGame, diag_client)

System

Variables

Formatting & converting variables
(e.g. format, count, isNull, select)

Waypoints

Set, modify & use waypoints
(e.g. addWaypoint, deleteWaypoint)

Weapons

Weapons, turrets & shots
(e.g. addMagazine, ammo, weapons)

(Pending)

These commands have either not been verified for VBS2 compatibility, or haven't been put into the appropriate category yet.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox