[MoonLoader] Mission Script Template

25 Mar 2021, 04:09

Hey guys.

I have figured out how to write a mission script using MoonLoader.

It works similar to SCM missions scripts, i.e., it supports:

Only starting if the player is not on a mission.
Setting and clearing the ONMISSION flag.
Checking if the player has died or been arrested.
Checking if the mission has been aborted (opcode 045C).
Mission passed text.
Mission failed text.
Mission cleanup.

Note: If the script terminates (reloads, unloads or crashes) while the mission is running, then the mission will abruptly end.

Here is the code:

Código: Selecionar tudo

-- be sure to change >>
script_author("HzanRsxa2959")
script_description("Template for a MoonLoader mission script.")
-- << be sure to change

local script = thisScript()
local onmission

local PLAYER_PED

-- declare and initialize global script variables here >>>
local ped
-- <<< declare and initialize global script variables here

-- call functions here >>>
-- <<< call functions here

function main()
	PLAYER_PED = select(2, getPlayerChar(0) )

	lua_thread.create(missionManager)

	-- call functions here if they can't be called outside >>>
	-- <<< call functions here if they can't be called outside

	while true do
		if readMemory(0x96ABA0, 1) == 0 then -- is not on mission

			local trigger

			-- mission trigger conditions, set "trigger" to "true" when they meet >>>
			if testCheat("MOONMIS") then -- type "MOONMIS" to trigger
				trigger = true
			end
			-- <<< mission trigger conditions, set "trigger" to "true" when they meet

			if trigger then
				lua_thread.create(mission)
			end
		end

		wait(0)
	end
end

function mission()
	onmission = true

	setGameGlobal(409, 1)

	-- mission body >>>
	printStyledString("MoonLoader Mission Template", 1000, 2)

	local x, y, z = getOffsetFromCharInWorldCoords(PLAYER_PED, 0, 3, -1)

	requestModel(162)
	requestModel(341)

	loadAllModelsNow()

	ped = createChar(31, 162, x, y, z)
	giveWeaponToChar(ped, 9, 1)

	markModelAsNoLongerNeeded(162)
	markModelAsNoLongerNeeded(341)

	taskKillCharOnFoot(ped, PLAYER_PED)

	while true do
		if isCharDead(ped) then
			break
		end

		wait(0)
	end

	pass()
	-- <<< mission body
end

-- functions to use in your mission >>>
function pass()
	-- give your rewards here >>>
	-- <<< give your rewards here

	cleanup()

	printBig("M_PASSD", 5000, 1)
	playMissionPassedTune(2)
end

function fail(_nocleanup) -- leave set the paremeter "_nocleanup" empty or set it to "false" unless you know what you're doing
	-- give your penalties here >>>
	-- <<< give your penalties here

	if not _nocleanup then
		cleanup()
	end

	printBig("M_FAIL", 5000, 1)
end

function cleanup()
	if onmission then
		-- delete your entities here >>>
		deleteChar(ped)
		-- <<< delete your entities here

		setGameGlobal(409, 0)
		onmission = false
	end
end

function hasPlayerBeenWastedOrBusted()
	return isCharDead(PLAYER_PED) or hasCharBeenArrested(PLAYER_PED)
end

function hasMissionBeenAborted()
	return readMemory(0xA444B0, 1) == 1 -- mission aborted (opcode 045C)
end
-- <<< functions to use in your mission

-- advanced functions >>>
function reload()
	script:reload()
end

function missionManager()
	while true do
		if onmission then
			local wastedbusted = hasPlayerBeenWastedOrBusted()
			if wastedbusted or hasMissionBeenAborted() then
				if wastedbusted then
					fail(true)
				end

				reload()
			end
		end

		wait(0)
	end
end

function onScriptTerminate(s) -- on script reload, unload or crash
	if s == script then
		cleanup()
	end
end
-- <<< advanced functions

This script triggers the mission when the user types the cheat "MOONMIS", which then spawns a Chainsaw-wielding, hostile CWMYHB1 ped in front of the player. Killing this ped will pass the mission, the player getting wasted or busted will fail the mission, and using the opcode 045C or reloading, unloading or crashing the script will end the mission abrutply.

The code is self-explanatory. Still, if you have any concerns- feel free to comment!