Modme Wiki

https://wiki.modme.co
Admin
An open-source community-driven game modding wiki with guides for Black Ops 1, Black Ops 3, World at...
Tokens:109,726
Snippets:879
Trust Score:6.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### For Loop Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

This example demonstrates a for loop that iterates 10 times, printing the value of 'i' and waiting for 2 seconds between iterations.

```gsc
      for( i=0; i<10; i++ ) // this is not an infinite loop (it has a condition that is not always true)
      {
          iprintlnbold(i); // show i on screen
          wait(2); // wait 2 seconds so the player can actually read the printed statement
      }
```

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

### String Indexed Array Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

An example demonstrating how to create and assign values to a string-indexed array.

```gsc
powerups = []; // anytime we are "forcing" an array we need to initialize the variable as an array
powerups[ "full_ammo" ] = "Max ammo"; 
powerups[ "nuke" ] = "Nuke"; 
```

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

### Foreach Loop Example (Players)

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

This example uses a foreach loop to iterate through all players and deal damage to each one.

```gsc
      foreach (player in GetPlayers()) // GetPlayers() returns an array of the players, so it is the array that is input and "player" is used to reference each "item" (player) in the array
      {
          player DoDamage(10, player.origin); // this loop deals 10 damage to each player
      }
```

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

### Multiple Attachments in One File Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Example demonstrating how multiple attachments can be defined within a single file, deriving from the first attachment.

```plaintext
attachmentUnique
au_kvk99m_extclip
{
	// ... other properties
}
```

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

### Alias Line Example

Source: https://wiki.modme.co/wiki/black_ops_3/intermediate/Setting-Up-Loadscreen-Videos.html

Example alias line for adding the required line for the video. It is recommended to copy this into an Excel Sheet for easier editing.

```csv
Name,FileSpec,Template,Loadspec,Secondary,VolumeGroup,VolMin,VolMax,DistMin,DistMaxDry,DistMaxWet,DryMaxCurve,WetMaxCurve,DryMinCurve,WetMinCurve,LimitCount,LimitType,EntityLimitCount,EntityLimitType,PitchMin,PitchMax,PriorityMin,PriorityMax,PriorityThresholdMin,PriorityThresholdMax,PanType,Storage,Looping,RandomizeType,Probability,StartDelay,ReverbSend,Duck,Pan,CenterSend,EnvelopMin,EnvelopMax,EnvelopPercent,OcclusionLevel,IsBig,DistanceLpf,FluxType,FluxTime,Subtitle,Doppler,dopplerscale,Futz,ContextType,ContextValue,contexttype1,contextvalue1,contexttype2,contextvalue2,Compression,Timescale,IsMusic,FadeIn,FadeOut,Pauseable,StopOnEntDeath,Bus,DuckGroup,iscinematic
bik_zm_testmap_load,tst\testsound.wav,CIN_C_MOD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,0,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,, 

```

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

### Infinite While Loop Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

This example shows an infinite while loop that continuously prints the loop counter 'i' and increments it, with a short wait time.

```gsc
      i = 0; 
      while(1) // this is an infinite loop
      {
          iprintlnbold(i); 
          i++; 
          wait(0.05); // this is the fastest you can possibly execute a loop in GSC
      }
```

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

### Example GSC function for zone initialization

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-up-zones.html

This is an example of how the usermap gsc function might look before and after adding zone initialization.

```gsc
function usermap_test_zone_init()
{
	level flag::init( "always_on" );
	level flag::set( "always_on" );
}
```

```gsc
function usermap_test_zone_init()
{
	zm_zonemgr::add_adjacent_zone( "start_zone",		"zone_1",		"open_zone_1" );
}
```

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

### Base Attachment Unique Asset Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

An example of a base Attachment Unique asset structure.

```plaintext
attachmentUnique
au_weaponname_none
{
}
```

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

### Example Function Definition

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

A simple example function that prints text and uses a local variable.

```gsc
function example_function()
{
    iprintlnbold("This is an example function"); 
    teddys_to_shoot = 3; 
    iprintlnbold( "You have " + teddys_to_shoot + " Teddy Bears to Shoot" ); 
}
```

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

### Conditional While Loop Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

This example demonstrates a while loop that checks if a player is currently sliding and prints a message if they are.

```gsc
      players = GetPlayers(); 
      player = players[0]; 
      while( player isOnSlide() )
      {
          iprintlnbold( "The player is sliding" ); 
          wait(0.05);
      }
```

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

### Attachment Assets - GDT Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Example of the 'weaponattachments' GDT structure.

```plaintext
{F23840}
```

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

### Do While Loop Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

This example demonstrates a do while loop that damages a player as long as they have more than 30 health and are touching a specific trigger. The code block executes at least once.

```gsc
      players = GetPlayers();
      player = players[0];
      do
      {
          player DoDamage(10, player.origin);
      } while(player.health > 30 && player IsTouching(damage_trig)); // damages the player while they are above 30 health and touching the trigger, executes at least once
```

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

### The starting function

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Menu-%28Hud%29.html

The base function to register a menu under the LUI.createMenu namespace.

```lua
function LUI.createMenu.T7Hud_zm_factory(Instance)

end

```

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

### Example Perk Inclusions

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-The-Der-Wunderfizz.html

Example of how to include all 13 official perks in the Der Wunderfizz rotation.

