story/layna_village/layna_village_well_underground_script.lua

-- Set the namespace according to the map name.
local ns = {};
setmetatable(ns, {__index = _G});
layna_village_well_underground_script = ns;
setfenv(1, ns);

-- The map name, subname and location image
map_name = "Mountain Village of Layna"
map_image_filename = "data/story/common/locations/mountain_village.png"
map_subname = "Well Undergrounds"

-- The music file used as default background music on this map.
-- Other musics will have to handled through scripting.
music_filename = "data/music/shrine-OGA-yd.ogg"

-- c++ objects instances
local Map = nil
local Script = nil
local EventManager = nil

-- Characters handler
local bronann = nil
local olivia = nil
local hero = nil

-- the main map loading code
function Load(m)

    Map = m;
    Script = Map:GetScriptSupervisor()
    EventManager = Map:GetEventSupervisor()

    _CreateCharacters()
    _CreateObjects()

    -- Put last to get a proper night effect
    Script:AddScript("data/story/common/lost_in_darkness.lua");

    -- Set the camera focus on bronann
    Map:SetCamera(bronann)

    _CreateEvents()
    _CreateZones()
    _CreateEnemies()
end

-- the map update function handles checks done on each game tick.
function Update()
    -- Check whether the character is in one of the zones
    _CheckZones()

    _UpdateLampLocation()

    _CheckMonstersState()
end

-- Character creation
function _CreateCharacters()

    bronann = CreateSprite(Map, "Bronann", 18, 3, vt_map.MapMode.GROUND_OBJECT)
    bronann:SetDirection(vt_map.MapMode.SOUTH)
    bronann:SetMovementSpeed(vt_map.MapMode.NORMAL_SPEED)
    hero = bronann

    olivia = CreateNPCSprite(Map, "Girl1", vt_system.Translate("Olivia"), 18, 3, vt_map.MapMode.GROUND_OBJECT)
    olivia:SetDirection(vt_map.MapMode.SOUTH)
    olivia:SetMovementSpeed(vt_map.MapMode.NORMAL_SPEED)
end

-- oil lamp
local oil_lamp = nil
local lamp_halo = nil
local lamp_flare = nil

-- The heal particle effect map object
local heal_effect = nil

function _CreateObjects()
    -- Info sign
    local object = CreateObject(Map, "Wood sign info", 5, 12, vt_map.MapMode.GROUND_OBJECT)
    object:SetEventWhenTalking("Info about equipment")
    local dialogue = vt_map.SpriteDialogue.Create();
    local text = vt_system.Translate("Did you know?\nYou can equip weapons and armors from the menu.\nSimply open it and go to 'Inventory', and 'Equip'.");
    dialogue:AddLine(text, nil);
    local event = vt_map.DialogueEvent.Create("Info about equipment", dialogue)

    oil_lamp = CreateObject(Map, "Oil Lamp", 15, 14, vt_map.MapMode.GROUND_OBJECT)
    oil_lamp:SetCollisionMask(vt_map.MapMode.NO_COLLISION)
    local lamp_x_pos = oil_lamp:GetXPosition()
    local lamp_y_pos = oil_lamp:GetYPosition()

    lamp_halo = vt_map.Halo.Create("data/visuals/lights/torch_light_mask2.lua", lamp_x_pos, lamp_y_pos,
        vt_video.Color(0.9, 0.9, 0.4, 0.5))
    lamp_flare = vt_map.Halo.Create("data/visuals/lights/sun_flare_light_main.lua", lamp_x_pos, lamp_y_pos,
        vt_video.Color(0.99, 1.0, 0.27, 0.2))
    _SetLampPosition(lamp_x_pos, lamp_y_pos)

    -- hide it when the intro event is not done yet.
    if (GlobalManager:GetGameEvents():DoesEventExist("story", "well_intro_event_done") == false) then
        oil_lamp:SetVisible(false)
        lamp_halo:SetVisible(false)
        lamp_flare:SetVisible(false)
    end

    -- Add the heal icon
    local npc = CreateObject(Map, "Layna Statue", 11, 10, vt_map.MapMode.GROUND_OBJECT);
    npc:SetCollisionMask(vt_map.MapMode.NO_COLLISION);
    npc:SetInteractionIcon("data/gui/map/heal_anim.lua")
    npc = CreateSprite(Map, "Butterfly", 11, 10, vt_map.MapMode.GROUND_OBJECT);
    npc:SetCollisionMask(vt_map.MapMode.NO_COLLISION);
    npc:SetVisible(false);
    npc:SetName(""); -- Unset the speaker name
    dialogue = vt_map.SpriteDialogue.Create();
    text = vt_system.Translate("Your party feels better.");
    dialogue:AddLineEvent(text, npc, "Well entrance heal", "");
    npc:AddDialogueReference(dialogue);

    vt_map.ScriptedEvent.Create("Well entrance heal", "heal_party", "heal_done");

    -- Load the spring heal effect.
    heal_effect = vt_map.ParticleObject.Create("data/visuals/particle_effects/heal_particle.lua", 0, 0, vt_map.MapMode.GROUND_OBJECT);
    heal_effect:Stop(); -- Don't run it until the character heals itself

    CreateObject(Map, "Rock1", 59, 11.2, vt_map.MapMode.GROUND_OBJECT)
    CreateObject(Map, "Rock1", 3, 43, vt_map.MapMode.GROUND_OBJECT)
    CreateObject(Map, "Rock1", 5.5, 43.2, vt_map.MapMode.GROUND_OBJECT)
    CreateObject(Map, "Rock1", 60, 25, vt_map.MapMode.GROUND_OBJECT)

    local chest = CreateTreasure(Map, "well_underground_chest", "Wood_Chest2", 57, 11.5, vt_map.MapMode.GROUND_OBJECT)
    chest:AddItem(1, 3)
