API docs by Redocly

Ruins Editor API (0.0.0)

Download OpenAPI specification:

Items

Items_list

アイテム一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Items_create

アイテム作成

Request Body schema: application/json
required
name
required
string

アイテム名

description
required
string

アイテムの説明文

spriteSheetName
required
string

スプライトシート名

spriteKey
required
string

スプライトキー

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

value
required
integer <int32>

売買価格

weight
number <double>

重量。未設定なら0

inflictsDamage
integer <int32>

投擲ダメージ。未設定なら投擲不可

providesNutrition
integer <int32>

栄養価。未設定なら食べられない

stackable
boolean

スタック可能かどうか

object

消費アイテム設定

object

回復効果

object

防具設定

object

装備ボーナス

weapon
object

武器マーカー。存在すれば武器として扱う

object

弾薬設定

object

近接攻撃設定

object

遠距離攻撃設定

object

本設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "value": 0,
  • "weight": 0.1,
  • "inflictsDamage": 0,
  • "providesNutrition": 0,
  • "stackable": true,
  • "consumable": {
    },
  • "providesHealing": {
    },
  • "wearable": {
    },
  • "equipBonus": {
    },
  • "weapon": { },
  • "ammo": {
    },
  • "melee": {
    },
  • "fire": {
    },
  • "book": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "value": 0,
  • "weight": 0.1,
  • "inflictsDamage": 0,
  • "providesNutrition": 0,
  • "stackable": true,
  • "consumable": {
    },
  • "providesHealing": {
    },
  • "wearable": {
    },
  • "equipBonus": {
    },
  • "weapon": { },
  • "ammo": {
    },
  • "melee": {
    },
  • "fire": {
    },
  • "book": {
    }
}

Items_get

アイテム詳細取得

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "value": 0,
  • "weight": 0.1,
  • "inflictsDamage": 0,
  • "providesNutrition": 0,
  • "stackable": true,
  • "consumable": {
    },
  • "providesHealing": {
    },
  • "wearable": {
    },
  • "equipBonus": {
    },
  • "weapon": { },
  • "ammo": {
    },
  • "melee": {
    },
  • "fire": {
    },
  • "book": {
    }
}

Items_update

アイテム更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

アイテム名

description
required
string

アイテムの説明文

spriteSheetName
required
string

スプライトシート名

spriteKey
required
string

スプライトキー

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

value
required
integer <int32>

売買価格

weight
number <double>

重量。未設定なら0

inflictsDamage
integer <int32>

投擲ダメージ。未設定なら投擲不可

providesNutrition
integer <int32>

栄養価。未設定なら食べられない

stackable
boolean

スタック可能かどうか

object

消費アイテム設定

object

回復効果

object

防具設定

object

装備ボーナス

weapon
object

武器マーカー。存在すれば武器として扱う

object

弾薬設定

object

近接攻撃設定

object

遠距離攻撃設定

object

本設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "value": 0,
  • "weight": 0.1,
  • "inflictsDamage": 0,
  • "providesNutrition": 0,
  • "stackable": true,
  • "consumable": {
    },
  • "providesHealing": {
    },
  • "wearable": {
    },
  • "equipBonus": {
    },
  • "weapon": { },
  • "ammo": {
    },
  • "melee": {
    },
  • "fire": {
    },
  • "book": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "value": 0,
  • "weight": 0.1,
  • "inflictsDamage": 0,
  • "providesNutrition": 0,
  • "stackable": true,
  • "consumable": {
    },
  • "providesHealing": {
    },
  • "wearable": {
    },
  • "equipBonus": {
    },
  • "weapon": { },
  • "ammo": {
    },
  • "melee": {
    },
  • "fire": {
    },
  • "book": {
    }
}

Items_delete

アイテム削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Members

Members_list

メンバー一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Members_create

メンバー作成

Request Body schema: application/json
required
name
required
string

メンバー名

player
boolean

プレイヤーキャラクターかどうか

isBoss
required
boolean

ボスモンスターかどうか

required
object

基本能力値

spriteSheetName
required
string

スプライトシート名

spriteKey
required
string

スプライトキー

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

object

光源設定。未設定なら光源なし

factionType
string
Value: "FactionNeutral"

所属する派閥。未設定なら敵対

object

会話データ。未設定なら会話不可

commandTableName
required
string