```gsc
zm_perk_random::include_perk_in_random_rotation( "specialty_quickrevive" );
zm_perk_random::include_perk_in_random_rotation( "specialty_armorvest" );
zm_perk_random::include_perk_in_random_rotation( "specialty_doubletap2" );
zm_perk_random::include_perk_in_random_rotation( "specialty_fastreload" );
zm_perk_random::include_perk_in_random_rotation( "specialty_deadshot" );
zm_perk_random::include_perk_in_random_rotation( "specialty_phdflopper" );
zm_perk_random::include_perk_in_random_rotation( "specialty_staminup" );
zm_perk_random::include_perk_in_random_rotation( "specialty_additionalprimaryweapon" );
zm_perk_random::include_perk_in_random_rotation( "specialty_tombstone" );
zm_perk_random::include_perk_in_random_rotation( "specialty_whoswho" );
zm_perk_random::include_perk_in_random_rotation( "specialty_electriccherry" );
zm_perk_random::include_perk_in_random_rotation( "specialty_vultureaid" );
zm_perk_random::include_perk_in_random_rotation( "specialty_widowswine" );

```

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

### Integer Indexed Array Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

An example of how to access elements in an integer-indexed array using the GetEntArray function.

```gsc
teddys_to_shoot = GetEntArray( "shootable_teddy", "targetname" );
teddys_to_shoot[0]; // This is the first element in the array teddys_to_shoot
teddys_to_shoot[1]; // This is the second teddy in the array
```

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

### Stats Bar Entry Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Adding-a-custom-weapon-to-Weapon-Kits.html

This example shows how to add an entry to the attributes table to set up the stats bar for a weapon. Substitute the numbers for your weapon's stats (0-100, where every 5 is a full box). 'weapon_assault' should be changed based on the weapon class, and 'MPUI_FULL_AUTO' should be changed to 'MPUI_SEMI_AUTO' if the weapon is semi-automatic.

```csv
weapon_assault,ar_example,accuracy,damage,range,firerate,0,25,MPUI_FULL_AUTO,
```

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

### Custom Notify Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

An example of how to send a custom notify to a player entity to trigger an event, such as showing blood splatter on screen.

```gsc
player notify( "splatter_blood_onscreen" );
```

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

### Foreach Loop Example (Teddies)

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

This example uses a foreach loop to iterate through an array of entities with the targetname 'shootable_teddy' and hide each one.

```gsc
      teddies = GetEntArray("shootable_teddy", "targetname");
      foreach (teddy in teddies) // teddies is the input array and teddy is used to reference each item in the array
      {
          teddy Hide(); // hides each teddy in the array
      }
```

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

### Endon and Waittill Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Demonstrates the use of 'endon' to stop a function when a specific notify is received and 'waittill' to wait for a notification before proceeding. This example shows how to handle blood splatter notifications while ensuring the function exits when the player dies.

```gsc
function blood_splatter()
{
    self endon( "death" ); 
    while(1)
    {
        self waittill( "splatter_blood_on_screen" ); 
        iprintlnbold( "splatter blood now" ); 
    }
}
```

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

### Attachment Assets - KVK 99m Extended Mags Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Example of deriving the Extended Mags attachment for the KVK 99m.

```plaintext
extclip_an94
```

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

### SZC File Structure Example

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Fix-the-missing-perk-jingles-and-stings.html

An example of the structure found within a map's SZC file, showing the 'Sources' block.

```json
"Sources" : [
    {
    "Type" : "ALIAS",
    "Name" : "user_aliases",
    "Filename" : "user_aliases.csv",
    "Specs" : [ ] 
 },

```

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

### Logical Operators Explained

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Demonstrates the usage of logical operators like '==' for equality checks and '!' for negation within conditional statements.

```scripting
if( grade == 100 ) iprintlnbold( "This is a perfect grade" ); 
```

```scripting
if( grade != 100 ) iprintlnbold( "This is not a perfect grade" );
```

```scripting
if( !isDefined( grade ) ) iprintlnbold( "The grade is not defined. The student didn't take the exam" );
```

```scripting
if( !false ) iprintlnbold( "the value is true!" );
```

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

### Global Variable Declaration

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Example of how to declare a global variable in GSC.

```gsc
level.teddys_to_shoot = 3;
```

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

### Continue Statement Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Demonstrates how the 'continue' statement skips the rest of the loop's current iteration if a student's grade is above 70.

```javascript
failing_students = 0; 
for( i=0; i<grades.size;i++ ) // this loop will execute the amount of times as there are elements in "grades"
{
    if( grades[i] > 70 )
    {
        iprintlnbold( "The student passed" ); 
        continue; 
    }
    failing_students++; // adds 1 to the variable only failing students if grades[i] is > than 70
}
```

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

### Sound configuration in SZC file

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-Different-Pack-A-Punches.html

Example of how to add Pack-A-Punch sound aliases to the map's SZC file.

```json
"Sources" : [
{
	"Type" : "ALIAS",
	"Name" : "user_aliases",
	"Filename" : "user_aliases.csv",
	"Specs" : [ ] 
},

{
	"Type" : "ALIAS",
	"Name" : "pack_a_punch_sounds",
	"Filename" : "pack_a_punch_sounds.csv",
	"Specs" : [ ] 
},

]
```

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

### Function Threading Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Shows how to resolve connection interrupts caused by infinite loops by 'threading' the function. This allows the function to execute concurrently without pausing the execution of the calling function.