end

local lamp_character = nil

function _UpdateLampLocation()
    -- Stick the lamp to a given character reference
    -- if the reference is nil, just let the lamp where it is.
    if (lamp_character == nil) then
        return
    end

    -- Sets the lamp location depending on the character's location and orientation
    local character_direction = lamp_character:GetDirection()
    local x_pos = lamp_character:GetXPosition()
    local y_pos = lamp_character:GetYPosition()
    local x_offset = 0.0
    local y_offset = 0.0
    if (character_direction == vt_map.MapMode.WEST
            or character_direction == vt_map.MapMode.NW_WEST
            or character_direction == vt_map.MapMode.SW_WEST) then
        x_offset = -0.5
        y_offset = -0.5
    elseif (character_direction == vt_map.MapMode.EAST
            or character_direction == vt_map.MapMode.NE_EAST
            or character_direction == vt_map.MapMode.SE_EAST) then
        x_offset = 0.5
        y_offset = -0.5
    elseif (character_direction == vt_map.MapMode.NORTH
            or character_direction == vt_map.MapMode.NW_NORTH
            or character_direction == vt_map.MapMode.NE_NORTH) then
        x_offset = -0.5
        y_offset = -0.5
    elseif (character_direction == vt_map.MapMode.SOUTH
            or character_direction == vt_map.MapMode.SW_SOUTH
            or character_direction == vt_map.MapMode.SE_SOUTH) then
        x_offset = 0.5
        y_offset = -0.5
    end

    _SetLampPosition(x_pos + x_offset, y_pos + y_offset)
end

-- Handles the fixed offsets betwwen the oil_lamp object, and the related ones
function _SetLampPosition(x, y)
    oil_lamp:SetPosition(x, y)
    lamp_halo:SetPosition(x, y + 4.0)
    lamp_flare:SetPosition(x, y + 2.0)
end

-- Special roam zones used to test whether Bronann did the fights
local roam_zone1 = nil
local roam_zone2 = nil
local roam_zone3 = nil
local rats_beaten = false

function _CreateEnemies()
    local enemy = nil

    -- Hint: left, right, top, bottom
    roam_zone1 = vt_map.EnemyZone.Create(48, 61, 2, 20)
    enemy = CreateEnemySprite(Map, "ratto")
    _SetBattleEnvironment(enemy)
    enemy:NewEnemyParty()
    enemy:AddEnemy(22)
    roam_zone1:AddEnemy(enemy, 2)
    roam_zone1:SetSpawnsLeft(1); -- This monster shall spawn only one time.

    -- Hint: left, right, top, bottom
    roam_zone2 = vt_map.EnemyZone.Create(2, 10, 42, 63)
    enemy = CreateEnemySprite(Map, "ratto")
    _SetBattleEnvironment(enemy)
    enemy:NewEnemyParty()
    enemy:AddEnemy(22)
    roam_zone2:AddEnemy(enemy, 2)
    roam_zone2:SetSpawnsLeft(1); -- This monster shall spawn only one time.

    -- Hint: left, right, top, bottom
    roam_zone3 = vt_map.EnemyZone.Create(58, 60, 58, 60)
    enemy = CreateEnemySprite(Map, "ratto")
    _SetBattleEnvironment(enemy)
    enemy:NewEnemyParty()
    enemy:AddEnemy(22)
    enemy:AddEnemy(22)
    enemy:SetBoss(true)
    roam_zone3:AddEnemy(enemy, 1)
    roam_zone3:SetSpawnsLeft(1); -- This monster shall spawn only one time.