参照するコマンドテーブル名

dropTableName
required
string

参照するドロップテーブル名

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "player": true,
  • "isBoss": true,
  • "abilities": {
    },
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "lightSource": {
    },
  • "factionType": "FactionNeutral",
  • "dialog": {
    },
  • "commandTableName": "string",
  • "dropTableName": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "player": true,
  • "isBoss": true,
  • "abilities": {
    },
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "lightSource": {
    },
  • "factionType": "FactionNeutral",
  • "dialog": {
    },
  • "commandTableName": "string",
  • "dropTableName": "string"
}

Members_get

メンバー詳細取得

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "player": true,
  • "isBoss": true,
  • "abilities": {
    },
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "lightSource": {
    },
  • "factionType": "FactionNeutral",
  • "dialog": {
    },
  • "commandTableName": "string",
  • "dropTableName": "string"
}

Members_update

メンバー更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

メンバー名

player
boolean

プレイヤーキャラクターかどうか

isBoss
required
boolean

ボスモンスターかどうか

required
object

基本能力値

spriteSheetName
required
string

スプライトシート名

spriteKey
required
string

スプライトキー

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

object

光源設定。未設定なら光源なし

factionType
string
Value: "FactionNeutral"

所属する派閥。未設定なら敵対

object

会話データ。未設定なら会話不可

commandTableName
required
string

参照するコマンドテーブル名

dropTableName
required
string

参照するドロップテーブル名

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "player": true,
  • "isBoss": true,
  • "abilities": {
    },
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "lightSource": {
    },
  • "factionType": "FactionNeutral",
  • "dialog": {
    },
  • "commandTableName": "string",
  • "dropTableName": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "player": true,
  • "isBoss": true,
  • "abilities": {
    },
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "lightSource": {
    },
  • "factionType": "FactionNeutral",
  • "dialog": {
    },
  • "commandTableName": "string",
  • "dropTableName": "string"
}

Members_delete

メンバー削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Recipes

Recipes_list

レシピ一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Recipes_create

レシピ作成

Request Body schema: application/json
required
name
required
string

レシピ名。生成されるアイテム名と一致する

required
Array of objects (RecipeInput)

必要素材のリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "inputs": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "inputs": [
    ]
}

Recipes_get

レシピ詳細取得

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "inputs": [
    ]
}

Recipes_update

レシピ更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

レシピ名。生成されるアイテム名と一致する

required
Array of objects (RecipeInput)

必要素材のリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "inputs": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "inputs": [
    ]
}

Recipes_delete

レシピ削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

CommandTables

CommandTables_list

コマンドテーブル一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

CommandTables_create

コマンドテーブル作成

Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (CommandTableEntry)

コマンドエントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

CommandTables_update

コマンドテーブル更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (CommandTableEntry)

コマンドエントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

CommandTables_delete

コマンドテーブル削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

DropTables

DropTables_list

ドロップテーブル一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

DropTables_create

ドロップテーブル作成

Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (DropTableEntry)

ドロップエントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

DropTables_update

ドロップテーブル更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (DropTableEntry)

ドロップエントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

DropTables_delete

ドロップテーブル削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

ItemTables

ItemTables_list

アイテムテーブル一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

ItemTables_create

アイテムテーブル作成

Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (ItemTableEntry)

アイテムエントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

ItemTables_update

アイテムテーブル更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (ItemTableEntry)

アイテムエントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

ItemTables_delete

アイテムテーブル削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

EnemyTables

EnemyTables_list

敵テーブル一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

EnemyTables_create

敵テーブル作成

Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (EnemyTableEntry)

敵エントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

EnemyTables_update

敵テーブル更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

テーブル名

required
Array of objects (EnemyTableEntry)

敵エントリのリスト

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "entries": [
    ]
}

EnemyTables_delete

敵テーブル削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Tiles

Tiles_list

タイル一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Tiles_create

タイル作成

Request Body schema: application/json
required
name
required
string

タイル名

description
required
string

タイルの説明文

blockPass
required
boolean

通行を妨げるかどうか

blockView
required
boolean

視線を遮るかどうか

required
object

スプライト描画設定

shelter
required
number
Enum: 0 5 10

遮蔽タイプ。戦闘時の命中率に影響する

water
required
number
Enum: 0 -5 -10

水タイプ。移動コストに影響する

