Create Region

POST

/api/creative/lore/maps/{map_id}/regions

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

Create a polygon region on a map.

Parameters

Path Parameters

map_id

required

Map Id

string

Request Body ^required

MapRegionCreate

object

label

Label

string

"" <= 200 characters

vertices

required

Vertices

Array<object>

Vertex

A point on the map in percentage coordinates.

object

xPct

required

Xpct

number

<= 100

yPct

required

Ypct

number

<= 100

fillColor

Fillcolor

string

default: #d4885c /^#[0-9a-fA-F]{6}$/

fillOpacity

Fillopacity

number

default: 0.2 <= 1

strokeColor

Strokecolor

string

default: #d4885c /^#[0-9a-fA-F]{6}$/

strokeWidth

Strokewidth

number

default: 2 >= 0.5 <= 10

loreEntryId

Any of:

string

string

null

null

notes

Notes

string

"" <= 5000 characters

minZoom

Minzoom

number

0

maxZoom

Maxzoom

number

default: 100

Responses

200

Successful Response

MapRegionResponse

object

id

required

Id

string

mapId

required

Mapid

string

projectId

required

Projectid

string

label

required

Label

string

vertices

required

Vertices

Array<object>

Vertex

A point on the map in percentage coordinates.

object

xPct

required

Xpct

number

<= 100

yPct

required

Ypct

number

<= 100

fillColor

required

Fillcolor

string

fillOpacity

required

Fillopacity

number

strokeColor

required

Strokecolor

string

strokeWidth

required

Strokewidth

number

loreEntryId

Any of:

string

string

null

null

loreEntryTitle

Any of:

string

string

null

null

notes

required

Notes

string

minZoom

required

Minzoom

number

maxZoom

required

Maxzoom

number

sortOrder

required

Sortorder

integer

createdAt

required

Createdat

integer

modifiedAt

required

Modifiedat

integer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object