end

function _CheckMonstersState()
    if (rats_beaten == false and roam_zone1:GetSpawnsLeft() == 0 and roam_zone2:GetSpawnsLeft() == 0 and roam_zone3:GetSpawnsLeft() == 0) then
        if (GlobalManager:GetGameEvents():DoesEventExist("story", "well_rats_beaten") == false) then
            rats_beaten = true

            -- Update Olivia dialogue to let Bronann go out
            olivia:ClearDialogueReferences()
            local dialogue = vt_map.SpriteDialogue.Create()
            local text = vt_system.Translate("Congratulations, Bronann. Here is your reward.")
            dialogue:AddLineEmote(text, olivia, "exclamation")
            dialogue:SetEventAtDialogueEnd("Bronann receives reward")
            olivia:AddDialogueReference(dialogue)

            local event = vt_map.TreasureEvent.Create("Bronann receives reward");
            event:AddItem(40002, 1) -- Long leather gloves
            event:AddEventLinkAtEnd("Olivia leaves");

            event = vt_map.PathMoveSpriteEvent.Create("Olivia leaves", olivia, 18, 1, false)
            event:AddEventLinkAtEnd("Set Olivia invisible")

            event = vt_map.ScriptedEvent.Create("Set Olivia invisible", "make_olivia_invisible", "")

            -- Set intro event as done
            GlobalManager:GetGameEvents():SetEventValue("story", "well_rats_beaten", 1);
        end
    end
end

-- Sets common battle environment settings for enemy sprites
function _SetBattleEnvironment(enemy)
    enemy:SetBattleMusicTheme("data/music/heroism-OGA-Edward-J-Blakeley.ogg")
    enemy:SetBattleBackground("data/battles/battle_scenes/desert_cave/desert_cave.png")
    enemy:AddBattleScript("data/battles/battle_scenes/desert_cave_battle_anim.lua")
    enemy:AddBattleScript("data/story/common/lost_in_darkness.lua")
    -- Add tutorial battle dialog with Olivia
    enemy:AddBattleScript("data/story/common/tutorial_battle_dialogs.lua");
    -- TODO: Add oil lamp as scenery in battles
end

