Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 3.26 KB

File metadata and controls

77 lines (57 loc) · 3.26 KB

Swagger\Client\MapApi

All URIs are relative to https://localhost/api/v5

Method HTTP request Description
getMap GET /map/{world}/{x}/{z} Get a map tile

getMap

getMap($world, $x, $z, $details, $accept, $pretty)

Get a map tile

Returns an image representing the biomes of the blocks within the specified tile Required permissions: - map.map

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\MapApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$world = "world_example"; // string | The world to get the map tile from
$x = 56; // int | The x-coordinate of the tile (is multiplied by the TILE_SIZE)
$z = 56; // int | The z-coordinate of the tile (is multiplied by the TILE_SIZE)
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $apiInstance->getMap($world, $x, $z, $details, $accept, $pretty);
} catch (Exception $e) {
    echo 'Exception when calling MapApi->getMap: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
world string The world to get the map tile from
x int The x-coordinate of the tile (is multiplied by the TILE_SIZE)
z int The z-coordinate of the tile (is multiplied by the TILE_SIZE)
details bool Add to include additional details, omit or false otherwise [optional]
accept string Override the 'Accept' request header (useful for debugging your requests) [optional]
pretty bool Add to make the Web-API pretty print the response (useful for debugging your requests) [optional]

Return type

void (empty response body)

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: image/png

[Back to top] [Back to API list] [Back to Model list] [Back to README]