Skip to main content

Teleport

City waypoints, player homes, and the teleport audit log.

TeleportController​

  • Route prefix: api/teleport
  • Auth: [Authorize]. Create/update/delete are admin-only; teleport actions require admin or moderator.

Cities​

MethodPathDescriptionRequestResponse
GET/citiesList cities, paginated?pageIndex&pageSize&searchPaginatedResponse<CityLocation>
GET/cities/{id}Single cityCityLocation
POST/citiesCreate city (admin){ cityName, position, pointsRequired, viewDirection }{ id }
PUT/cities/{id}Update city (admin)same as POST{ id }
DELETE/cities/{id}Delete city (admin)string
POST/cities/{id}/teleportTeleport player to city (admin/moderator){ playerId, playerName }{ message, output }

Homes​

MethodPathDescriptionRequestResponse
GET/homesList all homes, paginated?pageIndex&pageSize&searchPaginatedResponse<HomeLocation>
GET/homes/player/{playerId}All homes for a playerHomeLocation[]
DELETE/homes/{id}Delete home (admin)string
POST/homes/{id}/teleportTeleport player to their home (admin/moderator){ playerId }{ message, output }

History​

MethodPathDescriptionRequestResponse
GET/historyPaginated teleport history, filtered by player?pageIndex&pageSize&playerIdPaginatedResponse<TeleRecord>

TeleportSettingsController​

  • Route prefix: api/settings/teleport
  • Auth: admin role required.
MethodPathDescriptionRequestResponse
GET/Current teleport settingsTeleportSettings
PUT/Update teleport settings{ teleportDelaySeconds, defaultPointsCost }string

Notes​

  • pointsRequired of 0 is free; any positive value costs the player that many points.
  • teleportDelaySeconds applies to player-initiated teleports only. Admin-driven teleport from the panel is instant.
  • Deleting a home doesn't refund the player. Use the Points endpoints for that if you need to.