🎄Events

Documentation relating to the lumen_events

Installation

• Works with RedEM:RP / VORP / RSG . Be sure you installed one of them before to use this script.

• You need to have 2 utility scripts. These will be provided by discord

  • uiprompt

  • xsound

• Drag and drop the resource in your resources folder

  • lumen_events

• Add this ensure in your server.cfg below under all utility scripts (uiprompt,xsound etc)

  • ensure lumen_events

• Edit the config.lua to make sure to customize the code

If you have any questions, please contact our lumen works discord.

Framework

Config.framework = "redemrp"

You can set the framework you need. The available options are "redemrp" or "vorp".

Language

```lua
Config.Text = {
  [1] = "Open",
  [2] = "Christmas gift",
  [3] = "A Christmas tree with gifts will appear in ",
  [4] = "A Christmas tree with gifts has appeared. Look for the tree icon on the map",
  [5] = "You have a time limit to open the gifts. Time: ",
  [6] = "Christmas tree",
  [7] = "You have found something inside the gift!",
  [8] = "You didn't get anything",
}
```

General Conf

```lua
Config.button = "INPUT_INTERACT_LOCKON_ANIMAL"
Config.fireworks = true
Config.minPlayer = 1
Config.timeout = 120
Config.hourAppear = {17,20}
Config.Sound = ""
```

• Button : You can change the button for the one you need, by default it is the G key.

• fireworks : If true, activates fireworks effects.

• minPlayer : Indicates the minimum number of players to start the events

• timeout : Time in seconds to end the event.

• hourAppear : Indicates the times where the event will appear on the server.

• Sound : You can add a discord link of a song that you have uploaded to discord.

Notifications

Config.notifyServer = function(text,src)
    TriggerClientEvent('redem_roleplay:ShowObjective',src, text, 4000)
end

You can set your custom notification system here, by default redemrp is added

Events

Config.TreeAndGift = { 

  {
    coords = vector3(2543.309, -1202.08, 52.310),
    blipIcon =  -426139257,
    timeStart = 3,
    model = "mp006_p_xmastree01x",
    gift = {
      {model = "hlc_gift01x", coords = vector3(2544.799072265625, -1200.75, 52.36999130249023)},
      {model = "hlc_gift02x", coords = vector3(2544.529052734375, -1203.3900146484375, 52.44997787475586)},
      {model = "hlc_gift03x", coords = vector3(2542.06201171875, -1203.550048828125, 52.70993423461914)},
      {model = "hlc_gift01x", coords = vector3(2542.0263671875, -1202.48095703125, 52.40016937255859)},
      {model = "hlc_gift02x", coords = vector3(2542.385498046875, -1200.8843994140625, 52.49111557006836)},
      {model = "hlc_gift03x", coords = vector3(2544.8662109375, -1202.1915283203125, 52.74912643432617)},

    },
  },  
  
}

Here you can configure all server events. The server will choose a random event among all those configured.

• coords : coordinates where the "ornament" will appear (for example the Christmas tree)

• blipIcon : hash of the icon that will appear on the map

• timeStart : Time in seconds for the event to start after being announced on the server

• model : Decorative object model

• gift : you indicate the model and coordinates of each gift

Gifts

Config.loot = { 

  ["hlc_gift01x"] =  {

    anim = {dic = "mech_pickup@loot@money_box@ground", var = "find_cash", time = 3},
    items = {
      {item = "money", min = 1, max = 2, prob = 100 },
      {item = "water", min = 1, max = 2, prob = 0 },
      {item = "bread", min = 1, max = 2, prob = 90 },
    },
  },


}

Here you configure the rewards for each gift model

• anim : The animation that the player will see when they interact with the gift

• items : Here you can configure the name of the item, minimum and maximum quantity and the probability that the item will appear in the gift