[SM4] Custom MemoryCardDisplay Framework

[AJ 187]

hi I just made up this framework for a custom MemoryCardDisplay.

Comments should explain most of it.

If it's not clear/you didn't know, to broadcast a message, use
MESSAGEMAN:Broadcast("messageName")
and to send params, pass in a table as the second parameter
MESSAGEMAN:Broadcast("messageName",{ Param1 = "a", Param2 = true })

--[[
a custom MemoryCardDisplay | AJ @ KKI Labs

The basic idea is by capturing the messages sent about memory cards, as
well as being able to query the memory card state, one can make a custom
MemoryCardDisplay that isn't limited to being a Sprite.

I have included some example code that I would use if I were to flesh this
out fully. It is commented out since you may wish to implement
things differently. Feel free to use this. Interesting things await.
]]
local Player = ...;
assert(Player)

local MemCardDisplay = Def.ActorFrame{};
--[[ begin heavy lifting code ]]
-- parts list:
-- (1) list of states
local cardStates = {
	'MemoryCardState_ready',
	'MemoryCardState_checking',
	'MemoryCardState_late',
	'MemoryCardState_error',
	'MemoryCardState_removed',
	'MemoryCardState_none'
};
-- (1) knowledge of MEMCARDMAN:GetCardState(Player);
-- (2) knowledge of messages
-- 		Message_StorageDevicesChanged
--		(MessageID)(Message_CardRemovedP 1+p); // so 1 or 2

-- the gameplan
-- Message_StorageDevicesChanged is our reset function. It may as well be
-- 		treated as the init function as well, for safety. Might get lucky.

local lastSeenState = 'MemoryCardState_Invalid';

MemCardDisplay[#MemCardDisplay+1] = Def.Actor{
	Name="Controller";
	UpdateCommand=function(self)
		local newMcs = MEMCARDMAN:GetCardState(Player);
		if lastSeenState ~= newMcs then
			-- if you have a generic command you want to do when the state
			-- is changed, place it here.

			-- specific instances are checked below:
			--[[
			for i=1,#cardStates do
				if newMcs == cardStates[i] then
					-- swap states here.
					-- if this were me, it'd be:
					--MESSAGEMAN:Broadcast("CardStateOn",{ State = newMcs });
				end;
				-- this part is optional but recommended if using my method.
				if lastSeenState == cardStates[i] then
					--MESSAGEMAN:Broadcast("CardStateOff",{ State = newMcs });
				end;
			end
			]]

			-- StepMania's MemoryCardDisplay just sets the visible values
			-- of the different sprites.

			-- if this were completely implemented by me, I would broadcast
			-- a message with two parameters, on and off. Ideally, these would
			-- be the names of the Actors/ActorFrames/whatever, and they would
			-- have two MessageCommands:
			-- CardStateOnMessageCommand({State})	-- called when CardState is turned on
			-- CardStateOffMessageCommand({State})	-- called when CardState is turned off

			-- and finally update the lastSeenState.
			lastSeenState = newMcs;
		end;
	end;
	StorageDevicesChangedMessageCommand=function(self)
		-- init code
	end;
	CardRemovedP1MessageCommand=function(self)
		if Player == PLAYER_1 then
			-- cleanup, play animation
			--MESSAGEMAN:Broadcast("CardStateOff",{ State = newMcs });
		end;
	end;
	CardRemovedP2MessageCommand=function(self)
		if Player == PLAYER_2 then
			-- cleanup, play animation
			--MESSAGEMAN:Broadcast("CardStateOff",{ State = newMcs });
		end;
	end;
};
--[[ end heavy lifting code ]]
return MemCardDisplay;

If you decide to go down the path I did when implementing this, you just basically add CardStateOnMessageCommand/CardStateOffMessageCommand to an ActorFrame containing your objects for the state. My implementation would include an ActorFrame per state to separate everything out. Perhaps you could even put them in their own Lua files and just pull them in with a LoadActor.

[FSX]

This is pretty cool!