```gsc
function main()
{
    /* main function stuff */
    level thread infinite_loop();
}

function infinite_loop()
{
    while(1)
	{
        wait(1);
	}
}
```

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

### Local Variable Declaration

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Example of how to declare a local variable in GSC.

```gsc
teddys_to_shoot = 3;
```

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

### If Statement Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Demonstrates the use of if, else if statements to check a player's average grade.

```gsc
function main()
{
	players = getplayers(); // getplayers is an engine function, see bo3_scriptapifunctions.htm
	host_player = players[0]; // players is an array, for now know that players[0] is the host
	host_player take_an_average_of_3( 80, 90, 100 ); 
	iprintlnbold( "The Host's Average Exam Grade Is: "+host_player.average_of_nums );
	if( host_player.average_of_nums >= 70 )
	{
	    iprintlnbold( "The host has a passing grade" );
	}
	else if( host_player.average_of_nums < 70 )
	{
	    iprintlnbold( "The host has a failing grade." ); 
	}
}

function take_an_average_of_3( num1, num2, num3 )
{
	sum_of_nums = num1 + num2 + num3; 
	average_of_nums = sum_of_nums/3; 
	self.average_of_nums = average_of_nums; 
}
```

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

### Attachment Unique Asset: Specifying Xmodel Assets

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Example showing how to specify xmodel assets for an attachment within the 'Attachment #number' sections.

```plaintext
attachmentUnique
au_weaponname_grip
{
	// ... other properties
	"Attachment 1"
	{
		"Attachment Association" "weapon/attachment/grip/assoc"
		"Attachment View Model" "weapon/attachment/grip/v"
		"Attachment View Model Tag" "tag_weapon"
		"Attachment View Offset" "0 0 0"
		"Attachment View Model Offset Angles" "0 0 0"
		"Attachment World Model" "weapon/attachment/grip/w"
		"Attachment World Model Tag" "tag_weapon"
		"Attachment World Offset" "0 0 0"
		"Attachment World Model Offset Angles" "0 0 0"
	}
}
```

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

### Explicit Logical Statement Evaluation

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Rewritten version of the optimized example, explicitly using '==' for comparison and including braces for clarity, demonstrating an alternative approach.

```scripting
      true_variable = 1; 
      false_variable = 0; 
      if( true_variable == true ) // This will evaluate because I set true_variable equal to 1 which is also true
      {
          iprintlnbold( "The variable true_variable is true" ); 
      }
      else // This wont execute
      {
          iprintlnbold( "The variable true_variable is not true" ); 
      }
      if( false_variable == false )
      {
          iprintlnbold( "The variable false_variable is false" );
      }
      else 
      {
          iprintlnbold( "The variable false_variable is not false" ); 
      }


```

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

### Return Statement Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Illustrates the 'return' statement's dual function: returning a value and stopping function execution. The 'did_a_student_fail' function returns true if any grade is below 70, otherwise returns false after the loop completes.

```javascript
function main()
{
    grades =  GetStudentGrades(); // This doesnt exist but lets pretend we got the array of grades somehow
    failed = did_a_student_fail( grades ); // lets call another function and return a true or false from it
    if( failed )
        iprintlnbold( "At least one student failed" ); 
    else 
        iprintlnbold( "No students failed" ); 
}

function did_a_student_fail( grades )
{
    for( i=0; i<grades.size;i++ ) // this loop will execute the amount of times as there are elements in "grades"
    {
        if( grades[i] < 70 )
        {
            return true; // A student did fail
        }
    }
    return false; // This will never execute if any student failed, but if no one failed it will
}
```

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

### Break Statement Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Shows how the 'break' statement exits a 'while' loop when a specific condition (level.next_dog_round == level.round_number) is met, continuing execution after the loop.

```javascript
while(1)
{
    if( level.next_dog_round == level.round_number )
        break; 
    iprintlnbold( "This line and below wont execute if the break is called" ); 
    wait(1);
}
```

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

### Example statstable entry for a custom weapon

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Adding-a-custom-weapon-to-Weapon-Kits.html

This is an example entry for a custom weapon in the statstable, detailing various parameters like index, weapon class, localized name, icon, description, available attachments, unlock level, visibility, and inventory slot.

```csv
12,,weapon_smg,WEAPON_S2_GREASE_GUN,smg_grease_gun_s2,,s2_icon_weapon_greasegun,WEAPON_S2_GREASE_GUN_DESC,reddot quickdraw reflex grip steadyaim fmj extbarrel extclip rf suppressed,1,0,,1,primary,,,,1,,,
```

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

### Example gun levelling entries for attachment unlocks

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Adding-a-custom-weapon-to-Weapon-Kits.html

These are pre-prepared entries for the zm_gunlevels.csv file that will unlock all attachment options for a weapon.

```csv
1,0,smg_mas38_s2,,,0
2,0,smg_mas38_s2,,,1
3,0,smg_mas38_s2,,,2
```

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

### Treyarch/Nate's Style

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

An example of a coding style similar to Treyarch's, featuring specific indentation and brace placement.

```gsc
      function main()
      {
          grades =  GetStudentGrades(); // This doesnt exist but lets pretend we got the array of grades somehow
          failed = did_a_student_fail( grades ); // lets call another function and return a true or false from it
          if( failed )
              iprintlnbold( "At least one student failed" ); 
          else 
              iprintlnbold( "No students failed" ); 
      }
      
      function did_a_student_fail( grades )
      {
          for( i=0; i<grades.size;i++ ) // this loop will execute the amount of times as there are elements in "grades"
          {
              if( grades[i] < 70 )
              {
                  return true; // A student did fail
              }
          }
          return false; // This will never execute if any student failed, but if noone failed it will
      }


```

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

