SM5 Unlock system

static const char *UnlockRewardTypeNames[] =

{

	"Song",

	"Steps",

	"StepsType",

	"Course",

	"Modifier",

};

# Changes applied to [UnlockManager] while SM is running

# don't get picked up when metrics are refreshed via Shift+F2 (it seems?)

# so, make sure things are the way you want them to be (or restart StepMania).



[UnlockManager]

# determine if songs loaded via the AdditionalSongs= line in Preferences.ini should be locked.

# I haven't experimented with this and don't know if it works.

SongsNotAdditional=false



# add an additional UnlockName for each song you want to lock

UnlockNames="1,2,3"



# replace the paths I provide here with your own

# replace the "code" with an unlock string you want your user to type in to perform the unlock

# codes NEED to all be unique; duplicate codes will cause SM to crash

Unlock1Command=song,"dbk5/Applause";code,"blah";

Unlock2Command=song,"dbk5/I Need Your Love";code,"blahblah";

Unlock3Command=song,"dbk5/Killin It - Mutrix Remix";code,"blahblahblah";

# this is for when we are in Free/Pay mode

[ScreenTitleJoin]

Fallback="ScreenTitleMenu"

ChoiceNames="1,2"

Choice1="applydefaultoptions;screen,ScreenSelectColor;text,Dance Mode"

Choice2="screen,ScreenUnlock;text,Enter Unlock Code"





# This screen prompts the user to type in an unlock code.

[ScreenUnlock]

Fallback="ScreenTextEntry"

PrevScreen="ScreenTitleJoin"

NextScreen="ScreenUnlock2"



QuestionY=_screen.cy-50





# This screen handles how to inform the user whether anything

# was successfully unlocked or not.

[ScreenUnlock2]

Fallback="ScreenPrompt"

PrevScreen="ScreenTitleJoin"

NextScreen="ScreenTitleJoin"

local TextEntrySettings = {

	-- ScreenMessage to send on pop (optional, "SM_None" if omitted)

	--SendOnPop = "",



	-- The question to display

	Question = "Enter your unlock code:",

	

	-- Initial answer text

	InitialAnswer = "",

	

	-- Maximum amount of characters

	MaxInputLength = 30,

	

	-- Validation function; function(answer, errorOut), must return boolean, string.

	Validate = nil,

	

	-- On OK; function(answer)

	OnOK = function(answer)

		UnlockSomeStuffMaybe(answer)

	end,

	

	-- On Cancel; function()

	OnCancel = nil,

	

	-- Validate appending a character; function(answer,append), must return boolean

	ValidateAppend = nil,

	

	-- Format answer for display; function(answer), must return string

	FormatAnswerForDisplay = nil,

}





local t =  Def.ActorFrame{	

	OnCommand=function(self)

		SCREENMAN:GetTopScreen():Load(TextEntrySettings)

	end

}



return t

-- by not prefixing "local" before this variable,

-- it will have global scope throughout your theme

-- and can be accessed from any other theme file

ItemThatWasJustUnlocked = nil



function UnlockSomeStuffMaybe(text)

	

	-- How many unlocks are there? Get the number.

	local HowMany = UNLOCKMAN:GetNumUnlocks()

	

	if HowMany > 0 then

		

		-- Use the text that was typed to see if it matches any "Codes" set under

		-- [UnlockManager] in your Metrics.ini

		local UnlockSongs = UNLOCKMAN:GetSongsUnlockedByEntryID(text)

		

		-- The line above returns a table whether it finds anything or not

		-- so check the size of that table.

		if #UnlockSongs > 0 then

			

			local group = UnlockSongs[1]:GetGroupName()

			local title = UnlockSongs[1]:GetDisplayFullTitle()

			

			-- create a path out of the song's group and title

			local path = group.."/"..title

					

			-- set the variable with global scope equal to the path

			-- we'll use this variable later on ScreenUnlock2

			ItemThatWasJustUnlocked = path

			

			--unlock that song using the text the user typed in

			UNLOCKMAN:UnlockEntryID(text)

		else

		

			-- the lookup didn't find any locked content that matched the typed text

			-- so set this variable to nil

			ItemThatWasJustUnlocked = nil

		end

	

	end

end

local t =  Def.ActorFrame{}



-- if something was unlocked, the ItemThatWasJustUnlocked variable will have been set

-- to be a path in the UnlockSomeStuffMaybe() function in your ./Scripts/Unlock.lua file

if ItemThatWasJustUnlocked then

	

	local song = SONGMAN:FindSong(ItemThatWasJustUnlocked)

	

	if song then

		

		-- attempt to find the banner for the song

		bannerpath = song:GetBannerPath()

		

		-- if a banner was found...

		if bannerpath then

			

			-- ... then display it!

			t[#t+1] = Def.Banner{

				Name="RewardBanner",

				InitCommand=cmd(xy, _screen.cx, _screen.cy-55; ),

				OnCommand=function(self)

					self:LoadFromSong(song)

					-- apply these after loading the banner

					self:setsize(418, 164)

					self:zoom(0.6)

				end

			}

		end

		

		-- regardless of banner or not-banner, display some reward text

		t[#t+1] = LoadFont("Common normal")..{

			Name="RewardText",

			InitCommand=cmd(xy, _screen.cx, 110; zoom,1.25),

			OnCommand=function(self)

				self:settext("You have unlocked: " .. ItemThatWasJustUnlocked)

			end

		}



		-- this is a sound to be played upon a successful unlock

		-- this looks in your theme's ./Sounds/ directory for a file called "_unlock.ogg"

		t[#t+1] = LoadActor( THEME:GetPathS("", "_unlock.ogg")	)..{ Name="songUnlocked"; }	

		

		-- play that sound

		t.OnCommand=function(self)

			if song then

				self:GetChild("songUnlocked"):play()

			end

		end

	end	





-- otherwise, nothing was unlocked, and the path variable is nil	

else

	

	t[#t+1] = LoadFont("Common normal")..{

		Name="FailureText",

		Text="Not quite...",

		InitCommand=cmd(xy, _screen.cx,_screen.cy-50; zoom,1.4)

	}



	-- this is a sound to be played upon a failure to unlock

	-- this looks in your theme's ./Sounds/ directory for a file called "_unlockFail.ogg"

	t[#t+1] = LoadActor( THEME:GetPathS("", "_unlockFail.ogg") )..{ Name="songNotUnlocked" }

	

	-- play that sound

	t.OnCommand=function(self)

		self:GetChild("songNotUnlocked"):play()

	end

end

-- either way, set this to nil again now

ItemThatWasJustUnlocked = nil



return t