foliage
required
number
Enum: 0 -1 -3

植生タイプ。視界に影響する

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "blockPass": true,
  • "blockView": true,
  • "spriteRender": {
    },
  • "shelter": 0,
  • "water": 0,
  • "foliage": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "blockPass": true,
  • "blockView": true,
  • "spriteRender": {
    },
  • "shelter": 0,
  • "water": 0,
  • "foliage": 0
}

Tiles_get

タイル詳細取得

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "blockPass": true,
  • "blockView": true,
  • "spriteRender": {
    },
  • "shelter": 0,
  • "water": 0,
  • "foliage": 0
}

Tiles_update

タイル更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

タイル名

description
required
string

タイルの説明文

blockPass
required
boolean

通行を妨げるかどうか

blockView
required
boolean

視線を遮るかどうか

required
object

スプライト描画設定

shelter
required
number
Enum: 0 5 10

遮蔽タイプ。戦闘時の命中率に影響する

water
required
number
Enum: 0 -5 -10

水タイプ。移動コストに影響する

foliage
required
number
Enum: 0 -1 -3

植生タイプ。視界に影響する

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "blockPass": true,
  • "blockView": true,
  • "spriteRender": {
    },
  • "shelter": 0,
  • "water": 0,
  • "foliage": 0
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "blockPass": true,
  • "blockView": true,
  • "spriteRender": {
    },
  • "shelter": 0,
  • "water": 0,
  • "foliage": 0
}

Tiles_delete

タイル削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Props

Props_list

置物一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Props_create

置物作成

Request Body schema: application/json
required
name
required
string

置物名

description
required
string

置物の説明文

required
object

スプライト描画設定

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

blockPass
required
boolean

通行を妨げるかどうか

blockView
required
boolean

視線を遮るかどうか

object

光源設定。未設定なら光源なし

door
object

扉データ。設定すると開閉可能な扉として動作する

doorLockTrigger
object

扉ロックトリガー。設定すると鍵付き扉として動作する

warpNextTrigger
object

次階層ワープトリガー。踏むと次の階層に進む

warpEscapeTrigger
object

脱出ワープトリガー。踏むとダンジョンから脱出する

dungeonGateTrigger
object

ダンジョン選択ゲートトリガー。調べるとダンジョン選択画面を開く

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteRender": {
    },
  • "animKeys": [
    ],
  • "blockPass": true,
  • "blockView": true,
  • "lightSource": {
    },
  • "door": { },
  • "doorLockTrigger": { },
  • "warpNextTrigger": { },
  • "warpEscapeTrigger": { },
  • "dungeonGateTrigger": { }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteRender": {
    },
  • "animKeys": [
    ],
  • "blockPass": true,
  • "blockView": true,
  • "lightSource": {
    },
  • "door": { },
  • "doorLockTrigger": { },
  • "warpNextTrigger": { },
  • "warpEscapeTrigger": { },
  • "dungeonGateTrigger": { }
}

Props_get

置物詳細取得

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteRender": {
    },
  • "animKeys": [
    ],
  • "blockPass": true,
  • "blockView": true,
  • "lightSource": {
    },
  • "door": { },
  • "doorLockTrigger": { },
  • "warpNextTrigger": { },
  • "warpEscapeTrigger": { },
  • "dungeonGateTrigger": { }
}

Props_update

置物更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

置物名

description
required
string

置物の説明文

required
object

スプライト描画設定

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

blockPass
required
boolean

通行を妨げるかどうか

blockView
required
boolean

視線を遮るかどうか

object

光源設定。未設定なら光源なし

door
object

扉データ。設定すると開閉可能な扉として動作する

doorLockTrigger
object

扉ロックトリガー。設定すると鍵付き扉として動作する

warpNextTrigger
object

次階層ワープトリガー。踏むと次の階層に進む

warpEscapeTrigger
object

脱出ワープトリガー。踏むとダンジョンから脱出する

dungeonGateTrigger
object

