--[[
MM_K_06.lua
SR3 Mission Script
DATE: 11-15-2010
AUTHOR: Jimmy Cross
]]--
-- Debug flags --
-- Tweakable Parameters --
-- Groups --
-- Navpoints --
MM_K_06_navs = { cp_start = { player_local = "local_player",
player_remote = "remote_player"
}
}
-- Triggers --
MM_K_06_trigger = { crib = { name = "KC_trigger",
hit = false
}
}
-- Characters --
-- Vehicles --
-- Mesh Movers --
-- Text --
-- Threads --
-- Checkpoints --
MM_K_06_checkpoint = { start = { name = MISSION_START_CHECKPOINT,
nav1 = "start_nav 001",
nav2 = "start_nav 002"
}
}
-- Cutscenes --
MM_K_06_cutscene = { kinzie_outro = "K_Z03"
--kinzie_outro = ""
}
CUTSCENE_MISSION_INTRO = ""
CUTSCENE_MISSION_OUTRO = ""
-- Conversations --
MM_K_06_convo = { kinzie_call = { name = "MM_K_06_End_Phone_Call",
handle = INVALID_CONVERSATION_HANDLE,
kinzie_persona_name = "Phone_Call",
kinzie_persona_id = INVALID_PERSONA_HANDLE,
},
}
-- Other --
Mm_k_06_call_ended = false
-- *************************
--
-- Standard functions
--
-- *************************
-- This is the primary entry point for the mission, and is responsible for starting up the mission
-- at the specified checkpoint.
-- CALLED FROM CODE
--
-- checkpoint: The checkpoint the mission should begin at
-- is_restart: TRUE if the mission is restarting, FALSE otherwise
--
function MM_K_06_start(checkpoint, is_restart)
-- Check if this mission starting from the beginning
if (checkpoint == MM_K_06_checkpoint.start.name) then
if (is_restart == false) then
-- First time playing mission
end
--fade_out(0)
end
-- Handle mission initialization for the current checkpoint
MM_K_06_initialize(checkpoint)
-- Run the mission from the current checkpoint
MM_K_06_run(checkpoint)
end
-- This is the primary function responsible for running the entire mission from start to finish.
--
-- first_checkpoint: The first checkpoint to begin running the mission at
--
function MM_K_06_run(first_checkpoint)
Mm_k_06_call_ended = false
MM_K_06_convo.kinzie_call.persona_id = audio_persona_load_2d( MM_K_06_convo.kinzie_call.kinzie_persona_name)
-- Play the conversation
audio_play_for_mission_cellphone( MM_K_06_convo.kinzie_call.name, true, true, "", "mm_k_06_end_call")
while not Mm_k_06_call_ended do
thread_yield()
end
mission_set_completed("mm_k_06") mission_end_silently(false)
mission_autosave()
end
-- This is the primary function responsible for cleaning up the entire mission
-- CALLED FROM CODE (+++MUST RETURN IMMEDIATLY+++)
--
function MM_K_06_cleanup()
--[[ INSERT ANY MISSION SPECIFIC CLEAN-UP ]]--
audio_remove_mission_cellphone(MM_K_06_convo.kinzie_call.name)
if (MM_K_06_convo.kinzie_call.persona_id ~= INVALID_PERSONA_HANDLE) then
audio_persona_remove_2d(MM_K_06_convo.kinzie_call.persona_id)
MM_K_06_convo.kinzie_call.persona_id = INVALID_PERSONA_HANDLE
end
end
-- Called when the mission has ended with success
-- CALLED FROM CODE (+++MUST RETURN IMMEDIATLY+++)
--
function MM_K_06_success()
--[[ INSERT ANY MISSION SPECIFIC SUCCESS STUFF ]]--
end
-- *************************
--
-- Local functions
--
-- *************************
-- Initialize the mission for the specified checkpoint
--
-- checkpoint: Checkpoint to initialize the mission to
--
function MM_K_06_initialize(checkpoint)
-- Make sure the screen is completly faded out
--mission_start_fade_out(0.0)
-- Set the mission author
set_mission_author("Jimmy Cross")
-- Common initialization
MM_K_06_initialize_common()
-- Checkpoint specific initialization
MM_K_06_initialize_checkpoint(checkpoint)
-- Start fading in
mission_start_fade_in()
end
-- ***************************************************
-- MM_K_06_run Helper Functions
-- ***************************************************
-- ***************************************************
-- MM_K_06_initialize Helper Functions
-- ***************************************************
-- Handle any common initialization
--
function MM_K_06_initialize_common()
--[[ INSERT ANY COMMON INITIALIZATION CODE HERE ]]--
end
-- Checkpoint specific initialization
--
-- checkpoint: The checkpoint to be initialized
function MM_K_06_initialize_checkpoint(checkpoint)
if (checkpoint == MM_K_06_checkpoint.start.name) then
--[[ INSERT ANY INITIALIZATION CODE FOR STARTING THE MISSION AT THE BEGINNING ]]--
end
end
-- ***************************************************
-- Miscellaneous MM_K_06 Helper Functions
-- ***************************************************
function MM_K_06_clear_trigger(trigger)
on_trigger( "", trigger )
trigger_enable( trigger, false )
marker_remove_trigger( trigger, SYNC_ALL )
end
-- *************************
--
-- Callback functions
--
-- *************************
-- Trigger callback, used to handle the start of the activity and silent failing of the mission
--
--
function MM_K_06_kc_trigger_cb()
-- clear the trigger, waypoint, and objective
MM_K_06_trigger.crib.hit = true
MM_K_06_clear_trigger( MM_K_06_trigger.crib.name )
waypoint_remove()
objective_text_clear(0) -- clear the objective text
end
function mm_k_06_end_call()
Mm_k_06_call_ended = true
end
-- *************************
--
-- Thread functions
--
-- *************************