-- Creates all events and sets up the entire event sequence chain
function _CreateEvents()
    local event = nil
    local dialogue = nil
    local text = nil

    -- Triggered events
    vt_map.MapTransitionEvent.Create("exit floor", "data/story/layna_village/layna_village_center_map.lua",
                                     "data/story/layna_village/layna_village_center_script.lua",
                                     "from_well_undergrounds")

    -- Generic events
    vt_map.LookAtSpriteEvent.Create("Olivia looks at Bronann", olivia, bronann)
    vt_map.LookAtSpriteEvent.Create("Bronann looks at Olivia", bronann, olivia)
    vt_map.ChangeDirectionSpriteEvent.Create("Bronann looks south", bronann, vt_map.MapMode.SOUTH)
    vt_map.ChangeDirectionSpriteEvent.Create("Bronann looks east", bronann, vt_map.MapMode.EAST)

    if (GlobalManager:GetGameEvents():DoesEventExist("story", "well_intro_event_done") == false) then
        event = vt_map.ScriptedEvent.Create("Well undergrounds scene start", "well_intro_scene_start", "")
        event:AddEventLinkAtEnd("Olivia takes a few steps")

        event = vt_map.PathMoveSpriteEvent.Create("Olivia takes a few steps", olivia, 18, 13, false)
        event:AddEventLinkAtEnd("Olivia shows the oil lamp", 1000)

        event = vt_map.ScriptedEvent.Create("Olivia shows the oil lamp", "oil_lamp_move_start", "oil_lamp_move_update")
        event:AddEventLinkAtEnd("Olivia lights the oil lamp", 1000)

        event = vt_map.ScriptedEvent.Create("Olivia lights the oil lamp", "oil_lamp_light", "")
        event:AddEventLinkAtEnd("Olivia looks at Bronann", 1000)
        event:AddEventLinkAtEnd("Olivia goes near the fountain", 2000)

        event = vt_map.PathMoveSpriteEvent.Create("Olivia goes near the fountain", olivia, 10, 14, false)
        event:AddEventLinkAtEnd("Olivia looks at Bronann")
        event:AddEventLinkAtEnd("Olivia tells Bronann to come in the undergrounds", 1000)

        dialogue = vt_map.SpriteDialogue.Create()
        text = vt_system.Translate("You can come, Bronann.")
        dialogue:AddLine(text, olivia)
        event = vt_map.DialogueEvent.Create("Olivia tells Bronann to come in the undergrounds", dialogue)
        event:AddEventLinkAtEnd("Bronann goes near Olivia")

        event = vt_map.PathMoveSpriteEvent.Create("Bronann goes near Olivia", bronann, 12, 14, false)
        event:AddEventLinkAtEnd("Bronann looks at Olivia")
        event:AddEventLinkAtEnd("Olivia tells Bronann about the undergrounds", 1000)

        dialogue = vt_map.SpriteDialogue.Create()
        text = vt_system.Translate("This is one of the many secrets of this village.")
        dialogue:AddLine(text, olivia)
        text = vt_system.Translate("This village was once a sanctuary and many people lived around here. Surprising, eh?")
        dialogue:AddLineEvent(text, olivia, "", "Bronann looks south")
        text = vt_system.Translate("Your father told me you were now ready.")
        dialogue:AddLineEvent(text, olivia, "", "Bronann looks east")
        text = vt_system.Translate("Huh? Ready for what?")
        dialogue:AddLineEmote(text, bronann, "exclamation")
        text = vt_system.Translate("For your first true trial.")
        dialogue:AddLineEvent(text, olivia, "Olivia looks at Bronann", "")
        text = vt_system.Translate("I know I will sound harsh Bronann, but we've been having issues with rats in the well recently.")
        dialogue:AddLineEvent(text, olivia, "Bronann looks at Olivia", "")
        text = vt_system.Translate("You're now going to go deep down this cave and chase them all before they start polluting our water.")
        dialogue:AddLine(text, olivia)
        text = vt_system.Translate("All by yourself.")
        dialogue:AddLine(text, olivia)
        text = vt_system.Translate("I'll stay around but I won't participate. This... will prepare you for the days to come.")
        dialogue:AddLineEmote(text, olivia, "thinking dots")
        text = vt_system.Translate("Take this lamp, your father gave it to me earlier. You can keep it.")
        dialogue:AddLineEvent(text, olivia, "Move lamp near Bronann", "")

        event = vt_map.ScriptedEvent.Create("Move lamp near Bronann", "move_lamp_to_bronann_start", "move_lamp_to_bronann_update")

        text = vt_system.Translate("You can use the fountain here to restore your health, but you are to complete this before going out again. Not too afraid?")
        dialogue:AddLine(text, olivia)
        text = vt_system.Translate("I'm completely panicking, Olivia. Why now?")
        dialogue:AddLineEmote(text, bronann, "exclamation")
        text = vt_system.Translate("It will be fine.")
        dialogue:AddLine(text, olivia)
        event = vt_map.DialogueEvent.Create("Olivia tells Bronann about the undergrounds", dialogue)
        event:AddEventLinkAtEnd("Olivia goes to the entrance and watch")

        event = vt_map.PathMoveSpriteEvent.Create("Olivia goes to the entrance and watch", olivia, 18, 6, false)
        event:AddEventLinkAtEnd("Olivia looks at Bronann")
        event:AddEventLinkAtEnd("Olivia tells Bronann to go")

        dialogue = vt_map.SpriteDialogue.Create()
        text = vt_system.Translate("You can make it.")
        dialogue:AddLine(text, olivia)
        event = vt_map.DialogueEvent.Create("Olivia tells Bronann to go", dialogue)
        event:AddEventLinkAtEnd("Well undergrounds scene end")

        event = vt_map.ScriptedEvent.Create("Well undergrounds scene end", "well_intro_scene_end", "")

        -- Make the whole scene start at map fade in
        EventManager:StartEvent("Well undergrounds scene start");
    elseif (GlobalManager:GetGameEvents():DoesEventExist("story", "well_rats_beaten") == false) then
        -- Should not happen
    else
        -- Stick the lamp to Bronann and make it visible
        lamp_character = bronann
        oil_lamp:SetVisible(true)
        lamp_halo:SetVisible(true)
        lamp_flare:SetVisible(true)

        -- Disable Olivia when the event is done.
        olivia:SetVisible(false)
        olivia:SetPosition(0, 0)
    end
end

-- zones
local room_exit_zone = nil

-- Create the different map zones triggering events
function _CreateZones()
    -- N.B.: left, right, top, bottom
    room_exit_zone = vt_map.CameraZone.Create(16, 18, 0, 1)
end

-- Check whether the active camera has entered a zone. To be called within Update()
function _CheckZones()
    if (room_exit_zone:IsCameraEntering() == true) then
        bronann:SetMoving(false);
        EventManager:StartEvent("exit floor")
    end
end


-- Map Custom functions
-- Used through scripted events

