get('function_name'); $language = $request->get('language', 'lua'); $function = $this->findFunction($functionName); if (! $function) { return Response::text(sprintf("QBCore function '%s' not found. Check QBCore documentation at https://docs.qbcore.org/", $functionName)); } $output = $this->formatFunctionInfo($function, $language); return Response::text($output); } /** * Find a QBCore function. */ protected function findFunction(string $name): ?array { $functions = [ // Player Functions 'QBCore.Functions.GetPlayer' => [ 'namespace' => 'Core', 'description' => 'Get a QBCore player object from server ID (server-side only)', 'side' => 'server', 'parameters' => [ ['name' => 'source', 'type' => 'int', 'description' => 'The player server ID'], ], 'returns' => ['type' => 'table', 'description' => 'QBCore player object or nil'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n print('Player: ' .. Player.PlayerData.charinfo.firstname)\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n console.log('Player: ' + Player.PlayerData.charinfo.firstname);\n}", ], 'QBCore.Functions.GetPlayerByCitizenId' => [ 'namespace' => 'Core', 'description' => 'Get a player object by their citizen ID (server-side only)', 'side' => 'server', 'parameters' => [ ['name' => 'citizenId', 'type' => 'string', 'description' => 'The player citizen ID'], ], 'returns' => ['type' => 'table', 'description' => 'QBCore player object or nil'], 'lua_example' => "local Player = QBCore.Functions.GetPlayerByCitizenId('ABC12345')\nif Player then\n TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, 'Hello!')\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayerByCitizenId('ABC12345');\nif (Player) {\n TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, 'Hello!');\n}", ], 'QBCore.Functions.GetPlayerData' => [ 'namespace' => 'Core', 'description' => 'Get the current player data (client-side only)', 'side' => 'client', 'parameters' => [], 'returns' => ['type' => 'table', 'description' => 'Current player data table'], 'lua_example' => "local PlayerData = QBCore.Functions.GetPlayerData()\nprint('Job: ' .. PlayerData.job.name)", 'js_example' => "const PlayerData = QBCore.Functions.GetPlayerData();\nconsole.log('Job: ' + PlayerData.job.name);", ], // Item Functions 'AddItem' => [ 'namespace' => 'Player', 'description' => 'Add an item to a player\'s inventory', 'side' => 'server', 'parameters' => [ ['name' => 'item', 'type' => 'string', 'description' => 'Item name'], ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to add (default 1)'], ['name' => 'slot', 'type' => 'int|nil', 'description' => 'Optional specific slot'], ['name' => 'info', 'type' => 'table|nil', 'description' => 'Optional item metadata/info'], ], 'returns' => ['type' => 'boolean', 'description' => 'Success status'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local success = Player.Functions.AddItem('water', 1)\n if success then\n TriggerClientEvent('QBCore:Notify', source, 'Item added')\n end\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const success = Player.Functions.AddItem('water', 1);\n if (success) {\n TriggerClientEvent('QBCore:Notify', global.source, 'Item added');\n }\n}", ], 'RemoveItem' => [ 'namespace' => 'Player', 'description' => 'Remove an item from a player\'s inventory', 'side' => 'server', 'parameters' => [ ['name' => 'item', 'type' => 'string', 'description' => 'Item name'], ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to remove (default 1)'], ['name' => 'slot', 'type' => 'int|nil', 'description' => 'Optional specific slot'], ], 'returns' => ['type' => 'boolean', 'description' => 'Success status'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local success = Player.Functions.RemoveItem('water', 1)\n if success then\n TriggerClientEvent('QBCore:Notify', source, 'Item removed')\n end\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const success = Player.Functions.RemoveItem('water', 1);\n if (success) {\n TriggerClientEvent('QBCore:Notify', global.source, 'Item removed');\n }\n}", ], 'GetItemByName' => [ 'namespace' => 'Player', 'description' => 'Get item data from a player\'s inventory', 'side' => 'server', 'parameters' => [ ['name' => 'item', 'type' => 'string', 'description' => 'Item name to search for'], ], 'returns' => ['type' => 'table|nil', 'description' => 'Item data table or nil if not found'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local item = Player.Functions.GetItemByName('water')\n if item then\n print('Found ' .. item.amount .. 'x ' .. item.name)\n end\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const item = Player.Functions.GetItemByName('water');\n if (item) {\n console.log(`Found \${item.amount}x \${item.name}`);\n }\n}", ], // Money Functions 'AddMoney' => [ 'namespace' => 'Player', 'description' => 'Add money to a player\'s account', 'side' => 'server', 'parameters' => [ ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to add'], ['name' => 'reason', 'type' => 'string|nil', 'description' => 'Optional reason for logging'], ], 'returns' => ['type' => 'boolean', 'description' => 'Success status'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.AddMoney('cash', 500, 'Job Payment')\n TriggerClientEvent('QBCore:Notify', source, 'You earned $500')\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.AddMoney('cash', 500, 'Job Payment');\n TriggerClientEvent('QBCore:Notify', global.source, 'You earned $500');\n}", ], 'RemoveMoney' => [ 'namespace' => 'Player', 'description' => 'Remove money from a player\'s account', 'side' => 'server', 'parameters' => [ ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], ['name' => 'amount', 'type' => 'int', 'description' => 'Amount to remove'], ['name' => 'reason', 'type' => 'string|nil', 'description' => 'Optional reason for logging'], ], 'returns' => ['type' => 'boolean', 'description' => 'Success status'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.RemoveMoney('cash', 500, 'Shop Purchase')\n TriggerClientEvent('QBCore:Notify', source, 'Payment successful')\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.RemoveMoney('cash', 500, 'Shop Purchase');\n TriggerClientEvent('QBCore:Notify', global.source, 'Payment successful');\n}", ], 'GetMoney' => [ 'namespace' => 'Player', 'description' => 'Get a player\'s money amount', 'side' => 'server', 'parameters' => [ ['name' => 'moneyType', 'type' => 'string', 'description' => 'Type: "cash", "bank", or custom'], ], 'returns' => ['type' => 'int', 'description' => 'Money amount'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local cashAmount = Player.Functions.GetMoney('cash')\n print('Cash: $' .. cashAmount)\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const cashAmount = Player.Functions.GetMoney('cash');\n console.log('Cash: $' + cashAmount);\n}", ], // Job Functions 'SetJob' => [ 'namespace' => 'Player', 'description' => 'Set a player\'s job', 'side' => 'server', 'parameters' => [ ['name' => 'jobName', 'type' => 'string', 'description' => 'The job name'], ['name' => 'grade', 'type' => 'int', 'description' => 'The job grade (usually 0 for basic)'], ], 'returns' => ['type' => 'boolean', 'description' => 'Success status'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.SetJob('police', 0)\n TriggerClientEvent('QBCore:Notify', source, 'You are now a police officer', 'success')\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.SetJob('police', 0);\n TriggerClientEvent('QBCore:Notify', global.source, 'You are now a police officer', 'success');\n}", ], 'GetJob' => [ 'namespace' => 'Player', 'description' => 'Get a player\'s job information', 'side' => 'server', 'parameters' => [], 'returns' => ['type' => 'table', 'description' => 'Job data table with name, label, grade, etc.'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n local job = Player.Functions.GetJob()\n print('Job: ' .. job.name .. ' (' .. job.grade.name .. ')')\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n const job = Player.Functions.GetJob();\n console.log(`Job: \${job.name} (\${job.grade.name})`);\n}", ], // Vehicle Functions 'AddVehicle' => [ 'namespace' => 'Player', 'description' => 'Add a vehicle to a player\'s garage', 'side' => 'server', 'parameters' => [ ['name' => 'modelName', 'type' => 'string', 'description' => 'Vehicle model name (e.g., "adder")'], ['name' => 'plate', 'type' => 'string', 'description' => 'License plate (usually unique identifier)'], ['name' => 'properties', 'type' => 'table|nil', 'description' => 'Optional vehicle properties/customization'], ], 'returns' => ['type' => 'boolean', 'description' => 'Success status'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.AddVehicle('adder', 'QBTEST')\n TriggerClientEvent('QBCore:Notify', source, 'Vehicle added to garage')\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.AddVehicle('adder', 'QBTEST');\n TriggerClientEvent('QBCore:Notify', global.source, 'Vehicle added to garage');\n}", ], 'DeleteVehicle' => [ 'namespace' => 'Player', 'description' => 'Remove a vehicle from a player\'s garage', 'side' => 'server', 'parameters' => [ ['name' => 'plate', 'type' => 'string', 'description' => 'License plate of vehicle to remove'], ], 'returns' => ['type' => 'boolean', 'description' => 'Success status'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n Player.Functions.DeleteVehicle('QBTEST')\n TriggerClientEvent('QBCore:Notify', source, 'Vehicle removed from garage')\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n Player.Functions.DeleteVehicle('QBTEST');\n TriggerClientEvent('QBCore:Notify', global.source, 'Vehicle removed from garage');\n}", ], // Utility Functions 'Notify' => [ 'namespace' => 'Utility', 'description' => 'Send a notification to a player', 'side' => 'client', 'parameters' => [ ['name' => 'source', 'type' => 'int', 'description' => 'Player server ID'], ['name' => 'message', 'type' => 'string', 'description' => 'Notification message'], ['name' => 'type', 'type' => 'string', 'description' => 'Type: "success", "error", "info" (default: info)'], ['name' => 'length', 'type' => 'int|nil', 'description' => 'Duration in milliseconds'], ], 'returns' => ['type' => 'void', 'description' => 'No return value'], 'lua_example' => "TriggerClientEvent('QBCore:Notify', source, 'Hello Player!', 'success', 5000)", 'js_example' => "TriggerClientEvent('QBCore:Notify', global.source, 'Hello Player!', 'success', 5000);", ], 'HasItem' => [ 'namespace' => 'Player', 'description' => 'Check if a player has an item', 'side' => 'server', 'parameters' => [ ['name' => 'item', 'type' => 'string', 'description' => 'Item name to check'], ['name' => 'amount', 'type' => 'int|nil', 'description' => 'Minimum amount required'], ], 'returns' => ['type' => 'boolean', 'description' => 'True if player has item'], 'lua_example' => "local Player = QBCore.Functions.GetPlayer(source)\nif Player then\n if Player.Functions.GetItemByName('water') then\n print('Has water')\n end\nend", 'js_example' => "const Player = QBCore.Functions.GetPlayer(global.source);\nif (Player) {\n if (Player.Functions.GetItemByName('water')) {\n console.log('Has water');\n }\n}", ], ]; $nameLower = strtolower($name); foreach ($functions as $functionName => $functionData) { if (strtolower($functionName) === $nameLower) { return array_merge(['name' => $functionName], $functionData); } } return null; } /** * Format function info. */ protected function formatFunctionInfo(array $function, string $language): string { return view('mcp.qbcore-function', [ 'function' => $function, 'language' => $language, ])->render(); } /** * Get the tool's input schema. * * @return array */ public function schema(JsonSchema $schema): array { return [ 'function_name' => $schema ->string() ->description('The name of the QBCore function to look up (e.g., "QBCore.Functions.GetPlayer", "AddMoney")') ->required(), 'language' => $schema ->string() ->enum(['lua', 'js']) ->description('The scripting language for code examples') ->default('lua'), ]; } }