ダンジョン選択ゲートトリガー。調べるとダンジョン選択画面を開く

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteRender": {
    },
  • "animKeys": [
    ],
  • "blockPass": true,
  • "blockView": true,
  • "lightSource": {
    },
  • "door": { },
  • "doorLockTrigger": { },
  • "warpNextTrigger": { },
  • "warpEscapeTrigger": { },
  • "dungeonGateTrigger": { }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "spriteRender": {
    },
  • "animKeys": [
    ],
  • "blockPass": true,
  • "blockView": true,
  • "lightSource": {
    },
  • "door": { },
  • "doorLockTrigger": { },
  • "warpNextTrigger": { },
  • "warpEscapeTrigger": { },
  • "dungeonGateTrigger": { }
}

Props_delete

置物削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Professions

Professions_list

職業一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Professions_create

職業作成

Request Body schema: application/json
required
id
required
string

職業ID

name
required
string

職業名

description
required
string

職業の説明文

required
object

基本能力値

required
Array of objects (ProfessionSkill)

初期スキルのリスト

required
Array of objects (ProfessionItem)

初期所持アイテムのリスト

required
Array of objects (ProfessionEquip)

初期装備のリスト

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "abilities": {
    },
  • "skills": [
    ],
  • "items": [
    ],
  • "equips": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "abilities": {
    },
  • "skills": [
    ],
  • "items": [
    ],
  • "equips": [
    ]
}

Professions_update

職業更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
id
required
string

職業ID

name
required
string

職業名

description
required
string

職業の説明文

required
object

基本能力値

required
Array of objects (ProfessionSkill)

初期スキルのリスト

required
Array of objects (ProfessionItem)

初期所持アイテムのリスト

required
Array of objects (ProfessionEquip)

初期装備のリスト

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "abilities": {
    },
  • "skills": [
    ],
  • "items": [
    ],
  • "equips": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "abilities": {
    },
  • "skills": [
    ],
  • "items": [
    ],
  • "equips": [
    ]
}

Professions_delete

職業削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

SpriteSheets

SpriteSheets_list

スプライトシート一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

SpriteSheets_create

スプライトシート作成

Request Body schema: application/json
required
name
required
string

シート名

path
required
string

画像ファイルパス

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "path": "string"
}

SpriteSheets_update

スプライトシート更新

path Parameters
index
required
integer <int32>
Request Body schema: application/json
required
name
required
string

シート名

path
required
string

画像ファイルパス

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "path": "string"
}

SpriteSheets_delete

スプライトシート削除

path Parameters
index
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Palettes

Palettes_list

パレット一覧取得

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalCount": 0
}

Palettes_create

パレット作成

Request Body schema: application/json
required
id
required
string

パレットID

description
required
string

パレットの説明文

required
object

地形マッピング。マップ文字からタイル名への対応

required
object

置物マッピング。マップ文字から置物エントリへの対応

required
object

NPCマッピング。マップ文字からNPCエントリへの対応

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "terrain": {
    },
  • "props": {
    },
  • "npcs": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "terrain": {
    },
  • "props": {
    },
  • "npcs": {
    }
}

Palettes_get

パレット詳細取得

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "terrain": {
    },
  • "props": {
    },
  • "npcs": {
    }
}

Palettes_update

パレット更新

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string

パレットID

description
required
string

パレットの説明文

required
object

地形マッピング。マップ文字からタイル名への対応

required
object

置物マッピング。マップ文字から置物エントリへの対応

required
object

NPCマッピング。マップ文字からNPCエントリへの対応

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "terrain": {
    },
  • "props": {
    },
  • "npcs": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "description": "string",
  • "terrain": {
    },
  • "props": {
    },
  • "npcs": {
    }
}

Palettes_delete

パレット削除

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Models

Abilities

vitality
required
integer <int32>

体力。HPに影響する

strength
required
integer <int32>

筋力。物理ダメージに影響する

sensation
required
integer <int32>

感覚。命中率と回避率に影響する

dexterity
required
integer <int32>

器用さ。クリティカル率に影響する

agility
required
integer <int32>

敏捷性。行動順に影響する

defense
required
integer <int32>

防御力。被ダメージを軽減する

{
  • "vitality": 0,
  • "strength": 0,
  • "sensation": 0,
  • "dexterity": 0,
  • "agility": 0,
  • "defense": 0
}

Ammo

ammoTag
required
string
Enum: "9mm" "rifle" "shell" "energy_cell"

弾薬の種類タグ

damageBonus
required
integer <int32>

ダメージ補正値

accuracyBonus
required
integer <int32>

命中率補正値

{
  • "ammoTag": "9mm",
  • "damageBonus": 0,
  • "accuracyBonus": 0
}