### Example of Modified Alias Line

Source: https://wiki.modme.co/wiki/black_ops_3/intermediate/Custom-round-sounds.html

An example showing how to modify a line in user_aliases.csv to point to a custom sound file.

```csv
mus_roundstart1_intro,,,round_sounds\aldwychrs.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
```

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

### Function Example with `self`: Averaging Grades for a Player

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Illustrates using `self` to pass data within a function called on a specific player entity, storing the result as a field of that entity.

```gsc
function main()
{
	players = getplayers(); // getplayers is an engine function, see bo3_scriptapifunctions.htm
	host_player = players[0]; // players is an array, for now know that players[0] is the host
	host_player take_an_average_of_3( 80, 90, 100 ); 
	iprintlnbold( "The Host's Average Exam Grade Is: "+host_player.average_of_nums );
}

function take_an_average_of_3( num1, num2, num3 )
{
	sum_of_nums = num1 + num2 + num3;
	average_of_nums = sum_of_nums/3;
	self.average_of_nums = average_of_nums; 
}
```

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

### UIElement Usage Example

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Stock-Element-Functions.html

Demonstrates how to add an element as a child using HudElem:addElement().

```lua
HudElem:addElement(Elem) -- All these functions use the self syntax ':'
```

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

### User Aliases CSV Example

Source: https://wiki.modme.co/wiki/black_ops_3/intermediate/Custom-round-sounds.html

Example lines to add to the user_aliases.csv file for custom round sounds.

```csv
# Round Sounds
mus_roundstart_first_intro,,,your_folder\intro.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart_short1_intro,,,your_folder\short1.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart_short2_intro,,,your_folder\short2.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart_short3_intro,,,your_folder\short3.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart_short4_intro,,,your_folder\short4.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart1_intro,,,your_folder\start1.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart2_intro,,,your_folder\start2.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart3_intro,,,your_folder\start3.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundstart4_intro,,,your_folder\start4.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_roundend1_intro,,,your_folder\end.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_dogstart1_intro,,,your_folder\dogstart.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_dogend1_intro,,,your_folder\dogend.wav,,,UIN_MOD,,,,,,,,,,,95,95,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
mus_gameover_intro,,,your_folder\gameover.wav,,,UIN_MOD,,,,,,,,,,,100,100,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
```

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

### Basic Function Example: Averaging Exam Grades

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Demonstrates a simple function to calculate the average of three numbers, with a main function to call it and print the result.

```gsc
function main()
{
	average_exam_grade = take_an_average_of_3( 80, 90, 100 ); 
	iprintlnbold( "Your Average Exam Grade Is: "+average_exam_grade );
}

function take_an_average_of_3( num1, num2, num3 )
{
	sum_of_nums = num1 + num2 + num3; 
	average_of_nums = sum_of_nums/3; 
	return average_of_nums; 
}
```

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

### Connection Interrupt Example (Without Threading)

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Illustrates a scenario where calling a function with an infinite loop directly from the main function causes a connection interrupt because the main function's execution is paused indefinitely.

```gsc
function main()
{
    /* main function stuff */
    level infinite_loop();
}

function infinite_loop()
{
    while(1)
	{
        wait(1);
	}
}
```

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

### Setting up the hud

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Menu-%28Hud%29.html

Configuring the hud to cover the screen and play an opening sound.

```lua
function LUI.createMenu.T7Hud_zm_factory(Instance)
      local Hud = CoD.Menu.NewForUIEditor("T7Hud_zm_factory")

      -- Set the current sound profile
      Hud.soundSet = "HUD"
      -- Set the owner of our hud to the root 'instance'
      Hud:setOwner(Instance)
      -- Set the anchors (Left: True, Right: True, LeftMargin: 0, RightMargin: 0)
      Hud:setLeftRight(true, true, 0, 0)
      -- Set the anchors (Top: True, Bottom: True, TopMargin: 0, BottomMargin: 0)
      Hud:setTopBottom(true, true, 0, 0)
      -- Play the opening sound (From 'HUD' profile)
      Hud:playSound("menu_open", Instance)

      return Hud
end

```

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

### Setting up the control

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Custom-Control-%28Widget%29.html

This code snippet shows how to set up a custom control by inheriting from the base UIElement.

```lua
CoD.TestControl = InheritFrom(LUI.UIElement)

```

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

### SZC File with Perk Sounds Added

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Fix-the-missing-perk-jingles-and-stings.html

An example of how the SZC file should look after the perk sounds alias has been added.

```json
"Sources" : [
    {
    "Type" : "ALIAS",
    "Name" : "user_aliases",
    "Filename" : "user_aliases.csv",
    "Specs" : [ ] 
 },
 {
 "Type" : "ALIAS",
 "Name" : "perk_sounds",
 "Filename" : "perk_sounds.csv",
 "Specs" : [ ] 
},

```

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

### IPrintLnBold Engine Function Signature

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Signature and documentation for the IPrintLnBold engine function.

```gsc
void IPrintLnBold(<text>)

	[MANDATORY] <text> text to be written
	CATEGORY: 
	CLIENT/SERVER: Server
	SUMMARY: Write bold line to the screen
	EXAMPLE: IPrintLnBold( "Mitchell!" )
```

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

