--[[
MM_Z_01.lua
SR3 Mission Script
DATE: 10-29-2010
AUTHOR: Jimmy Cross
]]--
-- Debug flags --
-- Tweakable Parameters --
-- Groups --
MM_Z_01_group = { npcs = { name = "MM_Z_01_NPC",
zimos = "MM_Z_01_NPC_Zimos"
}
}
-- Navpoints --
MM_Z_01_navs = { cp_start = { player_local = "local_player",
player_remote = "remote_player"
}
}
-- Triggers --
MM_Z_01_trigger = {
}
-- Characters --
-- Vehicles --
-- Mesh Movers --
-- Text --
-- Threads --
-- Checkpoints --
MM_Z_01_checkpoint = { start = { name = MISSION_START_CHECKPOINT,
nav1 = "start_nav 001",
nav2 = "start_nav 002"
}
}
-- Cutscenes --
MM_Z_01_cutscene = { zimos_intro = "Z_Z01"
--zimos_intro = ""
}
CUTSCENE_MISSION_INTRO = ""
CUTSCENE_MISSION_OUTRO = ""
-- Conversations --
MM_Z_01_convo = { --[[mission_start = { name = "MM_Z_01_convo_1",
handle = INVALID_CONVERSATION_HANDLE
}
]]--
}
-- Other --
-- *************************
--
-- 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_Z_01_start(checkpoint, is_restart)
-- Check if this mission starting from the beginning
if (checkpoint == MM_Z_01_checkpoint.start.name) then
if (is_restart == false) then
-- First time playing mission
if( MM_Z_01_cutscene.zimos_intro ~= "" ) then
--cutscene_in()
zscene_prep( MM_Z_01_cutscene.zimos_intro )
while( not zscene_is_loaded(MM_Z_01_cutscene.zimos_intro) ) do
thread_yield()
end
cutscene_play( MM_Z_01_cutscene.zimos_intro, nil, nil, false )
--group_create( MM_Z_01_group.npcs.name, true ) --create the NPC group
--teleport_coop( MM_Z_01_navs.cp_start.player_local, MM_Z_01_navs.cp_start.player_remote, true )
--bink_play( MM_Z_01_cutscene.zimos_intro )
--fade_in( 0.5 )
--fade_in_block()
--cutscene_out()
else
fade_out( 0.5 )
fade_out_block()
--group_create( MM_Z_01_group.npcs.name, true ) --create the NPC group
delay( 1.5 )
fade_in( 0.5 )
fade_in_block()
end
end
--fade_out(0)
end
-- Handle mission initialization for the current checkpoint
MM_Z_01_initialize(checkpoint)
-- Run the mission from the current checkpoint
MM_Z_01_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_Z_01_run(first_checkpoint)
local current_checkpoint = first_checkpoint
-- Run the mission from the beginning
if( current_checkpoint == MM_Z_01_checkpoint.start.name ) then
fade_out(0)
fade_out_block()
mission_end_to_activity("MM_Z_01", "_A_SN_NE_01") end
end
-- This is the primary function responsible for cleaning up the entire mission
-- CALLED FROM CODE (+++MUST RETURN IMMEDIATLY+++)
--
function MM_Z_01_cleanup()
--[[ INSERT ANY MISSION SPECIFIC CLEAN-UP ]]--
end
-- Called when the mission has ended with success
-- CALLED FROM CODE (+++MUST RETURN IMMEDIATLY+++)
--
function MM_Z_01_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_Z_01_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_Z_01_initialize_common()
-- Checkpoint specific initialization
MM_Z_01_initialize_checkpoint(checkpoint)
-- Don't bother fading in, this mission is only a cutscene
--mission_start_fade_in()
end
-- ***************************************************
-- MM_Z_01_run Helper Functions
-- ***************************************************
-- ***************************************************
-- MM_Z_01_initialize Helper Functions
-- ***************************************************
-- Handle any common initialization
--
function MM_Z_01_initialize_common()
--[[ INSERT ANY COMMON INITIALIZATION CODE HERE ]]--
end
-- Checkpoint specific initialization
--
-- checkpoint: The checkpoint to be initialized
function MM_Z_01_initialize_checkpoint(checkpoint)
if (checkpoint == MM_Z_01_checkpoint.start.name) then
--[[ INSERT ANY INITIALIZATION CODE FOR STARTING THE MISSION AT THE BEGINNING ]]--
end
end
-- ***************************************************
-- Miscellaneous MM_Z_01 Helper Funcrtions
-- ***************************************************
function MM_Z_01_clear_trigger(trigger)
end
-- *************************
--
-- Callback functions
--
-- *************************
-- *************************
--
-- Thread functions
--
-- *************************