AmmoTag

string (AmmoTag)
Enum: "9mm" "rifle" "shell" "energy_cell"

弾薬タグ

"9mm"

AttackCategory

string (AttackCategory)
Enum: "FIST" "SWORD" "SPEAR" "HANDGUN" "RIFLE" "CANON" "BOW"

攻撃種別

"FIST"

Book

totalEffort
required
integer <int32>

読了に必要な総読書量

object

スキル本としての設定。未設定なら娯楽本

{
  • "totalEffort": 0,
  • "skill": {
    }
}

CommandTable

name
required
string

テーブル名

required
Array of objects (CommandTableEntry)

コマンドエントリのリスト

{
  • "name": "string",
  • "entries": [
    ]
}

CommandTableEntry

weapon
required
string

使用する武器名

weight
required
number <double>

選択される重み。大きいほど選ばれやすい

{
  • "weapon": "string",
  • "weight": 0.1
}

CommandTableList

required
Array of objects (CommandTable)

コマンドテーブルの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

Consumable

usableScene
required
string
Enum: "BATTLE" "FIELD" "ANY"

使用可能なシーン

targetGroup
required
string
Enum: "ENEMY" "ALLY" "WEAPON" "NONE"

効果の対象グループ

targetNum
required
string
Enum: "SINGLE" "ALL"

効果の対象数

{
  • "usableScene": "BATTLE",
  • "targetGroup": "ENEMY",
  • "targetNum": "SINGLE"
}

Dialog

messageKey
required
string

メッセージリソースのキー

{
  • "messageKey": "string"
}

DoorLockTriggerRaw

object (DoorLockTriggerRaw)

扉ロックトリガー

{ }

DoorRaw

object (DoorRaw)

扉ローデータ

{ }

DropTable

name
required
string

テーブル名

required
Array of objects (DropTableEntry)

ドロップエントリのリスト

{
  • "name": "string",
  • "entries": [
    ]
}

DropTableEntry

material
required
string

ドロップする素材名

weight
required
number <double>

ドロップする重み。大きいほど選ばれやすい

{
  • "material": "string",
  • "weight": 0.1
}

DropTableList

required
Array of objects (DropTable)

ドロップテーブルの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

DungeonGateTriggerRaw

object (DungeonGateTriggerRaw)

ダンジョン選択ゲートトリガー

{ }

Element

string (Element)
Enum: "NONE" "FIRE" "THUNDER" "CHILL" "PHOTON"

攻撃属性

"NONE"

EnemyTable

name
required
string

テーブル名

required
Array of objects (EnemyTableEntry)

敵エントリのリスト

{
  • "name": "string",
  • "entries": [
    ]
}

EnemyTableEntry

enemyName
required
string

出現する敵メンバー名

weight
required
number <double>

出現する重み。大きいほど選ばれやすい

minDepth
required
integer <int32>

出現する最小階層

maxDepth
required
integer <int32>

出現する最大階層

{
  • "enemyName": "string",
  • "weight": 0.1,
  • "minDepth": 0,
  • "maxDepth": 0
}

EnemyTableList

required
Array of objects (EnemyTable)

敵テーブルの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

EquipBonus

vitality
required
integer <int32>

体力ボーナス

strength
required
integer <int32>

筋力ボーナス

sensation
required
integer <int32>

感覚ボーナス

dexterity
required
integer <int32>

器用さボーナス

agility
required
integer <int32>

敏捷性ボーナス

{
  • "vitality": 0,
  • "strength": 0,
  • "sensation": 0,
  • "dexterity": 0,
  • "agility": 0
}

EquipSlot

string (EquipSlot)
Enum: "HEAD" "TORSO" "ARMS" "HANDS" "LEGS" "FEET" "WEAPON1" "WEAPON2" "WEAPON3" "WEAPON4" "WEAPON5"

装備スロット。防具部位 + 武器スロット

"HEAD"

EquipmentCategory

string (EquipmentCategory)
Enum: "HEAD" "TORSO" "ARMS" "HANDS" "LEGS" "FEET" "JEWELRY"

装備部位

"HEAD"

Error

message
required
string

エラーメッセージ

{
  • "message": "string"
}

FactionMemberType

string (FactionMemberType)
Value: "FactionNeutral"

派閥タイプ