### Instantiating the control

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Custom-Control-%28Widget%29.html

This code snippet shows how to create an instance of the custom control.

```lua
local Control = CoD.TestControl.new(HudRef, InstanceRef)

```

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

### Weapon Kit Entry Example

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Adding-a-custom-weapon-to-Weapon-Kits.html

Each level in this entry specifies an attachment slot for the game to unlock. 0 is the optic slot, and 1-5 are attachment slots. You can remove any number of these if needed.

```csv
4,0,smg_mas38_s2,,,3
5,0,smg_mas38_s2,,,4
7,0,smg_mas38_s2,,,5
```

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

### Creating the hud itself

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Menu-%28Hud%29.html

Allocating a new menu instance for the hud.

```lua
function LUI.createMenu.T7Hud_zm_factory(Instance)
      local Hud = CoD.Menu.NewForUIEditor("T7Hud_zm_factory")

      return Hud
end

```

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

### Modifying Numerical Variables (Shortcut Operators)

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Demonstrates shortcut operators for incrementing, decrementing, and compound arithmetic operations.

```gsc
i = 0; // declare an int "i", value of i = 0
i++; // add 1 to the current value of i, value of i = 1
i--; // subtract 1 from the current value of i, value of i = 0
i += 25; // add 25 to the current value of i, value of i = 25
i -= 12; // subtract 12 from the current value of i, value of i = 13
i *= 3; // multiply the current value of i by 3, value of i = 39
i /= 13; // divide the current value of i by 9, value of i = 3
```

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

### Attachment Unique Asset Configuration: AN-94 Extended Mags

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Configuration example for an Attachment Unique asset, specifically for AN-94 Extended Mags, showing the 'attachmenttype' override.

```plaintext
attachmentUnique
au_an94_extclip
{
	attachmenttype "extclip"
	// ... other properties
}
```

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

### Sound Configuration

Source: https://wiki.modme.co/wiki/black_ops_3/intermediate/Setting-Up-Loadscreen-Videos.html

Add this line to the zm_mod config file at the bottom.

```plaintext
sound,zm_mod

```

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

### Requiring a script in Standard Lua

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Introduction.html

Demonstrates how to require a Lua script using standard Lua syntax.

```lua
-- Use the file in the folder 'a' named 'b.lua'
require("a/b.lua")

```

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

### Catching call exceptions in BO3 Lua

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Introduction.html

Demonstrates how to use `pcall` to wrap function calls and prevent errors from halting the game.

```lua
function test()
      <something that errors>
end

if pcall(test) then
      success
else
      failed
end

```

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

### Holofya's Style

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

An example of a different coding style, characterized by different indentation and brace placement compared to Treyarch's style.

```gsc
      function main()
      {
          grades =  GetStudentGrades(); // This doesnt exist but lets pretend we got the array of grades somehow
          failed = did_a_student_fail(grades); // lets call another function and return a true or false from it
	  
          if(failed)
	  {
              IPrintLnBold("At least one student failed");
          }
	  else
	  {
              IPrintLnBold("No students failed");
	  }
      }
      
      function did_a_student_fail(grades)
      {
          for(i = 0; i < grades.size; i++) // this loop will execute the amount of times as there are elements in "grades"
          {
              if(grades[i] < 70)
              {
                  return true; // A student did fail
              }
          }
	  
          return false; // This will never execute if any student failed, but if noone failed it will
      }


```

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

### Scripting - Initialize Apothicon Servant Variables

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-The-Apothicon-Servant.html

Initialize Apothicon Servant weapon variables in your mapname.gsc file.

```gsc
level.b_allow_idgun_pap = 1;
level.idgun_weapons = [];
level.idgun_weapons[ 0 ] = getWeapon( "idgun_0" );
level.idgun_weapons[ 1 ] = getWeapon( "idgun_1" );
level.idgun_weapons[ 2 ] = getWeapon( "idgun_2" );
level.idgun_weapons[ 3 ] = getWeapon( "idgun_3" );
level.idgun_weapons[ 4 ] = getWeapon( "idgun_upgraded_0" );
level.idgun_weapons[ 5 ] = getWeapon( "idgun_upgraded_1" );
level.idgun_weapons[ 6 ] = getWeapon( "idgun_upgraded_2" );
level.idgun_weapons[ 7 ] = getWeapon( "idgun_upgraded_3" );

```

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

### Varix 3 (dualoptic) - Zone File Inclusion

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Including the dualoptic weaponfile in the zone file.

```plaintext
weaponfull,dualoptic_WEAPONNAME
```

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

### Power Lights Script - Main Function

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-up-a-proper-power-switch.html

Adds the call to the power_lights function within the zm_usermap::main() function.

```gsc
// Power Lights
thread power_lights();

```

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

### Mystery Box Sounds Configuration

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-Different-Mystery-Boxes-%28-Origins%2C-MOTD-and-SOE-included-%29.html

Addition to the SZC file to include mystery box sounds.

```json
"Sources" : [
{
	"Type" : "ALIAS",
	"Name" : "user_aliases",
	"Filename" : "user_aliases.csv",
	"Specs" : [ ] 
},
{
	"Type" : "ALIAS",
	"Name" : "mysterybox_sounds",
	"Filename" : "mysterybox_sounds.csv",
	"Specs" : [ ] 
},

```

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

