Adrian Mejias
d3d1f5fdb3
- Introduced a new code snippets resource for common FiveM patterns in Lua and JavaScript. - Added a framework comparison document outlining Standalone, ESX, and QBCore features. - Created search results view for FiveM documentation queries. - Developed client and server template scripts for ESX and QBCore frameworks. - Implemented NUI templates including HTML, CSS, and JavaScript for user interfaces. - Established routes for documentation and console commands. - Added tests for various features including documentation routes and tool functionalities. - Configured Vite for asset management with Laravel. - Updated .gitignore files for storage and framework directories.
208 lines
9.5 KiB
PHP
208 lines
9.5 KiB
PHP
<?php
|
|
|
|
namespace App\Mcp\Tools;
|
|
|
|
use Illuminate\Contracts\JsonSchema\JsonSchema;
|
|
use Laravel\Mcp\Request;
|
|
use Laravel\Mcp\Response;
|
|
use Laravel\Mcp\Server\Attributes\Description;
|
|
use Laravel\Mcp\Server\Tool;
|
|
|
|
#[Description('Get information about FiveM events including built-in and common framework events (ESX, QBCore).')]
|
|
class GetEventReference extends Tool
|
|
{
|
|
/**
|
|
* Handle the tool request.
|
|
*/
|
|
public function handle(Request $request): Response
|
|
{
|
|
$eventName = $request->get('event_name');
|
|
$eventType = $request->get('event_type', 'all');
|
|
$language = $request->get('language', 'lua');
|
|
|
|
if ($eventName) {
|
|
return $this->getEventInfo($eventName, $language);
|
|
}
|
|
|
|
return $this->listEvents($eventType, $language);
|
|
}
|
|
|
|
/**
|
|
* Get specific event information.
|
|
*/
|
|
protected function getEventInfo(string $eventName, string $language): Response
|
|
{
|
|
$events = $this->getEventsDatabase();
|
|
|
|
foreach ($events as $event) {
|
|
if (strtolower($event['name']) === strtolower($eventName)) {
|
|
return Response::text($this->formatEventInfo($event, $language));
|
|
}
|
|
}
|
|
|
|
return Response::text(sprintf("Event '%s' not found in the database.", $eventName));
|
|
}
|
|
|
|
/**
|
|
* List events by type.
|
|
*/
|
|
protected function listEvents(string $type, string $language): Response
|
|
{
|
|
$events = $this->getEventsDatabase();
|
|
|
|
if ($type !== 'all') {
|
|
$events = array_filter($events, fn ($e) => $e['type'] === $type);
|
|
}
|
|
|
|
$eventsByType = [];
|
|
foreach ($events as $event) {
|
|
$eventsByType[$event['type']][] = $event;
|
|
}
|
|
|
|
return Response::text(
|
|
view('mcp.event-list', [
|
|
'eventsByType' => $eventsByType,
|
|
])->render()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Format event information.
|
|
*/
|
|
protected function formatEventInfo(array $event, string $language): string
|
|
{
|
|
return view('mcp.event-reference', [
|
|
'event' => $event,
|
|
'language' => $language,
|
|
])->render();
|
|
}
|
|
|
|
/**
|
|
* Get events database.
|
|
*/
|
|
protected function getEventsDatabase(): array
|
|
{
|
|
return [
|
|
// Core FiveM Events
|
|
[
|
|
'name' => 'onResourceStart',
|
|
'type' => 'core',
|
|
'side' => 'both',
|
|
'description' => 'Triggered when a resource starts',
|
|
'parameters' => [
|
|
['name' => 'resourceName', 'type' => 'string', 'description' => 'The name of the resource that started'],
|
|
],
|
|
'lua_example' => "AddEventHandler('onResourceStart', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource started!')\n end\nend)",
|
|
'js_example' => "on('onResourceStart', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource started!');\n }\n});",
|
|
'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStart/',
|
|
],
|
|
[
|
|
'name' => 'onResourceStop',
|
|
'type' => 'core',
|
|
'side' => 'both',
|
|
'description' => 'Triggered when a resource stops',
|
|
'parameters' => [
|
|
['name' => 'resourceName', 'type' => 'string', 'description' => 'The name of the resource that stopped'],
|
|
],
|
|
'lua_example' => "AddEventHandler('onResourceStop', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource stopping!')\n end\nend)",
|
|
'js_example' => "on('onResourceStop', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource stopping!');\n }\n});",
|
|
'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStop/',
|
|
],
|
|
[
|
|
'name' => 'playerConnecting',
|
|
'type' => 'core',
|
|
'side' => 'server',
|
|
'description' => 'Triggered when a player is connecting to the server',
|
|
'parameters' => [
|
|
['name' => 'name', 'type' => 'string', 'description' => 'Player name'],
|
|
['name' => 'setKickReason', 'type' => 'function', 'description' => 'Function to deny connection'],
|
|
['name' => 'deferrals', 'type' => 'object', 'description' => 'Deferrals object for async connection'],
|
|
],
|
|
'lua_example' => "AddEventHandler('playerConnecting', function(name, setKickReason, deferrals)\n local source = source\n deferrals.defer()\n -- Check player\n deferrals.done()\nend)",
|
|
'js_example' => "on('playerConnecting', (name, setKickReason, deferrals) => {\n const source = global.source;\n deferrals.defer();\n // Check player\n deferrals.done();\n});",
|
|
'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/playerConnecting/',
|
|
],
|
|
[
|
|
'name' => 'playerDropped',
|
|
'type' => 'core',
|
|
'side' => 'server',
|
|
'description' => 'Triggered when a player disconnects from the server',
|
|
'parameters' => [
|
|
['name' => 'reason', 'type' => 'string', 'description' => 'Disconnect reason'],
|
|
],
|
|
'lua_example' => "AddEventHandler('playerDropped', function(reason)\n local source = source\n print('Player ' .. GetPlayerName(source) .. ' dropped: ' .. reason)\nend)",
|
|
'js_example' => "on('playerDropped', (reason) => {\n const source = global.source;\n console.log(`Player \${GetPlayerName(source)} dropped: \${reason}`);\n});",
|
|
'documentation' => 'https://docs.fivem.net/docs/scripting-reference/events/list/playerDropped/',
|
|
],
|
|
// ESX Events
|
|
[
|
|
'name' => 'esx:playerLoaded',
|
|
'type' => 'esx',
|
|
'side' => 'client',
|
|
'description' => 'Triggered when ESX player data is loaded on client',
|
|
'parameters' => [
|
|
['name' => 'xPlayer', 'type' => 'table', 'description' => 'ESX player object'],
|
|
],
|
|
'lua_example' => "RegisterNetEvent('esx:playerLoaded', function(xPlayer)\n ESX.PlayerData = xPlayer\n -- Player is loaded\nend)",
|
|
'js_example' => "RegisterNetEvent('esx:playerLoaded', (xPlayer) => {\n ESX.PlayerData = xPlayer;\n // Player is loaded\n});",
|
|
],
|
|
[
|
|
'name' => 'esx:setJob',
|
|
'type' => 'esx',
|
|
'side' => 'client',
|
|
'description' => 'Triggered when player job changes',
|
|
'parameters' => [
|
|
['name' => 'job', 'type' => 'table', 'description' => 'New job object'],
|
|
],
|
|
'lua_example' => "RegisterNetEvent('esx:setJob', function(job)\n ESX.PlayerData.job = job\n print('Job changed to: ' .. job.name)\nend)",
|
|
'js_example' => "RegisterNetEvent('esx:setJob', (job) => {\n ESX.PlayerData.job = job;\n console.log(`Job changed to: \${job.name}`);\n});",
|
|
],
|
|
// QBCore Events
|
|
[
|
|
'name' => 'QBCore:Client:OnPlayerLoaded',
|
|
'type' => 'qbcore',
|
|
'side' => 'client',
|
|
'description' => 'Triggered when QBCore player data is loaded on client',
|
|
'parameters' => [],
|
|
'lua_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoaded', function()\n local PlayerData = QBCore.Functions.GetPlayerData()\n -- Player is loaded\nend)",
|
|
'js_example' => "RegisterNetEvent('QBCore:Client:OnPlayerLoaded', () => {\n const PlayerData = QBCore.Functions.GetPlayerData();\n // Player is loaded\n});",
|
|
],
|
|
[
|
|
'name' => 'QBCore:Client:OnJobUpdate',
|
|
'type' => 'qbcore',
|
|
'side' => 'client',
|
|
'description' => 'Triggered when player job changes in QBCore',
|
|
'parameters' => [
|
|
['name' => 'job', 'type' => 'table', 'description' => 'New job object'],
|
|
],
|
|
'lua_example' => "RegisterNetEvent('QBCore:Client:OnJobUpdate', function(job)\n PlayerData.job = job\n print('Job changed to: ' .. job.name)\nend)",
|
|
'js_example' => "RegisterNetEvent('QBCore:Client:OnJobUpdate', (job) => {\n PlayerData.job = job;\n console.log(`Job changed to: \${job.name}`);\n});",
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get the tool's input schema.
|
|
*
|
|
* @return array<string, \Illuminate\Contracts\JsonSchema\JsonSchema>
|
|
*/
|
|
public function schema(JsonSchema $schema): array
|
|
{
|
|
return [
|
|
'event_name' => $schema
|
|
->string()
|
|
->description('Specific event name to look up (optional, leave empty to list all events)'),
|
|
'event_type' => $schema
|
|
->string()
|
|
->enum(['all', 'core', 'esx', 'qbcore'])
|
|
->description('Filter events by type')
|
|
->default('all'),
|
|
'language' => $schema
|
|
->string()
|
|
->enum(['lua', 'js'])
|
|
->description('The scripting language for code examples')
|
|
->default('lua'),
|
|
];
|
|
}
|
|
}
|