"FactionNeutral"

Fire

accuracy
required
integer <int32>

命中率

damage
required
integer <int32>

ダメージ

attackCount
required
integer <int32>

1ターンあたりの攻撃回数

element
required
string
Enum: "NONE" "FIRE" "THUNDER" "CHILL" "PHOTON"

攻撃属性

attackCategory
required
string
Enum: "FIST" "SWORD" "SPEAR" "HANDGUN" "RIFLE" "CANON" "BOW"

攻撃種別

cost
required
integer <int32>

行動コスト

targetGroup
required
string
Enum: "ENEMY" "ALLY" "WEAPON" "NONE"

対象グループ

targetNum
required
string
Enum: "SINGLE" "ALL"

対象数

magazineSize
required
integer <int32>

マガジン容量

reloadEffort
required
integer <int32>

リロードに必要な行動力

ammoTag
required
string
Enum: "9mm" "rifle" "shell" "energy_cell"

使用する弾薬の種類

{
  • "accuracy": 0,
  • "damage": 0,
  • "attackCount": 0,
  • "element": "NONE",
  • "attackCategory": "FIST",
  • "cost": 0,
  • "targetGroup": "ENEMY",
  • "targetNum": "SINGLE",
  • "magazineSize": 0,
  • "reloadEffort": 0,
  • "ammoTag": "9mm"
}

FoliageType

number (FoliageType)
Enum: 0 -1 -3

植生タイプ

0
0

HealingValueType

string (HealingValueType)
Value: "PERCENTAGE"

回復量の計算方式

"PERCENTAGE"

Item

name
required
string

アイテム名

description
required
string

アイテムの説明文

spriteSheetName
required
string

スプライトシート名

spriteKey
required
string

スプライトキー

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

value
required
integer <int32>

売買価格

weight
number <double>

重量。未設定なら0

inflictsDamage
integer <int32>

投擲ダメージ。未設定なら投擲不可

providesNutrition
integer <int32>

栄養価。未設定なら食べられない

stackable
boolean

スタック可能かどうか

object

消費アイテム設定

object

回復効果

object

防具設定

object

装備ボーナス

weapon
object

武器マーカー。存在すれば武器として扱う

object

弾薬設定

object

近接攻撃設定

object

遠距離攻撃設定

object

本設定

{
  • "name": "string",
  • "description": "string",
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "value": 0,
  • "weight": 0.1,
  • "inflictsDamage": 0,
  • "providesNutrition": 0,
  • "stackable": true,
  • "consumable": {
    },
  • "providesHealing": {
    },
  • "wearable": {
    },
  • "equipBonus": {
    },
  • "weapon": { },
  • "ammo": {
    },
  • "melee": {
    },
  • "fire": {
    },
  • "book": {
    }
}

ItemList

required
Array of objects (Item)

アイテムの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

ItemTable

name
required
string

テーブル名

required
Array of objects (ItemTableEntry)

アイテムエントリのリスト

{
  • "name": "string",
  • "entries": [
    ]
}

ItemTableEntry

itemName
required
string

出現するアイテム名

weight
required
number <double>

出現する重み。大きいほど選ばれやすい

minDepth
required
integer <int32>

出現する最小階層

maxDepth
required
integer <int32>

出現する最大階層

{
  • "itemName": "string",
  • "weight": 0.1,
  • "minDepth": 0,
  • "maxDepth": 0
}

ItemTableList

required
Array of objects (ItemTable)

アイテムテーブルの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

LightSource

radius
required
integer <int32>

光の到達半径

required
object

光の色

enabled
required
boolean

光源が有効かどうか

{
  • "radius": 0,
  • "color": {
    },
  • "enabled": true
}

Melee

accuracy
required
integer <int32>

命中率

damage
required
integer <int32>

ダメージ

attackCount
required
integer <int32>

1ターンあたりの攻撃回数

element
required
string
Enum: "NONE" "FIRE" "THUNDER" "CHILL" "PHOTON"

攻撃属性

attackCategory
required
string
Enum: "FIST" "SWORD" "SPEAR" "HANDGUN" "RIFLE" "CANON" "BOW"

攻撃種別

cost
required
integer <int32>

行動コスト

targetGroup
required
string
Enum: "ENEMY" "ALLY" "WEAPON" "NONE"

対象グループ