### Special Combo - Extended Mags, Fast Mags and Grip Animations

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Specifying weapon animations for the special combo of Extended Mags, Fast Mags, and Grip.

```plaintext
{F22930}
```

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

### Set Starting Weapon

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Change-starting-weapon.html

Code snippet to define and set the player's starting weapon in a Black Ops 3 custom map.

```gsc
startingWeapon = "anyweapon";
weapon = getWeapon(startingWeapon);
level.start_weapon = (weapon);

```

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

### Including the control file

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Custom-Control-%28Widget%29.html

This shows how to specify the file name and path for the custom control script.

```plaintext
rawfile,testcontrol.lua // File name and path

```

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

### Initial Box Array in tutorialmap.gsc

Source: https://wiki.modme.co/wiki/world_at_war/Creating-A-Basic-Zombie-Map.html

The default array of mystery box names in the GSC script.

```gsc
      // Magic Boxes -- The Script_Noteworthy Value Names On Purchase Trigger In Radiant
          boxArray = [];
          boxArray[ boxArray.size ] = "start_chest";
          boxArray[ boxArray.size ] = "chest1";
          boxArray[ boxArray.size ] = "chest2";
          boxArray[ boxArray.size ] = "chest3";
          boxArray[ boxArray.size ] = "chest4";
          boxArray[ boxArray.size ] = "chest5";
          level.DLC3.PandoraBoxes = boxArray;
```

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

### Varix 3 (dualoptic) - Alt Mode Options

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Settings within the non-dualoptic weaponfile under 'Alt Mode Options'.

```plaintext
Alt Weapon Name
Ads Only Alt Weapon
Disable Toggle Weapon Switching
```

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

### Adding a control

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Menu-%28Hud%29.html

Adding a UIText element to the hud and setting its properties.

```lua
function LUI.createMenu.T7Hud_zm_factory(Instance)
      local Hud = CoD.Menu.NewForUIEditor("T7Hud_zm_factory")

      -- Set the current sound profile
      Hud.soundSet = "HUD"
      -- Set the owner of our hud to the root 'instance'
      Hud:setOwner(Instance)
      -- Set the anchors (Left: True, Right: True, LeftMargin: 0, RightMargin: 0)
      Hud:setLeftRight(true, true, 0, 0)
      -- Set the anchors (Top: True, Bottom: True, TopMargin: 0, BottomMargin: 0)
      Hud:setTopBottom(true, true, 0, 0)
      -- Play the opening sound (From 'HUD' profile)
      Hud:playSound("menu_open", Instance)

      -- Make a new text element
      Hud.TestText = LUI.UIText.new(Hud, Instance)

      -- Set properties
      Hud.TestText:setLeftRight(true, false, 20, 250)
      Hud.TestText:setTopBottom(true, false, 20, 50)
      Hud.TestText:setText("Hello World!")

      Hud:addElement(Hud.TestText)  -- Add the control to the hud

      return Hud
end

```

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

### Varix 3 (dualoptic) - Animation Equivalents

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Specifying animation equivalents for the Varix 3 scope within the Attachment Unique asset.

```plaintext
{F22925}
```

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

### Electric Cherry Perk Machine Setup Function

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-up-perk-machines.html

Replace the existing function with this one for the Electric Cherry perk machine setup.

```gsc
function electric_cherry_perk_machine_setup( use_trigger, perk_machine, bump_trigger, collision )
{
	use_trigger.script_sound = "mus_perks_ec_jingle";
	use_trigger.script_string = "electriccherry_perk";
	use_trigger.script_label = "mus_perks_ec_sting";
	use_trigger.target = "vending_electriccherry";
	perk_machine.script_string = "electriccherry_perk";
	perk_machine.targetname = "vending_electriccherry";
	if ( IsDefined( bump_trigger ) )
	{
		bump_trigger.script_string = "electriccherry_perk";
	}
}

```

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

### Varix 3 (dualoptic) - Weaponfile Naming

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Naming convention for the dualoptic weaponfile.

```plaintext
dualoptic_YOURWEAPONNAMEHERE
```

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

### Commenting out a line in tutorialmap_patch.csv

Source: https://wiki.modme.co/wiki/world_at_war/Creating-A-Basic-Zombie-Map.html

This snippet shows how to comment out a specific line in a CSV file to resolve a compilation error.

```text
      col_map_sp,maps/tutorialmap_patch.d3dbsp
```

```text
      // col_map_sp,maps/tutorialmap_patch.d3dbsp
```

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

### Varix 3 (dualoptic) - XAnims Specification

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Specifying the weapon's animation equivalents in XAnims within the dualoptic weaponfile.

```plaintext
{F22928}
```

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

### Power Lights Script - Function Definition

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-up-a-proper-power-switch.html

Defines the power_lights function to handle lighting states based on power on/off flags.

```gsc
function power_lights()
{
	level flag::wait_till( "power_on" );
	level util::set_lighting_state( 0 );
	level flag::wait_till( "power_off" );
	level util::set_lighting_state( 1 );
	power_lights();
}

```

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

### Requiring the script

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Custom-Control-%28Widget%29.html

This demonstrates how to include the custom control script in another Lua file using 'require'.

```lua
require("testcontrol")

```

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

### Entity Deletion

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Syntax for deleting an entity after use in GSC.

```gsc
ent delete();
```

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

### ShellShock Function

