Difference between revisions of "Season Challenges"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
(Created page with "==Season Files==")
 
(Mod Example)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Season Files==
 
==Season Files==
 +
{| class="wikitable"
 +
|-
 +
! File Name !! Description
 +
|-
 +
| scripts.globals.mobile_effects.players.challegne_system|| mobile effect to display and handle the Season Challenge UI
 +
|-
 +
| scripts.globals.server_settings.seasons || contains the Seasons Challenge table for editing rewards and UI variables
 +
|-
 +
| scripts.globals.helpers.seasons || helper functions to support the Seasons Challenge system
 +
|-
 +
| scripts.globals.static_data.quests || holds the quest tables for the Seasons Challenge system
 +
|}
 +
 +
== Mod Example ==
 +
Let us make a simple mod to the to allow to change the following on how a season works. First we will make a mod for the base file scripts.globals.serversettings.seasons.lua. We want to modify the way it behaves by doing the following...
 +
*Change the season # we are currently on (starting off at season 1)
 +
*Change the name of the season (displayed on the season UI)
 +
*Change Tier 1 reward cost from 2000 to 5000
 +
*Change Tier 2 reward cost from 4000 to 10000
 +
*Change Tier 2 reward cost from 8000 to 15000
 +
*Change Tier 3 PvE Reward template
 +
*Change Tier 3 PvP Reward Template
 +
We want to create a new mod file inside your mods/YourModName/scripts/globals/server_settings/seasons.lua. Below is example of such a modification.
 +
<syntaxhighlight lang="Lua">
 +
-- import the tables and functions from the original base script
 +
require 'default:globals.server_settings.seasons'
 +
-- the season number we are using
 +
ServerSettings.ChallengeSystem.Season = 1
 +
-- title for season window
 +
ServerSettings.ChallengeSystem.SeasonTitle = "Season I: Season Name"
 +
-- modify the PVE Tier 3 reward   
 +
ServerSettings.ChallengeSystem.RewardLootTables.PVE3RewardClaimed =
 +
{
 +
    NumItems = 1,
 +
    LootItems =
 +
    {
 +
        { Chance = 100, Template = "season7_mask_4", Unique = true, StackCount = 1 },
 +
    }
 +
}
 +
-- modify the PVP Tier 3 reward   
 +
ServerSettings.ChallengeSystem.RewardLootTables.PVP3RewardClaimed =
 +
{
 +
    NumItems = 1,
 +
    LootItems =
 +
    {
 +
        { Chance = 100, Template = "season7_mask_1", Unique = true, StackCount = 1 },
 +
    }
 +
}
 +
-- modify the amount of points needed
 +
ServerSettings.ChallengeSystem.PrizeOneTokensNeeded = 5000   
 +
ServerSettings.ChallengeSystem.PrizeTwoTokensNeeded = 10000 
 +
ServerSettings.ChallengeSystem.PrizeThreeTokensNeeded = 15000
 +
</syntaxhighlight >

Latest revision as of 18:01, 21 March 2022

Season Files

File Name Description
scripts.globals.mobile_effects.players.challegne_system mobile effect to display and handle the Season Challenge UI
scripts.globals.server_settings.seasons contains the Seasons Challenge table for editing rewards and UI variables
scripts.globals.helpers.seasons helper functions to support the Seasons Challenge system
scripts.globals.static_data.quests holds the quest tables for the Seasons Challenge system

Mod Example

Let us make a simple mod to the to allow to change the following on how a season works. First we will make a mod for the base file scripts.globals.serversettings.seasons.lua. We want to modify the way it behaves by doing the following...

  • Change the season # we are currently on (starting off at season 1)
  • Change the name of the season (displayed on the season UI)
  • Change Tier 1 reward cost from 2000 to 5000
  • Change Tier 2 reward cost from 4000 to 10000
  • Change Tier 2 reward cost from 8000 to 15000
  • Change Tier 3 PvE Reward template
  • Change Tier 3 PvP Reward Template

We want to create a new mod file inside your mods/YourModName/scripts/globals/server_settings/seasons.lua. Below is example of such a modification.

-- import the tables and functions from the original base script
require 'default:globals.server_settings.seasons'
-- the season number we are using
ServerSettings.ChallengeSystem.Season = 1
-- title for season window
ServerSettings.ChallengeSystem.SeasonTitle = "Season I: Season Name"
-- modify the PVE Tier 3 reward    
ServerSettings.ChallengeSystem.RewardLootTables.PVE3RewardClaimed = 
{
    NumItems = 1,
    LootItems = 
    { 
        { Chance = 100, Template = "season7_mask_4", Unique = true, StackCount = 1 },
    } 
}
-- modify the PVP Tier 3 reward    
ServerSettings.ChallengeSystem.RewardLootTables.PVP3RewardClaimed = 
{
    NumItems = 1,
    LootItems = 
    {
        { Chance = 100, Template = "season7_mask_1", Unique = true, StackCount = 1 },
    }
}
-- modify the amount of points needed
ServerSettings.ChallengeSystem.PrizeOneTokensNeeded = 5000    
ServerSettings.ChallengeSystem.PrizeTwoTokensNeeded = 10000   
ServerSettings.ChallengeSystem.PrizeThreeTokensNeeded = 15000