local oil_lamp_move_x_pos = 0
local oil_lamp_move_y_pos = 0
local oil_lamp_move_y_pos_end = 0
local oil_lamp_move_y_pos_end = 0

-- Effect time used when applying the heal light effect
local heal_effect_time = 0;
local heal_color = vt_video.Color(0.0, 0.0, 1.0, 1.0);

map_functions = {

    well_intro_scene_start = function()
        Map:PushState(vt_map.MapMode.STATE_SCENE)
        bronann:SetMoving(false)
    end,

    -- make oil lamp appear in front of Olivia
    oil_lamp_move_start = function()
        oil_lamp_move_y_pos = olivia:GetYPosition() - 1.0
        _SetLampPosition(olivia:GetXPosition() + 0.5, oil_lamp_move_y_pos)
        oil_lamp:SetVisible(true)
        oil_lamp_move_y_pos_end = oil_lamp_move_y_pos + 0.5
    end,

    oil_lamp_move_update = function()
        oil_lamp_move_y_pos = oil_lamp_move_y_pos + SystemManager:GetUpdateTime() / 200
        _SetLampPosition(olivia:GetXPosition() + 0.5, oil_lamp_move_y_pos)
        if (oil_lamp_move_y_pos < oil_lamp_move_y_pos_end) then
            return false
        end
        -- Stick the lamp to Olivia
        lamp_character = olivia
        return true
    end,

    oil_lamp_light = function()
        lamp_flare:SetVisible(true)
        lamp_halo:SetVisible(true)
    end,

    move_lamp_to_bronann_start = function()
        -- unstick lamp from Olivia
        lamp_character = nil
        -- Set starting coords
        oil_lamp_move_x_pos = oil_lamp:GetXPosition()
        oil_lamp_move_y_pos = oil_lamp:GetYPosition()
        oil_lamp_move_x_pos_end = oil_lamp_move_x_pos + 0.5
        oil_lamp_move_y_pos_end = oil_lamp_move_y_pos - 0.5
    end,

    move_lamp_to_bronann_update = function()
        local move_update = SystemManager:GetUpdateTime() / 200
        _SetLampPosition(oil_lamp_move_x_pos, oil_lamp_move_y_pos)
        if (oil_lamp_move_y_pos > oil_lamp_move_y_pos_end) then
            oil_lamp_move_y_pos = oil_lamp_move_y_pos - move_update
            return false
        end
        if (oil_lamp_move_x_pos < oil_lamp_move_x_pos_end) then
            oil_lamp_move_x_pos = oil_lamp_move_x_pos + move_update
            return false
        end
        -- Stick the lamp to Bronann
        lamp_character = bronann
        return true
    end,

    well_intro_scene_end = function()
        -- Set new Olivia dialogue
        olivia:ClearDialogueReferences()
        local dialogue = vt_map.SpriteDialogue.Create()
        local text = vt_system.Translate("Bronann. Sorry, you have to complete this first.")
        dialogue:AddLine(text, olivia)
        text = vt_system.Translate("You can use the fountain here to restore your health.")
        dialogue:AddLine(text, olivia)
        olivia:AddDialogueReference(dialogue)
        -- Set intro event as done
        GlobalManager:GetGameEvents():SetEventValue("story", "well_intro_event_done", 1)
        Map:PopState()
    end,

    heal_party = function()
        hero:SetMoving(false);
        -- Should be sufficient to heal anybody
        local character_handler = GlobalManager:GetCharacterHandler()
        character_handler:GetActiveParty():AddHitPoints(10000)
        character_handler:GetActiveParty():AddSkillPoints(10000)
        Map:SetStamina(10000)
        Map:RemoveNegativeActiveStatusEffects()
        AudioManager:PlaySound("data/sounds/heal_spell.wav");
        heal_effect:SetPosition(hero:GetXPosition(), hero:GetYPosition());
        heal_effect:Start();
        heal_effect_time = 0;
    end,

    heal_done = function()
        heal_effect_time = heal_effect_time + SystemManager:GetUpdateTime();

        if (heal_effect_time < 300.0) then
            heal_color:SetAlpha(heal_effect_time / 300.0 / 3.0);
            Map:GetEffectSupervisor():EnableLightingOverlay(heal_color);
            return false;
        end

        if (heal_effect_time < 1000.0) then
            heal_color:SetAlpha(((1000.0 - heal_effect_time) / 700.0) / 3.0);
            Map:GetEffectSupervisor():EnableLightingOverlay(heal_color);
            return false;
        end
        return true;
    end,

    make_olivia_invisible = function()
        olivia:SetVisible(false)
        olivia:SetPosition(0, 0)
    end,
}