Source: https://wiki.modme.co/wiki/black_ops_3/info/Loaded-Shellshocks.html

Starts a shell shock sequence for the entity for a given duration.

```gsc
<player> ShellShock(<shellshockname>,<duration>,[allowReduceShellShockPerk])
[MANDATORY] <shellshockname>
[MANDATORY] <duration> duration in seconds. The duration must be between 0 and 60 seconds.
[OPTIONAL] [allowReduceShellShockPerk] true if shell shock perk should be reduced
CATEGORY: 
CLIENT/SERVER: Server
SUMMARY: Start a shell shock sequence for the entity for given duration.
EXAMPLE: self shellShock( "frag_grenade_mp", 0.2 )
```

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

### Setting Margins on a UIElement

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Layout-And-Margins.html

This code demonstrates how to set margins for a UIElement to make it fit its container. The first call sets left and right margins, and the second sets top and bottom margins.

```lua
-- (bool: IsDistanceFromLeft, bool: IsDistanceFromRight, MarginLeft, MarginRight)
Element:setLeftRight(true, true, 0, 0)
-- (bool: IsDistanceFromTop, bool: IsDistanceFromBottom, MarginTop, MarginBottom)
Element:setTopBottom(true, true, 0, 0)
```

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

### Zone File Include for Traps

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-up-traps.html

Includes the trap configuration into the map's zone file.

```zone
include,hb21_traps
```

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

### Adding Weapon to CSV

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-The-Apothicon-Servant.html

Add these lines to zm_levelcommon_weapons.csv to define the Apothicon Servant weapons.

```csv
idgun_0,idgun_upgraded_0,,10000,wpck_ray,,,,,TRUE,FALSE,FALSE,,,FALSE,FALSE,special,TRUE,,
idgun_1,idgun_upgraded_1,,10000,wpck_ray,,,,,TRUE,FALSE,FALSE,,,FALSE,FALSE,special,TRUE,,
idgun_2,idgun_upgraded_2,,10000,wpck_ray,,,,,TRUE,FALSE,FALSE,,,FALSE,FALSE,special,TRUE,,
idgun_3,idgun_upgraded_3,,10000,wpck_ray,,,,,TRUE,FALSE,FALSE,,,FALSE,FALSE,special,TRUE,,

```

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

### Script Includes

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-The-Der-Wunderfizz.html

Includes required for Der Wunderfizz functionality in mapname.gsc and mapname.csc.

```gsc
#using scripts\zm\_zm_perk_staminup;

// DER WUNDERFIZZ
1. using scripts\zm\_zm_perk_random;

```

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

### Modifying Numerical Variables (Standard Operations)

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Demonstrates basic arithmetic operations to modify integer variables.

```gsc
i = 0; // declare an int "i", value of i = 0
i = i + 1; // add 1 to the current value of i, value of i = 1
i = i - 1; // subtract 1 from the current value of i, value of i = 0
i = i + 25; // add 25 to the current value of i, value of i = 25
i = i - 12; // subtract 12 from the current value of i, value of i = 13
i = i * 3; // multiply the current value of i by 3, value of i = 39
i = i / 13; // divide the current value of i by 9, value of i = 3
```

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

### KVP for Trap Cost

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-up-traps.html

Sets the cost of a trap prefab.

```kvp
zombie_cost - 5000
```

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

### Defining a control base

Source: https://wiki.modme.co/wiki/black_ops_3/lua_%28lui%29/Your-First-Custom-Control-%28Widget%29.html

This snippet defines the 'new' function for a custom control, setting its class, ID, and sound set.

```lua
CoD.TestControl = InheritFrom(LUI.UIElement)

function CoD.TestControl.new(HudRef, InstanceRef)
      local Elem = LUI.UIElement.new()
      Elem:setClass(CoD.TestControl)
      Elem.id = "TestControl"
      Elem.soundSet = "default"
      return Elem
end

```

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

### Wallrunning Functions

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Add-wallrunning.html

These three functions are required to implement the wallrunning logic, including setup, trigger handling, and enabling/disabling wallrun for players.

```gsc
function setup_wallrun()
{
	players = GetPlayers();
	foreach(player in players)
	{
		player AllowWallRun(false);
		player.iswallrunning = false;
	}

	wallrun_trigger = GetEntArray("wallrun_trigger", "targetname");
	foreach(trig in wallrun_trigger)
	{
		trig thread wallrun_logic();
	}
}

function wallrun_logic()
{
	while(1)
	{
		self waittill("trigger", player);
		if(!player.iswallrunning)
		{
			player thread enable_wallrun(self);
		}
	}
}

function enable_wallrun(trig)
{
	self endon("death");
	self endon("disconnect");

	self.iswallrunning = true;
	while(self IsTouching(trig))
	{
		self AllowWallRun(true);
		WAIT_SERVER_FRAME;
	}
	self.iswallrunning = false;
	self AllowWallRun(false);
}

```

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

### Vulture Perk Jingles and Stings Configuration

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Fix-the-missing-perk-jingles-and-stings.html

Configuration lines for the Vulture perk's audio files, including start, loop, and stop sounds, with parameters for playback and positioning.

