Adrian Mejias
0bedeed913
- Created new Blade views for displaying Prodigy events and exports, including detailed references. - Implemented tests for Prodigy client and server event/export reference tools to ensure correct functionality. - Updated Pest test configuration for improved test case handling.
222 lines
11 KiB
PHP
222 lines
11 KiB
PHP
<?php
|
|
|
|
namespace App\Mcp\Tools\FiveM\Client;
|
|
|
|
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('Look up GTA5/FiveM client-side native functions by name. Returns function signature, parameters, return type, and usage examples.')]
|
|
class GetNativeClientFunction extends Tool
|
|
{
|
|
/**
|
|
* Handle the tool request.
|
|
*/
|
|
public function handle(Request $request): Response
|
|
{
|
|
$functionName = $request->get('function_name');
|
|
$language = $request->get('language', 'lua');
|
|
|
|
$native = $this->findNative($functionName);
|
|
|
|
if (! $native) {
|
|
return Response::text(sprintf("Client native function '%s' not found. Try searching at https://docs.fivem.net/natives/", $functionName));
|
|
}
|
|
|
|
$output = $this->formatNativeInfo($native, $language);
|
|
|
|
return Response::text($output);
|
|
}
|
|
|
|
/**
|
|
* Find a client native function.
|
|
*/
|
|
protected function findNative(string $name): ?array
|
|
{
|
|
// Client-side only FiveM natives
|
|
$natives = [
|
|
// Player/Ped natives
|
|
'GetPlayerPed' => [
|
|
'namespace' => 'PLAYER',
|
|
'description' => 'Gets the local or specified player\'s ped handle',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'playerId', 'type' => 'int', 'description' => 'The player ID, or -1 for local player'],
|
|
],
|
|
'returns' => ['type' => 'int', 'description' => 'The player ped handle'],
|
|
'lua_example' => 'local playerPed = GetPlayerPed(-1)',
|
|
'js_example' => 'const playerPed = GetPlayerPed(-1);',
|
|
],
|
|
'PlayerPedId' => [
|
|
'namespace' => 'PLAYER',
|
|
'description' => 'Returns the ped ID of the local player',
|
|
'side' => 'client',
|
|
'parameters' => [],
|
|
'returns' => ['type' => 'int', 'description' => 'The local player ped ID'],
|
|
'lua_example' => 'local playerPed = PlayerPedId()',
|
|
'js_example' => 'const playerPed = PlayerPedId();',
|
|
],
|
|
'GetPlayerName' => [
|
|
'namespace' => 'PLAYER',
|
|
'description' => 'Returns the name of a player (client-side lookup)',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'playerId', 'type' => 'int', 'description' => 'The player ID'],
|
|
],
|
|
'returns' => ['type' => 'string', 'description' => 'The player name'],
|
|
'lua_example' => 'local name = GetPlayerName(PlayerId())',
|
|
'js_example' => 'const name = GetPlayerName(PlayerId());',
|
|
],
|
|
'PlayerId' => [
|
|
'namespace' => 'PLAYER',
|
|
'description' => 'Gets the local player ID on client',
|
|
'side' => 'client',
|
|
'parameters' => [],
|
|
'returns' => ['type' => 'int', 'description' => 'The local player ID'],
|
|
'lua_example' => 'local playerId = PlayerId()',
|
|
'js_example' => 'const playerId = PlayerId();',
|
|
],
|
|
'SetEntityCoords' => [
|
|
'namespace' => 'ENTITY',
|
|
'description' => 'Sets the coordinates of an entity (client-side)',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'entity', 'type' => 'int', 'description' => 'The entity handle'],
|
|
['name' => 'x', 'type' => 'float', 'description' => 'X coordinate'],
|
|
['name' => 'y', 'type' => 'float', 'description' => 'Y coordinate'],
|
|
['name' => 'z', 'type' => 'float', 'description' => 'Z coordinate'],
|
|
['name' => 'alive', 'type' => 'boolean', 'description' => 'Keep entity alive during teleport'],
|
|
['name' => 'deadFlag', 'type' => 'boolean', 'description' => 'Teleport even if dead'],
|
|
['name' => 'ragdollFlag', 'type' => 'boolean', 'description' => 'Teleport even in ragdoll'],
|
|
['name' => 'clearArea', 'type' => 'boolean', 'description' => 'Clear area at destination'],
|
|
],
|
|
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
|
'lua_example' => 'SetEntityCoords(PlayerPedId(), 0.0, 0.0, 72.0, true, false, false, true)',
|
|
'js_example' => 'SetEntityCoords(PlayerPedId(), 0.0, 0.0, 72.0, true, false, false, true);',
|
|
],
|
|
'GetEntityCoords' => [
|
|
'namespace' => 'ENTITY',
|
|
'description' => 'Gets the coordinates of an entity',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'entity', 'type' => 'int', 'description' => 'The entity handle'],
|
|
['name' => 'alive', 'type' => 'boolean', 'description' => 'Whether to get alive coordinates only'],
|
|
],
|
|
'returns' => ['type' => 'vector3', 'description' => 'The entity coordinates'],
|
|
'lua_example' => 'local coords = GetEntityCoords(PlayerPedId(), true)',
|
|
'js_example' => 'const coords = GetEntityCoords(PlayerPedId(), true);',
|
|
],
|
|
'DeleteEntity' => [
|
|
'namespace' => 'ENTITY',
|
|
'description' => 'Deletes an entity (network delete for networked entities)',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'entity', 'type' => 'int', 'description' => 'The entity handle to delete'],
|
|
],
|
|
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
|
'lua_example' => 'DeleteEntity(ped)',
|
|
'js_example' => 'DeleteEntity(ped);',
|
|
],
|
|
'TriggerServerEvent' => [
|
|
'namespace' => 'CFX',
|
|
'description' => 'Triggers an event on the server from client',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'],
|
|
['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'],
|
|
],
|
|
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
|
'lua_example' => "TriggerServerEvent('myResource:serverEvent', arg1, arg2)",
|
|
'js_example' => "TriggerServerEvent('myResource:serverEvent', arg1, arg2);",
|
|
],
|
|
'RegisterNetEvent' => [
|
|
'namespace' => 'CFX',
|
|
'description' => 'Registers a network event handler (client-side)',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'],
|
|
],
|
|
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
|
'lua_example' => "RegisterNetEvent('myResource:clientEvent')\nAddEventHandler('myResource:clientEvent', function(param1, param2)\n -- Handle event\nend)",
|
|
'js_example' => "RegisterNetEvent('myResource:clientEvent');\nAddEventHandler('myResource:clientEvent', (param1, param2) => {\n // Handle event\n});",
|
|
],
|
|
'AddEventHandler' => [
|
|
'namespace' => 'CFX',
|
|
'description' => 'Adds an event handler for local events',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'],
|
|
['name' => 'callback', 'type' => 'function', 'description' => 'The handler function'],
|
|
],
|
|
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
|
'lua_example' => "AddEventHandler('onResourceStart', function(resourceName)\n if resourceName == GetCurrentResourceName() then\n print('Resource started!')\n end\nend)",
|
|
'js_example' => "AddEventHandler('onResourceStart', (resourceName) => {\n if (resourceName === GetCurrentResourceName()) {\n console.log('Resource started!');\n }\n});",
|
|
],
|
|
'GetCurrentResourceName' => [
|
|
'namespace' => 'CFX',
|
|
'description' => 'Returns the name of the currently executing resource',
|
|
'side' => 'client',
|
|
'parameters' => [],
|
|
'returns' => ['type' => 'string', 'description' => 'The resource name'],
|
|
'lua_example' => "local resName = GetCurrentResourceName()\nprint('Current resource: ' .. resName)",
|
|
'js_example' => "const resName = GetCurrentResourceName();\nconsole.log('Current resource: ' + resName);",
|
|
],
|
|
'TriggerEvent' => [
|
|
'namespace' => 'CFX',
|
|
'description' => 'Triggers a local event on the current client',
|
|
'side' => 'client',
|
|
'parameters' => [
|
|
['name' => 'eventName', 'type' => 'string', 'description' => 'The name of the event'],
|
|
['name' => '...args', 'type' => 'any', 'description' => 'Event arguments'],
|
|
],
|
|
'returns' => ['type' => 'void', 'description' => 'No return value'],
|
|
'lua_example' => "TriggerEvent('myEvent', 'arg1', 'arg2')",
|
|
'js_example' => "TriggerEvent('myEvent', 'arg1', 'arg2');",
|
|
],
|
|
];
|
|
|
|
$nameLower = strtolower($name);
|
|
|
|
foreach ($natives as $nativeName => $nativeData) {
|
|
if (strtolower($nativeName) === $nameLower) {
|
|
return array_merge(['name' => $nativeName], $nativeData);
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Format native function info.
|
|
*/
|
|
protected function formatNativeInfo(array $native, string $language): string
|
|
{
|
|
return view('mcp.fivem.native-function', [
|
|
'native' => $native,
|
|
'language' => $language,
|
|
])->render();
|
|
}
|
|
|
|
/**
|
|
* Get the tool's input schema.
|
|
*
|
|
* @return array<string, JsonSchema>
|
|
*/
|
|
public function schema(JsonSchema $schema): array
|
|
{
|
|
return [
|
|
'function_name' => $schema
|
|
->string()
|
|
->description('The name of the client-side native function to look up (e.g., "PlayerPedId", "SetEntityCoords", "TriggerServerEvent")')
|
|
->required(),
|
|
'language' => $schema
|
|
->string()
|
|
->enum(['lua', 'js'])
|
|
->description('The scripting language for code examples')
|
|
->default('lua'),
|
|
];
|
|
}
|
|
}
|