smrealms / smr

src/lib/Default/missions.inc.php

<?php declare(strict_types=1);

use Smr\BarDrink;
use Smr\PlotGroup;

const MISSION_ACTIONS = [
	'LeaveSector',
	'EnterSector',
	'WalkSector',
	'JoinAlliance',
	'LeaveAlliance',
	'DisbandAlliance',
	'KickPlayer',
	'PlayerKicked',
	'BuyDrink',
];

//REQUIREMENTS
//if you use an array as a requirement and the requirement name represents an array, it will check every value and all must pass
//if you use an array as a requirement and the requirement name is not an array, only one of the checks must pass
//ie 'Completed Missions' => array(2,3) means the player must have completed BOTH missions
//ie 'Ship ID' => array(1,2) means the player must be in EITHER ship id 1 or 2
//STEPS
/*key types:
*'KillName' - kill 'Detail' Player/NPC
*'KillNPCs' - kill 'Detail' NPCs
*'KillPlayers' - kill 'Detail' Players
*'KillSpawn' - Spawn 'Detail' Type NPC and kill it, DB field Progress with then be NPC_ID, also requires a 'Level' element, use -1 for normal
'Trade' -
^'Visit' - Examine 'Detail' location
*'DrinkAmount' - Buy 'Detail' drinks at a bar
*'Drink' - Buy 'Detail' drink name at a bar
*'Move' - Move 'Detail' sectors anywhere
*'MoveSector' - Move to 'Detail' sector
*'MoveRacial' - Move to galaxy containing 'Detail' race HQ (use racial id)
*'MoveGal' - Move to 'Detail' galaxy
'ClearNPC' - Clear 'Detail' stacks of NPC forces in sector (use MoveSector) command to tell them which sector, also stored as mission_sector in DB
*'StartPortRaid' - start raiding 'detail' ports
*'RaidPort' - raid 'detail' ports
'Bring' - bring 'detail' to starting sector

Replacements:
<Race> - Current race name
<Starting Sector> - Sector where mission was accepted
<Sector> - Random sector for mission.

* = implemented
^ = partial implementaion
	Visit - done for 'Bar'
*/

// NOTE: Array keys are the mission ID and should not be changed!
const MISSIONS = [
	0 => [
		'Name' => 'Drunk Guy',
		'Offerer' => 'Drunk',
		'Time Limit' => 0,
		'HasX' => [
			'Type' => PlotGroup::Locations,
			'X' => 'Bar',
		],
		'Steps' => [
			[
				'Step' => 'EnterSector',
				'PickSector' => [
					'Type' => PlotGroup::Locations,
					'X' => RACE_SALVENE + LOCATION_GROUP_RACIAL_HQS,
				],
				'Detail' => [
					'SectorID' => '<Sector>',
				],
				'Text' => '*Hiccup* Hey! I need you to...*Hiccup* do me a favor. All the ' . BarDrink::SALVENE_SWAMP_SODA . ' in this bar is awful! Go to the Sal...*Hiccup*...the Salvene HQ, they\'ll know a good bar.',
				'Task' => 'Go to the Salvene HQ at [sector=<Sector>]',
			],
			[
				'Step' => 'EnterSector',
				'PickSector' => [
					'Type' => PlotGroup::Locations,
					'X' => 'Bar',
				],
				'Detail' => [
					'SectorID' => '<Sector>',
				],
				'Text' => 'Here we are! The Salvene HQ! You ask around a bit and find that the bar in [sector=<Sector>] does the best ' . BarDrink::SALVENE_SWAMP_SODA . ' around!',
				'Task' => 'Go to the bar at [sector=<Sector>] and buy a ' . BarDrink::SALVENE_SWAMP_SODA . ' from the bartender. This may take many tries.',
			],
			[
				'Step' => 'BuyDrink',
				'Detail' => [
					'SectorID' => '<Sector>',
					'Drink' => BarDrink::SALVENE_SWAMP_SODA,
				],
				'Text' => 'Here we are! Now let\'s get this ' . BarDrink::SALVENE_SWAMP_SODA . '.',
				'Task' => 'Go to the bar at [sector=<Sector>] and buy a ' . BarDrink::SALVENE_SWAMP_SODA . ' from the bartender. This may take many tries.',
			],
			[
				'Step' => 'EnterSector',
				'Detail' => [
					'SectorID' => '<Starting Sector>',
				],
				'Text' => 'Finally! A true ' . BarDrink::SALVENE_SWAMP_SODA . ', let\'s return to that drunk!',
				'Task' => 'Return to [sector=<Starting Sector>] to claim your reward.',
			],
			[
				'Step' => 'Claim',
				'Rewards' => [
					'Credits' => 500000,
					'Experience' => 1000,
					'Text' => '*Hiccup* For your...service *Hiccup* to me, take these *Hiccup* 500,000 credits and 1,000 experience *Hiccup*!',
				],
				'Detail' => [
					'SectorID' => '<Starting Sector>',
				],
				'Text' => 'You hand the ' . BarDrink::SALVENE_SWAMP_SODA . ' to the drunk!',
			],
		],
	],
];

/**
 * Callback for array_walk_recursive in SmrPlayer::rebuildMission.
 * Searches for placeholders in template and replaces them with values
 * derived from the supplied data.
 *
 * @param array<string, mixed> $data
 */
function replaceMissionTemplate(string|int|PlotGroup &$template, string $key, array $data): void {

The parameter $key is not used and could be removed.

	if (!is_string($template)) {
		return;
	}
	$search = ['<Race>', '<Sector>', '<Starting Sector>'];
	$replace = [$data['player']->getRaceID(), $data['mission']['Sector'], $data['mission']['Starting Sector']];
	$template = str_replace($search, $replace, $template);
}

/**
 * @param array<string, mixed> $values
 * @param array<string, mixed> $requirements
 */
function checkMissionRequirements(array $values, array $requirements): bool {
	foreach ($requirements as $reqName => $reqValue) {
		if ($values[$reqName] != $reqValue) {
			return false;
		}
	}
	return true;
}