```plaintext
zmb_perks_vulture_stink_start,,,black_ops_2\perks\vulture\stink\start.wav,,,UIN_MOD,,,,,,,,,0,0,100,100,0,1000,1000,,,,,,,,,,,,,,,,3d,front,,NONLOOPING,,,,,,,,,,,,,,,,,,,,,,,,,,,YES,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
zmb_perks_vulture_stink_loop,,,black_ops_2\perks\vulture\stink\loop.wav,,,UIN_MOD,,,,,,,,,0,0,80,100,0,100,100,,,,,,,,,,,,,,,,3d,front,,LOOPING,,,,,,,,,,,,,,,,,,,,,,,,,,,YES,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
zmb_perks_vulture_stink_stop,,,black_ops_2\perks\vulture\stink\stop.wav,,,UIN_MOD,,,,,,,,,0,0,100,100,0,1000,1000,,,,,,,,,,,,,,,,3d,front,,NONLOOPING,,,,,,,,,,,,,,,,,,,,,,,,,,,YES,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,||
```

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

### Zone File Configuration

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-Player-Voices-%28Der-Eisendrache%29.html

This snippet shows how to add the required files to your map's Zone file.

```text
stringtable,gamedata/audio/zm/zm_castle_vox.csv
```

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

### Optimized Logical Statement Evaluation

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Scripting-guide.html

Shows a more concise way to evaluate boolean variables directly in if statements without explicit comparison operators, and demonstrates omitting braces for single-line code blocks.

```scripting
      true_variable = 1; 
      false_variable = 0; 
      if( true_variable ) // This will evaluate because I set true_variable equal to 1 which is also true
          iprintlnbold( "The variable true_variable is true" ); 
      else // This wont execute
          iprintlnbold( "The variable true_variable is not true" ); 
      if( !false_variable ) // This is true. We invert the false value of false_variable to be true
          iprintlnbold( "The variable false_variable is false" );
      else 
          iprintlnbold( "The variable false_variable is not false" ); 


```

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

### Rapid Fire and Suppressor - Weaponfile Sounds

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Specifying sounds in the weaponfile for Rapid Fire and Suppressor combination.

```plaintext
{F22932}
```

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

### Commented Out Boxes in tutorialmap.gsc

Source: https://wiki.modme.co/wiki/world_at_war/Creating-A-Basic-Zombie-Map.html

Modified box array with unused boxes commented out.

```gsc
      // Magic Boxes -- The Script_Noteworthy Value Names On Purchase Trigger In Radiant
          boxArray = [];
          boxArray[ boxArray.size ] = "start_chest";
          boxArray[ boxArray.size ] = "chest1";
          boxArray[ boxArray.size ] = "chest2";
          // boxArray[ boxArray.size ] = "chest3";
          // boxArray[ boxArray.size ] = "chest4";
          // boxArray[ boxArray.size ] = "chest5";
          level.DLC3.PandoraBoxes = boxArray;
```

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

### Default Zone Adjacency in tutorialmap.gsc

Source: https://wiki.modme.co/wiki/world_at_war/Creating-A-Basic-Zombie-Map.html

The default configuration for adjacent zones in the GSC script.

```gsc
          add_adjacent_zone( "start_zone", "zone1", "enter_zone1" );
          add_adjacent_zone( "zone1", "zone2", "enter_zone2" );
```

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

### Attachment Assets - Derived Attachment Naming

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

Naming convention for creating a derived version of an attachment.

```plaintext
originalattachment_useforderivedversion
```

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

### CSC Script Includes for Traps

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-up-traps.html

Adds necessary trap script includes to the mapname.csc file.

```csc
#using scripts\zm\_zm_trap_electric;
#using scripts\zm\_zm_trap_fire;
#using scripts\_hb21_zm_trap_centrifuge;
#using scripts\_hb21_sym_zm_trap_fan;
#using scripts\_hb21_sym_zm_trap_acid;
```

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

### Override Stock Script

Source: https://wiki.modme.co/wiki/black_ops_3/basics/Setting-Up-Different-Mystery-Boxes-%28-Origins%2C-MOTD-and-SOE-included-%29.html

Lines to comment out in the zm_patch.csv file to override the stock mystery box script.

```gsc
scriptparsetree,scripts/zm/_zm_magicbox.csc
scriptparsetree,scripts/zm/_zm_magicbox.gsc
```

```gsc
// scriptparsetree,scripts/zm/_zm_magicbox.csc
// scriptparsetree,scripts/zm/_zm_magicbox.gsc
```

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

### Mystery Box Key-Value Pairs (KVPs)

Source: https://wiki.modme.co/wiki/world_at_war/Creating-A-Basic-Zombie-Map.html

Configuration for a mystery box, including trigger, lid, base, rubble, and script origin.

```kv
      TRIGGER:
          script_noteworthy | chest2
                     target | magic_box_lid_2
       
      BOX LID:
          targetname | magic_box_lid_2
              target | magic_box_weapon_spawn_2
       
      BOX BASE:
          targetname | magic_box_base_2
       
      RUBBLE (3 small crates plus teddy):
          script_noteworthy | chest2_rubble
       
      SCRIPT ORIGIN (red cube inside box):
          targetname | magic_box_weapon_spawn_2
              target | magic_box_base_2
```

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

### Attachment Not Found Error

Source: https://wiki.modme.co/wiki/black_ops_3/guides/Setting-Up-Weapon-Attachments.html

This is a common error message encountered when weapon attachments are not properly linked or found within the Mod Tools.

```text
UNRECOVERABLE ERROR:
    Weapon attachment (attachment_name) not found

Linker will now terminate.

```
Tokens:
Raw