Page MenuHomeFeedback Tracker

Scripting Help: Incorrect or missing command descriptions
New, NormalPublic

Description

Command: activatedAddons
Description (old): -
Description (new): Returns a list of all activated addons.

Command: addMagazineAmmoCargo
Example (old): rearmTruckOne AddMagazineAmmoCargo ["M16", 2,12]
Example (new): rearmTruckOne addMagazineAmmoCargo ["LMG_Mk200_F", 2,12]

Command: allowDamage
Description (old): Obsolete.
Description (new): Allow or prevent an object being damaged (or injured, or killed). The command does not prevent object from taking scripted damage such as setHit, setHitIndex, setHitPointDamage or setDamage.
Example (old): -
Example (new): player allowDamage false

Command: allowDammage
Description (old): Obsolete.
Description (new): Allow or prevent an object being damaged (or injured, or killed). The command does not prevent object from taking scripted damage such as setHit, setHitIndex, setHitPointDamage or setDamage.
Example (old): -
Example (new): player allowDamage false

Command: allowFileOperations
Description (old): Allow/dissallow file ops (load/save etc).
Description (new): Allow/disallow file operations like loading and saving.

Command: assignedTeam
Description (old): Checks which team does the vehicle (its commander unit) belong to.
Description (new): Checks which team the vehicle (its commander unit) belongs to.

Command: buldozer_EnableRoadDiag
Description (old): -
Description (new): Enables road diagnostics in buldozer.

Command: buldozer_IsEnabledRoadDiag
Description (old): Is enabled road diag in buldozer?
Description (new): Returns true if road diag is enabled in buldozer.

Command: buldozer_LoadNewRoads
Description (old): -
Description (new): Generates new roads. (From biki)

Command: setForceGeneratorRTD (Not documented on the biki and no ingame description)
Description (old): -
Description (new): ???

Command: setObjectMaterial
Description (old): -
Description (new): Sets material of object selection. The selection number is defined through the hiddenselection[]={} array in the vehicle's config (starting with 0). (From biki)

Command: setObjectTexture
Description (old): -
Description (new): Textures object selection with texture named in array. (From biki)

Command: setParticleFire
Description (old): -
Description (new): Set fire parameters to particle effect. Note: You need to create emitter at first. (From biki)

Command: setRotorBrakeRTD
Description (old): -
Description (new): Toggle a helicopter's rotor brake on or off. (From biki)

Command: pushBack
Description (old): Add and element into the end of a given array.
Description (new): Adds an element to the end of a given array.
Example (old): array push_back "Hello"
Example (new): _array = [1,2,3]; _array pushBack 4; hint str _array; //[1,2,3,4]

  1. The commands allDead and allDeadMen have a comma at the end of their description which should be removed.
  2. isIRLaserOn command has the description placed in the example section
  3. All safeZone command are missing their description
    1. safeZoneH
    2. safeZoneW
    3. safeZoneWAbs
    4. safeZoneX
    5. safeZoneXAbs
    6. safeZoneY

Details

Severity
Tweak
Resolution
Open
Reproducibility
Always
Operating System
Windows 10 x64
Category
Scripting
Steps To Reproduce

This list is far from complete. I merely listed the most obvious ones!

If anyone wants to contribute feel free to add your suggestions. Make sure to keep the descriptions and examples compact!

A full list of all commands, their description and examples can be found here (Requires Excel)

https://1drv.ms/x/s!AvgETyKiA6bQlflAnR1hXWLs3SQmRA?e=v76CP9

Additional Information
  • The navigate back button in the GUI has no text. The forward button shows ">".

Event Timeline

R3vo created this task.Dec 11 2020, 10:45 AM
R3vo updated the task description. (Show Details)
R3vo edited Steps To Reproduce. (Show Details)Dec 11 2020, 10:48 AM
R3vo edited Additional Information. (Show Details)Dec 11 2020, 11:57 AM

I think this is wrong too:

createSimpleObject [shapeName / className, position [,local]]

also wrong: forEach. Example shows string as the "command", which should be code.

should be tweaked in 147141

BIS_fnc_KK removed BIS_fnc_KK as the assignee of this task.Thu, Jan 21, 11:37 AM
BIS_fnc_KK added a subscriber: BIS_fnc_KK.