targetNum
required
string
Enum: "SINGLE" "ALL"

対象数

{
  • "accuracy": 0,
  • "damage": 0,
  • "attackCount": 0,
  • "element": "NONE",
  • "attackCategory": "FIST",
  • "cost": 0,
  • "targetGroup": "ENEMY",
  • "targetNum": "SINGLE"
}

Member

name
required
string

メンバー名

player
boolean

プレイヤーキャラクターかどうか

isBoss
required
boolean

ボスモンスターかどうか

required
object

基本能力値

spriteSheetName
required
string

スプライトシート名

spriteKey
required
string

スプライトキー

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

object

光源設定。未設定なら光源なし

factionType
string
Value: "FactionNeutral"

所属する派閥。未設定なら敵対

object

会話データ。未設定なら会話不可

commandTableName
required
string

参照するコマンドテーブル名

dropTableName
required
string

参照するドロップテーブル名

{
  • "name": "string",
  • "player": true,
  • "isBoss": true,
  • "abilities": {
    },
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "animKeys": [
    ],
  • "lightSource": {
    },
  • "factionType": "FactionNeutral",
  • "dialog": {
    },
  • "commandTableName": "string",
  • "dropTableName": "string"
}

MemberList

required
Array of objects (Member)

メンバーの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

Palette

id
required
string

パレットID

description
required
string

パレットの説明文

required
object

地形マッピング。マップ文字からタイル名への対応

required
object

置物マッピング。マップ文字から置物エントリへの対応

required
object

NPCマッピング。マップ文字からNPCエントリへの対応

{
  • "id": "string",
  • "description": "string",
  • "terrain": {
    },
  • "props": {
    },
  • "npcs": {
    }
}

PaletteEntry

id
required
string

エントリID

tile
required
string

対応するタイル名

{
  • "id": "string",
  • "tile": "string"
}

PaletteList

required
Array of objects (Palette)

パレットの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

Profession

id
required
string

職業ID

name
required
string

職業名

description
required
string

職業の説明文

required
object

基本能力値

required
Array of objects (ProfessionSkill)

初期スキルのリスト

required
Array of objects (ProfessionItem)

初期所持アイテムのリスト

required
Array of objects (ProfessionEquip)

初期装備のリスト

{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "abilities": {
    },
  • "skills": [
    ],
  • "items": [
    ],
  • "equips": [
    ]
}

ProfessionEquip

name
required
string

装備アイテム名

slot
required
string
Enum: "HEAD" "TORSO" "ARMS" "HANDS" "LEGS" "FEET" "WEAPON1" "WEAPON2" "WEAPON3" "WEAPON4" "WEAPON5"

装備するスロット

{
  • "name": "string",
  • "slot": "HEAD"
}

ProfessionItem

name
required
string

アイテム名

count
required
integer <int32>

所持数

{
  • "name": "string",
  • "count": 0
}

ProfessionList

required
Array of objects (Profession)

職業の配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

ProfessionSkill

id
required
string

スキルID

value
required
integer <int32>

初期スキルレベル

{
  • "id": "string",
  • "value": 0
}

Prop

name
required
string

置物名

description
required
string

置物の説明文

required
object

スプライト描画設定

animKeys
required
Array of strings

アニメーション用スプライトキーの配列

blockPass
required
boolean

通行を妨げるかどうか

blockView
required
boolean

視線を遮るかどうか

object

光源設定。未設定なら光源なし

door
object

扉データ。設定すると開閉可能な扉として動作する

doorLockTrigger
object

扉ロックトリガー。設定すると鍵付き扉として動作する

warpNextTrigger
object

次階層ワープトリガー。踏むと次の階層に進む

warpEscapeTrigger
object

脱出ワープトリガー。踏むとダンジョンから脱出する

dungeonGateTrigger
object

ダンジョン選択ゲートトリガー。調べるとダンジョン選択画面を開く

{
  • "name": "string",
  • "description": "string",
  • "spriteRender": {
    },
  • "animKeys": [
    ],
  • "blockPass": true,
  • "blockView": true,
  • "lightSource": {
    },
  • "door": { },
  • "doorLockTrigger": { },
  • "warpNextTrigger": { },
  • "warpEscapeTrigger": { },
  • "dungeonGateTrigger": { }
}

PropList

required
Array of objects (Prop)

