Resource Configuration

This page provides comprehensive information about our configuration files, assisting in the setup of the resource.

---

cfg.zTurnoutSystem

This feature enables integration with the zTurnout-System. It functions by automatically activating the Wig Wag lights when the station is mobilized.

To enable this feature, it is essential to verify that the groupId matches the station's Id number in the zTurnout-System config.lua file.

zTurnout-System Store Page

---

cfg.notificationSound

Set this option to 'true' to enable notification sound effects when receiving notifications, or set it to 'false' if you prefer not to have sound effects for notifications.

---

cfg.whitelist

In this section, you have the option to enable whitelist for WigWag Activations.

Ace perms:

• Allow: Here you can activate the "Ace Permissions Whitelist" feature. This feature will restrict the use of commands based on the specified group.

• Group: Here, you can specify the group to which you would like to grant command whitelisting.

---

cfg.discordLog

In this section, you have the option to enable Discord logging for WigWag Activations.

• Allow: If this feature is enabled, a notification will be sent to the specified webhook URL when wigwags are activated. The notification will include all necessary details about the activation. If this feature is disabled, no notifications will be sent to Discord. Additionally, if cfg.zTurnoutSystem is enabled, no log will be generated.

• Webhook: This option enables you to input your desired Discord webhook URL, which is the channel where log messages will be sent. If you are unsure of how to obtain a webhook URL, please visit the link provided below.

• Community Name: This option allows you to input your community's name. This text will be displayed in the Discord log message.

• Community Logo: This option enables you to upload your community's logo, and this image will be displayed in the Discord log message.

Introduction to Discord Webhooks

---

cfg.commands

In this section, you have the capability to make adjustments to all of the resource's commands.

• Name: Here you have the option to specify the command's string.

• Help Text: Here you can customize the string that aids users in comprehending the commands' functionality in the game.

---

cfg.translations

This section allows you to customize the script's strings based on your preferences, whether it's modifying the language or making general edits to message aspects.

---

cfg.wigwagSettings

Here, you are provided with the opportunity to personalize the functionality of the WigWags.

• Warning Time: In this field, you have the ability to adjust the duration for which the warning light is visible. This value is measured in seconds.

• Flash Interval: Here, you have the option to adjust the duration between the wigwag light flashing on the left and the right. This duration is measured in milliseconds.

• Flash Time: In this field, you have the ability to adjust the duration for which the WigWag light is active. This value is measured in seconds.

---

cfg.wigwagGroups

In this section, you have the capability to form groups of WigWag lights.

Within the table cfg.wigwagGroups, there is a distinct table or code section for each group. These sections are identified by unique numbers, such as [1], [2], and so forth. The start and end of each section are marked by comments within the config.lua file.

Example of a block

cfg.wigwagGroups = {
   -- BLOCK START --
   [1] = {
      {
         coordinates = vector3(0.0, 0.0, 0.0);
         rotation = vector3(0.0, 0.0, 0.0);
         stopRadius = 15.0
      };
      {
         coordinates = vector3(0.0, 0.0, 0.0);
         rotation = vector3(0.0, 0.0, 0.0);
         stopRadius = 15.0
      }
   };
   -- BLOCK END --
   -- BLOCK START --
   [2] = {
      {
         coordinates = vector3(0.0, 0.0, 0.0);
         rotation = vector3(0.0, 0.0, 0.0);
         stopRadius = 15.0
      };
      {
         coordinates = vector3(0.0, 0.0, 0.0);
         rotation = vector3(0.0, 0.0, 0.0);
         stopRadius = 15.0
      }
   }
   -- BLOCK END --
}

New tables should always be positioned after the comment -- BLOCK END --. This comment indicates the conclusion of the previous block.

It's crucial that the ID you insert within the brackets is both unique and non-duplicate.

---

Coordinates:

In this section, you will enter the 3D world coordinates for the WigWag prop. This is the location where the WigWag will spawn, and the format for this option is as follows: vec3(x, y, z).

---

Rotation:

In this section, you will specify the rotation of the WigWag prop. This option enables you to position the WigWag precisely in a designated location. The format for this option is vec3(pitch, roll, yaw)

---

Stop Radius:

In this section, you have the option to specify the distance at which AI will come to a halt for the wigwag lights. This radius begins from the prop location.