置物の配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

ProvidesHealing

valueType
required
string
Value: "PERCENTAGE"

回復量の計算方式

amount
required
integer <int32>

回復固定量

ratio
required
number <double>

回復割合。0.0〜1.0

{
  • "valueType": "PERCENTAGE",
  • "amount": 0,
  • "ratio": 0.1
}

RGBAColor

r
required
integer <uint8>

赤 (0-255)

g
required
integer <uint8>

緑 (0-255)

b
required
integer <uint8>

青 (0-255)

a
required
integer <uint8>

透明度 (0-255)

{
  • "r": 0,
  • "g": 0,
  • "b": 0,
  • "a": 0
}

Recipe

name
required
string

レシピ名。生成されるアイテム名と一致する

required
Array of objects (RecipeInput)

必要素材のリスト

{
  • "name": "string",
  • "inputs": [
    ]
}

RecipeInput

name
required
string

素材アイテム名

amount
required
integer <int32>

必要個数

{
  • "name": "string",
  • "amount": 0
}

RecipeList

required
Array of objects (Recipe)

レシピの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

ShelterType

number (ShelterType)
Enum: 0 5 10

遮蔽タイプ

0
0

SkillBook

targetSkill
required
string

習得対象のスキルID

requiredLevel
required
integer <int32>

習得に必要なスキルレベル

maxLevel
required
integer <int32>

習得可能な最大レベル

{
  • "targetSkill": "string",
  • "requiredLevel": 0,
  • "maxLevel": 0
}

SpriteDepth

number (SpriteDepth)
Enum: 0 1 2 3

スプライト描画深度

0
0

SpriteRender

spriteSheetName
required
string

スプライトシート名

spriteKey
required
string

スプライトキー

depth
required
number
Enum: 0 1 2 3

描画深度。レイヤー順序を決定する

{
  • "spriteSheetName": "string",
  • "spriteKey": "string",
  • "depth": 0
}

SpriteSheet

name
required
string

シート名

path
required
string

画像ファイルパス

{
  • "name": "string",
  • "path": "string"
}

SpriteSheetList

required
Array of objects (SpriteSheet)

スプライトシートの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

TargetGroup

string (TargetGroup)
Enum: "ENEMY" "ALLY" "WEAPON" "NONE"

ターゲットグループ

"ENEMY"

TargetNum

string (TargetNum)
Enum: "SINGLE" "ALL"

ターゲット数

"SINGLE"

Tile

name
required
string

タイル名

description
required
string

タイルの説明文

blockPass
required
boolean

通行を妨げるかどうか

blockView
required
boolean

視線を遮るかどうか

required
object

スプライト描画設定

shelter
required
number
Enum: 0 5 10

遮蔽タイプ。戦闘時の命中率に影響する

water
required
number
Enum: 0 -5 -10

水タイプ。移動コストに影響する

foliage
required
number
Enum: 0 -1 -3

植生タイプ。視界に影響する

{
  • "name": "string",
  • "description": "string",
  • "blockPass": true,
  • "blockView": true,
  • "spriteRender": {
    },
  • "shelter": 0,
  • "water": 0,
  • "foliage": 0
}

TileList

required
Array of objects (Tile)

タイルの配列

totalCount
required
integer <int32>

総件数

{
  • "data": [
    ],
  • "totalCount": 0
}

UsableScene

string (UsableScene)
Enum: "BATTLE" "FIELD" "ANY"

使用可能シーン

"BATTLE"

WarpEscapeTriggerRaw

object (WarpEscapeTriggerRaw)

脱出ワープトリガー

{ }

WarpNextTriggerRaw

object (WarpNextTriggerRaw)

次階層ワープトリガー

{ }

WaterType

number (WaterType)
Enum: 0 -5 -10

水タイプ

0
0

Weapon

object (Weapon)

武器マーカー

{ }

Wearable

defense
required
integer <int32>

防御力

equipmentCategory
required
string
Enum: "HEAD" "TORSO" "ARMS" "HANDS" "LEGS" "FEET" "JEWELRY"

装備する部位

insulationCold
required
integer <int32>

耐寒性能

insulationHeat
required
integer <int32>

耐暑性能

{
  • "defense": 0,
  • "equipmentCategory": "HEAD",
  • "insulationCold": 0,
  • "insulationHeat": 0
}