CBT (v0.2.1.20) Protocol Documentation

Table of Contents

extension/apipb.proto

Top

ApiDefinition

FieldTypeLabelDescription
path string

description string

without_session bool

user_errors string repeated

FieldOptions

FieldTypeLabelDescription
enum_table string

File-level Extensions

ExtensionTypeBaseNumberDescription
field_options FieldOptions .google.protobuf.FieldOptions 50100

api_definition ApiDefinition .google.protobuf.MethodOptions 50000

extension/elixirpb.proto

Top

FileOptions

FieldTypeLabelDescription
module_prefix string optional

File-level Extensions

ExtensionTypeBaseNumberDescription
file FileOptions .google.protobuf.FileOptions 1047

extension/validate.proto

Top

FieldRules

FieldTypeLabelDescription
message MessageRules optional

int32 Int32Rules optional

uint64 UInt64Rules optional

string StringRules optional

repeated RepeatedRules optional

Int32Rules

FieldTypeLabelDescription
lt int32 optional

lte int32 optional

gt int32 optional

gte int32 optional

MessageRules

FieldTypeLabelDescription
required bool optional

RepeatedRules

FieldTypeLabelDescription
min_items uint64 optional

max_items uint64 optional

unique bool optional

items FieldRules optional

StringRules

FieldTypeLabelDescription
min_len uint64 optional

max_len uint64 optional

UInt64Rules

FieldTypeLabelDescription
lt uint64 optional

lte uint64 optional

gt uint64 optional

gte uint64 optional

File-level Extensions

ExtensionTypeBaseNumberDescription
rules FieldRules .google.protobuf.FieldOptions 1071

enum/battle_advantage_type.proto

Top

BattleAdvantageType

NameNumberDescription
normal 0

advantage 1

disadvantage 2

enum/battle_result.proto

Top

BattleResult

NameNumberDescription
won 0

lost 1

retire 2

enum/battle_task_topic_type.proto

Top

BattleTaskTopicType

NameNumberDescription
attach_pressure 0

attach_unfortified 1

shark_eat_mine 2

heal_hp 3

brave_diver_break_leg 4

special_attack 5

qte 6

attach_scared 7

attach_electric 8

enum/battle_trigger_type.proto

Top

BattleTriggerType

NameNumberDescription
area_enemy 0

area_object 1

action_sequence 2

field_boss 3

dungeon 4

enum/battle_won_result_type.proto

Top

BattleWonResultType

NameNumberDescription
on_adventure 0

on_battle 1

consume_stamina 2

enum/reward_receive_status.proto

Top

RewardReceiveStatus

NameNumberDescription
received 0

not_received 1

stamina_deficiency 2

reached_receive_count_limit 3

enum/stamina_recovery_type.proto

Top

StaminaRecoveryType

NameNumberDescription
non_recovery 0

purchase 1

item 2

enum/xb_command_unlock_status.proto

Top

XbCommandLockStatus

NameNumberDescription
none 0

locked 1

unlocked 2

model/ability_efficacy.proto

Top

AbilityEfficacy

FieldTypeLabelDescription
id int32

ability_efficacy_group_id google.protobuf.Int32Value

cool_time_millisecond int32

effect_cool_time_millisecond int32

active_time_millisecond int32

efficacy_type int32

probability int32

activate_conditions string

deactivate_conditions string

sustain_conditions string

target_conditions string

f_values float repeated

values int32 repeated

ui_view_priority int32

effect_value_steps float repeated

target_type int32

maximum_active_time_millisecond google.protobuf.Int32Value

model/adventure_variable.proto

Top

AdventureVariable

FieldTypeLabelDescription
adventure_variable_id int32

value int32

model/area_bgm.proto

Top

AreaBgm

FieldTypeLabelDescription
id int32

event_name string

model/area_change_lock.proto

Top

AreaChangeLock

FieldTypeLabelDescription
area_change_lock_id int32

model/area_group.proto

Top

AreaGroup

FieldTypeLabelDescription
area_group_id int32

model/area_object.proto

Top

AreaObject

FieldTypeLabelDescription
area_object_id google.protobuf.Int32Value

area_point_id int32

area_object_behavior_id google.protobuf.Int32Value

area_item_spawn_id google.protobuf.Int32Value

area_enemy_rate_set_id google.protobuf.Int32Value

action AreaObjectAction

challenge_progress_id int32

AreaObjectAction

FieldTypeLabelDescription
type int32

label google.protobuf.StringValue

area_item_id google.protobuf.Int32Value

acquired google.protobuf.BoolValue

area_enemy_id google.protobuf.Int32Value

battle_entry_id google.protobuf.Int32Value

sequence_id google.protobuf.Int32Value

warp_point_id google.protobuf.Int32Value

field_boss_id google.protobuf.Int32Value

dungeon_id google.protobuf.Int32Value

model/area.proto

Top

Area

FieldTypeLabelDescription
area_id int32

is_dark bool

AreaBehavior

FieldTypeLabelDescription
action_sequence_id int32

model/attack.proto

Top

Attack

FieldTypeLabelDescription
id int32

power_multiply float

hitback_distance float

attacker_hit_slow_time float

attacker_hit_slow_speed float

defender_hit_slow_time float

defender_hit_slow_speed float

hit_interval float

blow_up_parameter_master_id int32

hit_condition_skill_id google.protobuf.Int32Value

attack_attributes int32 repeated

model/battle.proto

Top

AbnormalityParam

FieldTypeLabelDescription
attack_rate float

defense_rate float

burst_resistance float

burst_resistance_limit float

burst_resistance_increase_value float

AbnormalityParamSet

FieldTypeLabelDescription
oily AbnormalityParam

pressure AbnormalityParam

scared AbnormalityParam

electric AbnormalityParam

unfortified AbnormalityParam

BattleCharacterUpdate

FieldTypeLabelDescription
character_id int32

hp int32

sp_gauge google.protobuf.Int32Value

BattleParameter

FieldTypeLabelDescription
id int32

field_name string

bgm_id int32

camera_settings_asset string

enemy_level int32

waves BattleWave repeated

wave_conditions BattleWaveCondition repeated

enemies Enemy repeated

pos_x float

pos_y float

pos_z float

rot float

map_rot float

BattleTaskTopic

FieldTypeLabelDescription
type neon.enum.BattleTaskTopicType

count int32

BattleTrigger

FieldTypeLabelDescription
trigger_type neon.enum.BattleTriggerType

trigger_ids int32 repeated

Validated Fields

Field Validations
trigger_ids
  • repeated.items.int32.gte: 1

BattleWave

FieldTypeLabelDescription
id int32

enemies int32 repeated

tension_rule_id int32

BattleWaveCondition

FieldTypeLabelDescription
id int32

condition_type int32

values int32 repeated

f_values float repeated

Enemy

FieldTypeLabelDescription
id int32

name string

title string

description string

is_boss bool

attack int32

defense int32

hp int32

guard_durability int32

movement_speed int32

support_power_rate float

costume_id string

character_action_id int32

character_action_resource_id int32

ability_passive_ids int32 repeated

battle_vfx_id int32

push_weight_type int32

tension_value int32

drop_exp int32

character_weapon_costume_ids int32 repeated

abnormality_param_set AbnormalityParamSet

is_skip_encounter_animation bool

hp_stack_count google.protobuf.Int32Value

model/blood_stain.proto

Top

BloodStain

FieldTypeLabelDescription
area_enemy_id google.protobuf.Int32Value

field_boss_id google.protobuf.Int32Value

dungeon_id google.protobuf.Int32Value

position string

formation Formation

characters BloodStainCharacter repeated

tension_cards BloodStainTensionCard repeated

area_id int32

user_id int64

user_name string

BloodStainCharacter

FieldTypeLabelDescription
character_id int32

exp int32

rank int32

character_costume_id google.protobuf.Int32Value

BloodStainLocation

FieldTypeLabelDescription
area_id int32

position string

BloodStainTensionCard

FieldTypeLabelDescription
tension_card_id int32

exp int32

limit_break int32

model/bulk_mail.proto

Top

BulkMail

FieldTypeLabelDescription
id int32

subject string

body string

sender string

model/challenge_progress.proto

Top

ChallengeProgress

FieldTypeLabelDescription
challenge_progress_id int32

cleared_at google.protobuf.Timestamp

model/challenge.proto

Top

Challenge

FieldTypeLabelDescription
challenge_id int32

cleared_at google.protobuf.Timestamp

expires_at google.protobuf.Timestamp

state google.protobuf.Int32Value

model/challenge_task.proto

Top

ChallengeTask

FieldTypeLabelDescription
challenge_task_id int32

count google.protobuf.Int32Value

cleared_at google.protobuf.Timestamp

model/character_costume.proto

Top

CharacterCostume

FieldTypeLabelDescription
character_costume_id int32

received_at google.protobuf.Timestamp

model/character_piece.proto

Top

CharacterPiece

FieldTypeLabelDescription
character_id int32

quantity int32

model/character.proto

Top

Character

FieldTypeLabelDescription
character_id int32

exp int32

limit_break int32

hp int32

attack int32

defense int32

max_hp int32

sp_gauge int32

gear_slot1 google.protobuf.Int32Value

gear_slot2 google.protobuf.Int32Value

gear_slot3 google.protobuf.Int32Value

gear_series_ids int32 repeated

gear_type_ids int32 repeated

received_at google.protobuf.Timestamp

character_ownership_type int32

dish_id google.protobuf.Int32Value

dish_effect_count int32

dish_effect_expired_at google.protobuf.Timestamp

rank int32

critical_rate float

critical_damage_rate float

support_power_rate int32

movement_speed float

power_rate float

dodge_speed float

damage_inflicted_rate float

tension_increase_rate float

cp_recast_rate float

recovery_given_rate float

sp_gauge_increase_rate float

attack_speed float

character_costume_id google.protobuf.Int32Value

ability_efficacies AbilityEfficacy repeated

attacks Attack repeated

limited_ability_efficacy_ids int32 repeated

character_skill_panel1_level int32

character_skill_panel2_level int32

character_skill_panel3_level int32

character_skill_panel4_level int32

character_skill_panel5_level int32

limited_character_skill_ids int32 repeated

abnormality_param_set AbnormalityParamSet

likability int32

training_score int32

training_score_level_score int32

training_score_rank_score int32

Validated Fields

Field Validations
dish_effect_count
  • int32.gte: 0
character_skill_panel1_level
  • int32.gte: 0
character_skill_panel2_level
  • int32.gte: 0
character_skill_panel3_level
  • int32.gte: 0
character_skill_panel4_level
  • int32.gte: 0
character_skill_panel5_level
  • int32.gte: 0

CharacterDish

FieldTypeLabelDescription
character_id int32

dish_id int32

dish_effect_count int32

CharacterExp

FieldTypeLabelDescription
character_id int32

exp int32

model/city.proto

Top

City

FieldTypeLabelDescription
city_id int32

model/current_location.proto

Top

CurrentLocation

FieldTypeLabelDescription
area_id google.protobuf.Int32Value

position google.protobuf.StringValue

direction google.protobuf.Int32Value

model/dungeon_difficulty.proto

Top

DungeonDifficulty

FieldTypeLabelDescription
dungeon_difficulty_id int32

dungeon_pieces DungeonDifficultyPiece repeated

DungeonDifficultyPiece

FieldTypeLabelDescription
dungeon_piece_id int32

x int32

y int32

rotate int32

model/dungeon_enemy.proto

Top

DungeonEnemy

FieldTypeLabelDescription
entity_id int32

dungeon_enemy_rate_id int32

is_boss bool

dungeon_difficulty_id int32

dungeon_piece_id int32

dungeon_piece_x int32

dungeon_piece_y int32

dungeon_piece_index int32

defeated_at google.protobuf.Timestamp

model/dungeon.proto

Top

Dungeon

FieldTypeLabelDescription
dungeon_id int32

model/formation.proto

Top

Formation

FieldTypeLabelDescription
number int32

members FormationMembers

cards FormationCards

FormationCards

FieldTypeLabelDescription
tension_card1_id google.protobuf.Int32Value

tension_card2_id google.protobuf.Int32Value

tension_card3_id google.protobuf.Int32Value

tension_card4_id google.protobuf.Int32Value

tension_card5_id google.protobuf.Int32Value

FormationMembers

FieldTypeLabelDescription
character1_id google.protobuf.Int32Value

character2_id google.protobuf.Int32Value

character3_id google.protobuf.Int32Value

character1_ownership_type google.protobuf.Int32Value

character2_ownership_type google.protobuf.Int32Value

character3_ownership_type google.protobuf.Int32Value

model/gacha_button_state.proto

Top

GachaButtonState

FieldTypeLabelDescription
gacha_id int32

gacha_button_id int32

execution_count int32

last_executed_at google.protobuf.Timestamp

model/gacha_card.proto

Top

GachaCard

FieldTypeLabelDescription
card_type int32

card_id int32

is_attention bool

model/gacha_category_state.proto

Top

GachaCategoryState

FieldTypeLabelDescription
gacha_category_id int32

guaranteed_count int32

is_guaranteed_pickup bool

model/gacha_history.proto

Top

GachaHistory

FieldTypeLabelDescription
gacha_category_id int32

gacha_id int32

gacha_button_id int32

costs Resource repeated

drawn_rewards GachaReward repeated

executed_at google.protobuf.Timestamp

model/gacha_notification.proto

Top

GachaNotification

FieldTypeLabelDescription
latest_gacha_start_at google.protobuf.Timestamp

executable_gacha_ids int32 repeated

model/gacha_rate.proto

Top

GachaRate

FieldTypeLabelDescription
gacha_rate_id int32

percent_rate string

percent_rate_per_card string

cards GachaCard repeated

Validated Fields

Field Validations
percent_rate
  • string.min_len: 5
percent_rate_per_card
  • string.min_len: 5
cards
  • repeated.min_items: 1

model/gacha_rate_set.proto

Top

GachaRateSet

FieldTypeLabelDescription
gacha_rate_set_id int32

rows GachaRate repeated

Validated Fields

Field Validations
rows
  • repeated.min_items: 1

model/gacha.proto

Top

Gacha

FieldTypeLabelDescription
gacha_id int32

gacha_button_states GachaButtonState repeated

gacha_category_state GachaCategoryState

model/gacha_reward.proto

Top

GachaReward

FieldTypeLabelDescription
type int32

id int32

alternative_rewards Resource repeated

model/gear.proto

Top

Gear

FieldTypeLabelDescription
entity_id int32

gear_id int32

exp int32

received_at google.protobuf.Timestamp

is_locked bool

main_status_id google.protobuf.Int32Value

sub_status1_id google.protobuf.Int32Value

sub_status2_id google.protobuf.Int32Value

sub_status3_id google.protobuf.Int32Value

sub_status4_id google.protobuf.Int32Value

sub_status1_level int32

sub_status2_level int32

sub_status3_level int32

sub_status4_level int32

training_score_level_score int32

model/happy_worker_item.proto

Top

HappyWorkerItem

FieldTypeLabelDescription
happy_worker_item_id int32

is_cleared bool

state google.protobuf.Int32Value

model/item.proto

Top

ConsumedItem

FieldTypeLabelDescription
item_id int32

quantity int32

Validated Fields

Field Validations
quantity
  • int32.gte: 1

Item

FieldTypeLabelDescription
item_id int32

quantity int32

Validated Fields

Field Validations
quantity
  • int32.gte: 0

model/item_supply.proto

Top

ItemSupply

FieldTypeLabelDescription
entity_id int32

item_supply_id int32

received_at google.protobuf.Timestamp

model/login_bonus.proto

Top

LoginBonus

FieldTypeLabelDescription
login_bonus_id int32

received_day int32

logged_in_day int32

model/mail_list.proto

Top

MailList

FieldTypeLabelDescription
unopened Mail repeated

opened Mail repeated

bulk_mails BulkMail repeated

model/mail_params.proto

Top

MailParams

FieldTypeLabelDescription
mail_template_id google.protobuf.Int32Value

subject string

body string

bulk_mail_id google.protobuf.Int32Value

sender string

model/mail.proto

Top

Mail

FieldTypeLabelDescription
entity_id int32

mail_type int32

mail_params MailParams

rewards Resource repeated

created_at google.protobuf.Timestamp

opened_at google.protobuf.Timestamp

end_at google.protobuf.Timestamp

Validated Fields

Field Validations
mail_params
  • message.required: true
created_at
  • message.required: true

model/master_data.proto

Top

MasterData

FieldTypeLabelDescription
shop_products ShopProduct repeated

shop_product_limited_discounts ShopProductLimitedDiscount repeated

model/mission_count_reward_state.proto

Top

MissionCountRewardState

FieldTypeLabelDescription
mission_count_reward_id int32

received_step_count int32

model/mission.proto

Top

Mission

FieldTypeLabelDescription
mission_id int32

count int32

received_step_count int32

reset_at google.protobuf.Timestamp

cleared_at google.protobuf.Timestamp

model/news_item.proto

Top

NewsItem

FieldTypeLabelDescription
news_group_id int32

priority int32

category int32

title string

start_at google.protobuf.Timestamp

edited_at google.protobuf.Timestamp

is_important bool

model/news_notification.proto

Top

NewsNotification

FieldTypeLabelDescription
updated_at google.protobuf.Timestamp

important_updated_at google.protobuf.Timestamp

model/nine_sequence.proto

Top

NineSequence

FieldTypeLabelDescription
nine_sequence_id int32

choices google.protobuf.StringValue

expires_at google.protobuf.Timestamp

last_receive_at google.protobuf.Timestamp

last_read_at google.protobuf.Timestamp

NineSequenceRequest

FieldTypeLabelDescription
id int32

choices google.protobuf.StringValue

Validated Fields

Field Validations
id
  • int32.gte: 1

model/notifications.proto

Top

Notifications

FieldTypeLabelDescription
gacha GachaNotification

mail google.protobuf.BoolValue

model/profile.proto

Top

Profile

FieldTypeLabelDescription
name string

Validated Fields

Field Validations
name
  • string.min_len: 1

model/resource_entities.proto

Top

ResourceEntities

FieldTypeLabelDescription
gear_entity_ids int32 repeated

item_supply_entity_ids int32 repeated

model/resource_params.proto

Top

ResourceParams

FieldTypeLabelDescription
old_limit_break google.protobuf.Int32Value

new_limit_break google.protobuf.Int32Value

model/resource.proto

Top

ConsumedQuantifiedResource

FieldTypeLabelDescription
type int32

id int32

quantity int32

Validated Fields

Field Validations
quantity
  • int32.gte: 1

Resource

FieldTypeLabelDescription
type int32

id int32

quantity int32

resource_params ResourceParams

Validated Fields

Field Validations
quantity
  • int32.gte: 0

model/resources.proto

Top

Resources

FieldTypeLabelDescription
wallet Wallet

characters Character repeated

gears Gear repeated

items Item repeated

status Status

character_pieces CharacterPiece repeated

tension_cards TensionCard repeated

formations Formation repeated

notifications Notifications

challenges Challenge repeated

challenge_progresses ChallengeProgress repeated

challenge_tasks ChallengeTask repeated

warp_points WarpPoint repeated

areas Area repeated

area_groups AreaGroup repeated

cities City repeated

xb_statuses XbStatus repeated

shop_product_states ShopProductState repeated

nine_sequences NineSequence repeated

tips Tip repeated

character_costumes CharacterCostume repeated

login_bonuses LoginBonus repeated

missions Mission repeated

season_passes SeasonPass repeated

season_pass_tier_states SeasonPassTierState repeated

total_tasks TotalTask repeated

mission_count_reward_states MissionCountRewardState repeated

tutorial_status TutorialStatus

item_supplies ItemSupply repeated

dungeons Dungeon repeated

profile Profile

model/reward.proto

Top

Reward

FieldTypeLabelDescription
type int32

id int32

quantity int32

entity_id int32

resource_params ResourceParams

is_new bool

is_bonus bool

overflowed bool

sent_as_mail bool

old_value int32

other_rewards Resource repeated

model/rewards.proto

Top

Rewards

FieldTypeLabelDescription
type int32

contents Reward repeated

model/season_pass.proto

Top

SeasonPass

FieldTypeLabelDescription
season_id int32

exp int32

weekly_exp int32

weekly_exp_reset_at google.protobuf.Timestamp

model/season_pass_tier_state.proto

Top

SeasonPassTierState

FieldTypeLabelDescription
season_pass_tier_id int32

free_pass_reward_received_at google.protobuf.Timestamp

paid_pass_reward_received_at google.protobuf.Timestamp

model/shop_product_limited_discount.proto

Top

ShopProductLimitedDiscount

FieldTypeLabelDescription
id int32

costs Resource repeated

start_at google.protobuf.Timestamp

end_at google.protobuf.Timestamp

model/shop_product.proto

Top

PurchaseStep

FieldTypeLabelDescription
store_product_id google.protobuf.Int32Value

reward_set_id google.protobuf.Int32Value

costs Resource repeated

name google.protobuf.StringValue

description google.protobuf.StringValue

ShopProduct

FieldTypeLabelDescription
id int32

shop_id int32

limit_count int32

priority int32

start_at google.protobuf.Timestamp

end_at google.protobuf.Timestamp

purchase_steps PurchaseStep repeated

reset_cycle google.protobuf.Int32Value

reset_period int32

model/shop_product_state.proto

Top

ShopProductState

FieldTypeLabelDescription
shop_product_id int32

purchased_count int32

next_reset_at google.protobuf.Timestamp

end_at google.protobuf.Timestamp

model/shop.proto

Top

ManualReset

FieldTypeLabelDescription
reset_cycle int32

reset_period int32

gem_costs int32 repeated

Shop

FieldTypeLabelDescription
id int32

name string

shop_type int32

reset_cycle google.protobuf.Int32Value

reset_period int32

start_at google.protobuf.Timestamp

end_at google.protobuf.Timestamp

manual_reset ManualReset

model/status.proto

Top

Status

FieldTypeLabelDescription
exp int32

rank int32

gold int32

stamina_when_updated int32

stamina_updated_at google.protobuf.Timestamp

formation_number int32

current_area_id google.protobuf.Int32Value

current_position google.protobuf.StringValue

current_direction google.protobuf.Int32Value

stamina_purchased_count int32

birth_year google.protobuf.Int32Value

birth_month google.protobuf.Int32Value

logged_in_at google.protobuf.Timestamp

tracking_warp_point_id google.protobuf.Int32Value

tracking_field_boss_id google.protobuf.Int32Value

tracking_dungeon_id google.protobuf.Int32Value

enemy_forced_respawn_at google.protobuf.Timestamp

flower_mark int32

model/store_product.proto

Top

StoreProduct

FieldTypeLabelDescription
id int32

product_id google.protobuf.StringValue

money_amount int32

free_amount int32

price google.protobuf.DoubleValue

currency google.protobuf.StringValue

model/tension_card.proto

Top

TensionCard

FieldTypeLabelDescription
tension_card_id int32

exp int32

limit_break int32

received_at google.protobuf.Timestamp

max_level int32

ability_efficacies AbilityEfficacy repeated

training_score_level_score int32

model/tip.proto

Top

Tip

FieldTypeLabelDescription
tip_id int32

released_at google.protobuf.Timestamp

model/total_task.proto

Top

TotalTask

FieldTypeLabelDescription
condition_id int32

count int64

model/tutorial_status.proto

Top

TutorialStatus

FieldTypeLabelDescription
status TutorialStatusStatus repeated

TutorialStatusStatus

FieldTypeLabelDescription
key int32

value int32

model/wallet.proto

Top

Wallet

FieldTypeLabelDescription
free int32

paid int32

model/warp_point.proto

Top

WarpPoint

FieldTypeLabelDescription
warp_point_id int32

model/xb.proto

Top

XbAtBatEventInfo

FieldTypeLabelDescription
batting_info XbBattingInfo

batted_ball_info XbBattedBallInfo

error_info XbErrorInfo

defense_infos XbDefenseInfo repeated

before_game_situation XbGameSituationUpdateInfo

after_game_situation XbGameSituationUpdateInfo

player_invoked_skills XbSkillInfo repeated

enemy_invoked_skills XbSkillInfo repeated

player_tension_infos XbTensionInfo repeated

enemy_tension_infos XbTensionInfo repeated

player_invoked_member_support_infos XbInvokedMemberSupportInfo repeated

XbBattedBallInfo

FieldTypeLabelDescription
direction google.protobuf.Int32Value

is_infield bool

running_infos XbRunningInfo repeated

time float

after_game_situation XbGameSituationUpdateInfo

fielder_member_id google.protobuf.Int32Value

ball_level int32

is_covered bool

cover_penalty float

XbBattingInfo

FieldTypeLabelDescription
is_strike_out bool

XbBoutInfo

FieldTypeLabelDescription
bout_occurred bool

base_num_of_bout int32

base_num_of_runner int32

runner_member_id int32

fielder_member_id int32

is_touch_out bool

XbCommand

FieldTypeLabelDescription
command_id int32

xb_character_words_id int32

lock_status neon.enum.XbCommandLockStatus

XbCommandUnlockInfo

FieldTypeLabelDescription
item_id int32

command_id int32

XbDefenseInfo

FieldTypeLabelDescription
target_runner_member_id int32

defense_own_base_info XbDefenseOwnBaseInfo

throwing_info XbThrowingBallInfo

running_infos XbRunningInfo repeated

bout_info XbBoutInfo

before_game_situation XbGameSituationUpdateInfo

after_game_situation XbGameSituationUpdateInfo

event_order int32

XbDefenseOwnBaseInfo

FieldTypeLabelDescription
is_defense_own_base bool

fielder_member_id google.protobuf.Int32Value

base_num int32

XbErrorInfo

FieldTypeLabelDescription
is_error bool

direction google.protobuf.Int32Value

fielder_member_id google.protobuf.Int32Value

error_penalty float

running_infos XbRunningInfo repeated

after_game_situation XbGameSituationUpdateInfo

XbGameInfo

FieldTypeLabelDescription
xb_id int32

index int32

top_team XbTeam

bottom_team XbTeam

current_at_bat_event_info XbAtBatEventInfo

xb_story_info XbStoryInfo

XbGameSituationUpdateInfo

FieldTypeLabelDescription
inning int32

is_top bool

is_player_offense bool

batter_member_id int32

pitcher_member_id int32

returned_runner_member_ids int32 repeated

current_base_situation int32 repeated

top_team_score int32

bottom_team_score int32

current_out_count int32

is_change bool

is_game_set bool

is_first_at_bat_in_game bool

is_first_at_bat_in_half_inning bool

at_bat_result google.protobuf.Int32Value

event_order int32

XbInvokedMemberSupportInfo

FieldTypeLabelDescription
member_id int32

skill_log_timing int32

event_order int32

XbLibrettoInfo

FieldTypeLabelDescription
sequence_path string

XbMember

FieldTypeLabelDescription
member_id google.protobuf.Int32Value

base_character_id int32

xb_character_id google.protobuf.Int32Value

character_id google.protobuf.Int32Value

character_asset_id int32

level int32

position google.protobuf.Int32Value

batting_order google.protobuf.Int32Value

skill_ids int32 repeated

display_level string

max_hp google.protobuf.Int32Value

attack google.protobuf.Int32Value

defense google.protobuf.Int32Value

is_guest bool

is_disable bool

is_visible bool

XbMemberSupport

FieldTypeLabelDescription
member_id int32

level int32

id int32

XbPhaseInfo

FieldTypeLabelDescription
phase_id int32

is_phase_changed bool

phase_sequence_path string

theme_sequence_path string

XbPvPUserInfo

FieldTypeLabelDescription
name string

user_id int64

XbRunningInfo

FieldTypeLabelDescription
member_id int32

start_position float

end_position float

velocity float

time float

XbSkillInfo

FieldTypeLabelDescription
is_player bool

member_id int32

skill_id int32

event_order int32

XbStatus

FieldTypeLabelDescription
xb_id int32

received_count int32

last_received_at google.protobuf.Timestamp

enemy_order_power int32

next_reset_at google.protobuf.Timestamp

XbStoryInfo

FieldTypeLabelDescription
is_zone_active bool

phase_info XbPhaseInfo

libretto_info XbLibrettoInfo

command_unlock_infos XbCommandUnlockInfo repeated

XbSuggest

FieldTypeLabelDescription
index int32

member_id int32

suggestion_id int32

XbTeam

FieldTypeLabelDescription
name string

tribe_logo_aas_path string

pvp_user_info XbPvPUserInfo

members XbMember repeated

bat_first bool

is_player_team bool

inning_scores int32 repeated

current_batting_order int32

zone_areas XbZoneArea repeated

default_zone_area_index google.protobuf.Int32Value

selected_command XbCommand

tension_value float

tension_lv int32

is_tension_max bool

XbTensionInfo

FieldTypeLabelDescription
index int32

tension_timing int32

event_order int32

skit_index google.protobuf.Int32Value

tension_value float

tension_lv int32

runner_member_id google.protobuf.Int32Value

is_tension_max bool

previous_tension_value float

previous_tension_lv int32

previous_is_tension_max bool

XbThrowingBallInfo

FieldTypeLabelDescription
is_thrown bool

position_from int32

base_num_from int32

base_num_of_receive int32

fielder_member_id_from google.protobuf.Int32Value

fielder_member_id_to google.protobuf.Int32Value

time float

ball_level int32

XbZoneArea

FieldTypeLabelDescription
index int32

passion_words_level int32

batted_ball_prediction_id int32

member_supports XbMemberSupport repeated

suggests XbSuggest repeated

commands XbCommand repeated

api/adventure.proto

Top

AdventureAccessWarpPointRequest

FieldTypeLabelDescription
warp_point_id int32

current_location neon.model.CurrentLocation

Validated Fields

Field Validations
warp_point_id
  • int32.gte: 1

AdventureAccessWarpPointResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

area_objects neon.model.AreaObject repeated

AdventureAcquireAreaItemRequest

FieldTypeLabelDescription
area_item_spawn_id google.protobuf.Int32Value

area_object_behavior_id google.protobuf.Int32Value

current_location neon.model.CurrentLocation

Validated Fields

Field Validations
current_location
  • message.required: true

AdventureAcquireAreaItemResponse

FieldTypeLabelDescription
rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

area_objects neon.model.AreaObject repeated

adventure_variables neon.model.AdventureVariable repeated

AdventureAreaObjectRequest

FieldTypeLabelDescription
area_id int32

Validated Fields

Field Validations
area_id
  • int32.gte: 1

AdventureAreaObjectResponse

FieldTypeLabelDescription
area_objects neon.model.AreaObject repeated

blood_stains neon.model.BloodStain repeated

AdventureFastTravelRequest

FieldTypeLabelDescription
warp_point_id google.protobuf.Int32Value

dungeon_id google.protobuf.Int32Value

current_location neon.model.CurrentLocation

Validated Fields

Field Validations
current_location
  • message.required: true

AdventureHospitalRequest

FieldTypeLabelDescription
current_location neon.model.CurrentLocation

AdventureMoveToAreaRequest

FieldTypeLabelDescription
area_id int32

current_location neon.model.CurrentLocation

respawn_at_hospital bool

Validated Fields

Field Validations
area_id
  • int32.gte: 1

AdventureMoveToAreaResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

area_change_locks neon.model.AreaChangeLock repeated

area_behavior neon.model.AreaBehavior

area_bgm neon.model.AreaBgm

AdventureReadSequenceRequest

FieldTypeLabelDescription
sequence_request_ids int32 repeated

nine_sequences neon.model.NineSequenceRequest repeated

current_location neon.model.CurrentLocation

mini_game_id google.protobuf.Int32Value

Validated Fields

Field Validations
sequence_request_ids
  • repeated.items.int32.gte: 1

AdventureReadSequenceResponse

FieldTypeLabelDescription
area_objects neon.model.AreaObject repeated

rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

adventure_variables neon.model.AdventureVariable repeated

deleted_character_ids int32 repeated

Validated Fields

Field Validations
deleted_character_ids
  • repeated.items.int32.gte: 1

AdventureReleaseWarpPointRequest

FieldTypeLabelDescription
warp_point_id int32

current_location neon.model.CurrentLocation

Validated Fields

Field Validations
warp_point_id
  • int32.gte: 1

AdventureReleaseWarpPointResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

AdventureTrackTargetRequest

FieldTypeLabelDescription
warp_point_id google.protobuf.Int32Value

field_boss_id google.protobuf.Int32Value

dungeon_id google.protobuf.Int32Value

AdventureVariableRequest

FieldTypeLabelDescription
adventure_variable_ids int32 repeated

Validated Fields

Field Validations
adventure_variable_ids
  • repeated.unique: true

AdventureVariableResponse

FieldTypeLabelDescription
adventure_variables neon.model.AdventureVariable repeated

Adventure

Method NameRequest TypeResponse TypeDescription
AreaObject AdventureAreaObjectRequest AdventureAreaObjectResponse

ReadSequence AdventureReadSequenceRequest AdventureReadSequenceResponse

AccessWarpPoint AdventureAccessWarpPointRequest AdventureAccessWarpPointResponse

ReleaseWarpPoint AdventureReleaseWarpPointRequest AdventureReleaseWarpPointResponse

FastTravel AdventureFastTravelRequest ChangedResourcesResponse

AcquireAreaItem AdventureAcquireAreaItemRequest AdventureAcquireAreaItemResponse

MoveToArea AdventureMoveToAreaRequest AdventureMoveToAreaResponse

Variable AdventureVariableRequest AdventureVariableResponse

Hospital AdventureHospitalRequest ChangedResourcesResponse

TrackTarget AdventureTrackTargetRequest ChangedResourcesResponse

api/auth.proto

Top

AuthNonceResponse

FieldTypeLabelDescription
nonce string

AuthSignInRequest

FieldTypeLabelDescription
device_secret string

device_unique_id string

device_token string

device_model string

client_digest string

Validated Fields

Field Validations
device_unique_id
  • string.min_len: 16
  • string.max_len: 64
device_model
  • string.min_len: 1

AuthSignInResponse

FieldTypeLabelDescription
session_token string

device_changed bool

user_id int64

language int32

AuthSignUpAppleRequest

FieldTypeLabelDescription
device_secret string

device_unique_id string

device_model string

id_token string

execute bool

Validated Fields

Field Validations
device_unique_id
  • string.min_len: 16
  • string.max_len: 36
device_model
  • string.min_len: 1
id_token
  • string.min_len: 1

AuthSignUpAppleResponse

FieldTypeLabelDescription
user_id int64

user_name string

language int32

is_deleted bool

AuthSignUpGoogleRequest

FieldTypeLabelDescription
device_secret string

device_unique_id string

device_model string

id_token string

execute bool

Validated Fields

Field Validations
device_unique_id
  • string.min_len: 16
  • string.max_len: 36
device_model
  • string.min_len: 1
id_token
  • string.min_len: 1

AuthSignUpGoogleResponse

FieldTypeLabelDescription
user_id int64

user_name string

language int32

is_deleted bool

AuthSignUpPasscodeRequest

FieldTypeLabelDescription
device_secret string

device_unique_id string

device_model string

user_id int64

passcode string

execute bool

Validated Fields

Field Validations
device_unique_id
  • string.min_len: 16
  • string.max_len: 36
device_model
  • string.min_len: 1
passcode
  • string.min_len: 8
  • string.max_len: 16

AuthSignUpPasscodeResponse

FieldTypeLabelDescription
user_name string

language int32

is_deleted bool

AuthSignUpRequest

FieldTypeLabelDescription
device_secret string

device_unique_id string

device_model string

language google.protobuf.Int32Value

Validated Fields

Field Validations
device_unique_id
  • string.min_len: 16
  • string.max_len: 64
device_model
  • string.min_len: 1

AuthSignUpResponse

FieldTypeLabelDescription
user_id int64

Auth

Method NameRequest TypeResponse TypeDescription
SignIn AuthSignInRequest AuthSignInResponse

SignUp AuthSignUpRequest AuthSignUpResponse

SignUpApple AuthSignUpAppleRequest AuthSignUpAppleResponse

SignUpGoogle AuthSignUpGoogleRequest AuthSignUpGoogleResponse

SignUpPasscode AuthSignUpPasscodeRequest AuthSignUpPasscodeResponse

Nonce .google.protobuf.Empty AuthNonceResponse

api/battle.proto

Top

BattleFinishRequest

FieldTypeLabelDescription
battle_result neon.enum.BattleResult

character_updates neon.model.BattleCharacterUpdate repeated

battle_task_topics neon.model.BattleTaskTopic repeated

encountered_enemy_ids int32 repeated

battle_time_second int32

Validated Fields

Field Validations
character_updates
  • repeated.min_items: 1
  • repeated.max_items: 3
  • repeated.unique: true
encountered_enemy_ids
  • repeated.unique: true

BattleFinishResponse

FieldTypeLabelDescription
rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

reward_status neon.enum.RewardReceiveStatus

character_exps neon.model.CharacterExp repeated

adventure_variables neon.model.AdventureVariable repeated

area_objects neon.model.AreaObject repeated

move_to_area_locator_id google.protobuf.Int32Value

BattleRestartRequest

FieldTypeLabelDescription
line_character_ids int32 repeated

encountered_enemy_ids int32 repeated

Validated Fields

Field Validations
line_character_ids
  • repeated.max_items: 3
  • repeated.unique: true
  • repeated.items.int32.gte: 1
encountered_enemy_ids
  • repeated.unique: true

BattleRestartResponse

FieldTypeLabelDescription
formation neon.model.Formation

characters neon.model.Character repeated

tension_cards neon.model.TensionCard repeated

battle_parameters neon.model.BattleParameter repeated

battle_triggers neon.model.BattleTrigger repeated

advantage_type neon.enum.BattleAdvantageType

character_dishes neon.model.CharacterDish repeated

won_result_type neon.enum.BattleWonResultType

ability_enigma_id google.protobuf.Int32Value

BattleRewardRequest

FieldTypeLabelDescription
recovery_type neon.enum.StaminaRecoveryType

item_id google.protobuf.Int32Value

count int32

Validated Fields

Field Validations
count
  • int32.gte: 0

BattleRewardResponse

FieldTypeLabelDescription
rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

BattleSkipRequest

FieldTypeLabelDescription
battle_entry_id int32

battle_trigger neon.model.BattleTrigger

current_location neon.model.CurrentLocation

BattleSkipResponse

FieldTypeLabelDescription
rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

character_exps neon.model.CharacterExp repeated

adventure_variables neon.model.AdventureVariable repeated

area_objects neon.model.AreaObject repeated

BattleStartRequest

FieldTypeLabelDescription
battle_entry_ids int32 repeated

line_character_ids int32 repeated

battle_triggers neon.model.BattleTrigger repeated

advantage_type neon.enum.BattleAdvantageType

is_attack_hit bool

current_location neon.model.CurrentLocation

blood_stain_location neon.model.BloodStainLocation

Validated Fields

Field Validations
battle_entry_ids
  • repeated.min_items: 1
  • repeated.max_items: 30
  • repeated.items.int32.gte: 1
line_character_ids
  • repeated.max_items: 3
  • repeated.unique: true
  • repeated.items.int32.gte: 1

BattleStartResponse

FieldTypeLabelDescription
formation neon.model.Formation

characters neon.model.Character repeated

tension_cards neon.model.TensionCard repeated

battle_parameters neon.model.BattleParameter repeated

battle_triggers neon.model.BattleTrigger repeated

advantage_type neon.enum.BattleAdvantageType

changed_resources neon.model.Resources

character_dishes neon.model.CharacterDish repeated

won_result_type neon.enum.BattleWonResultType

ability_enigma_id google.protobuf.Int32Value

Battle

Method NameRequest TypeResponse TypeDescription
Start BattleStartRequest BattleStartResponse

Finish BattleFinishRequest BattleFinishResponse

Skip BattleSkipRequest BattleSkipResponse

Restart BattleRestartRequest BattleRestartResponse

Reward BattleRewardRequest BattleRewardResponse

api/changed_resources.proto

Top

ChangedResourcesResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

api/character.proto

Top

CharacterCostumeUpdateRequest

FieldTypeLabelDescription
character_costume_id int32

Validated Fields

Field Validations
character_costume_id
  • int32.gte: 1

CharacterEnhanceRequest

FieldTypeLabelDescription
character_id int32

consumed_items neon.model.ConsumedItem repeated

Validated Fields

Field Validations
character_id
  • int32.gte: 1
consumed_items
  • repeated.min_items: 1

CharacterEquipRequest

FieldTypeLabelDescription
character_id int32

gear_slot1 google.protobuf.Int32Value

gear_slot2 google.protobuf.Int32Value

gear_slot3 google.protobuf.Int32Value

Validated Fields

Field Validations
character_id
  • int32.gte: 1

CharacterItemPresentRequest

FieldTypeLabelDescription
character_id int32

item_id int32

quantity int32

Validated Fields

Field Validations
quantity
  • int32.gte: 1

CharacterLimitBreakRequest

FieldTypeLabelDescription
character_id int32

limit_break_count int32

Validated Fields

Field Validations
character_id
  • int32.gte: 1
limit_break_count
  • int32.gte: 1

CharacterLimitBreakResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Rewards repeated

CharacterRankEnhanceRequest

FieldTypeLabelDescription
character_id int32

Validated Fields

Field Validations
character_id
  • int32.gte: 1

CharacterRankEnhanceResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Rewards repeated

CharacterSkillPanelEnhanceRequest

FieldTypeLabelDescription
character_skill_panel_id int32

level int32

Validated Fields

Field Validations
character_skill_panel_id
  • int32.gte: 1
level
  • int32.gte: 0

CharacterSkillPanelEnhanceResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Rewards repeated

CharacterSkillPanelResetRequest

FieldTypeLabelDescription
character_id int32

Validated Fields

Field Validations
character_id
  • int32.gte: 1

CharacterSkillPanelResetResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Rewards repeated

Character

Method NameRequest TypeResponse TypeDescription
Enhance CharacterEnhanceRequest ChangedResourcesResponse

RankEnhance CharacterRankEnhanceRequest CharacterRankEnhanceResponse

LimitBreak CharacterLimitBreakRequest CharacterLimitBreakResponse

Equip CharacterEquipRequest ChangedResourcesResponse

SkillPanelEnhance CharacterSkillPanelEnhanceRequest CharacterSkillPanelEnhanceResponse

SkillPanelReset CharacterSkillPanelResetRequest CharacterSkillPanelResetResponse

CostumeUpdate CharacterCostumeUpdateRequest ChangedResourcesResponse

ItemPresent CharacterItemPresentRequest ChangedResourcesResponse

api/debug.proto

Top

DebugChallengeClearRequest

FieldTypeLabelDescription
challenge_id int32

DebugChallengeClearResponse

FieldTypeLabelDescription
rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

deleted_character_ids int32 repeated

Validated Fields

Field Validations
deleted_character_ids
  • repeated.items.int32.gte: 1

DebugJiraTokenResponse

FieldTypeLabelDescription
token string

DebugMailSendRequest

FieldTypeLabelDescription
count int32

Validated Fields

Field Validations
count
  • int32.gte: 1

DebugShopPurchaseRequest

FieldTypeLabelDescription
shop_product_id int32

DebugUserBulkResourceRequest

FieldTypeLabelDescription
types int32 repeated

stackable_resource_rate int32

entity_count int32

Validated Fields

Field Validations
types
  • repeated.min_items: 1
  • repeated.unique: true
stackable_resource_rate
  • int32.lte: 100
  • int32.gte: 0
entity_count
  • int32.gte: 0

DebugXbPvpSpecifyEnemyRequest

FieldTypeLabelDescription
enemy_user_id google.protobuf.Int64Value

Debug

Method NameRequest TypeResponse TypeDescription
ClientError .google.protobuf.Empty .google.protobuf.Empty

ServerError .google.protobuf.Empty .google.protobuf.Empty

UserError .google.protobuf.Empty .google.protobuf.Empty

JiraToken .google.protobuf.Empty DebugJiraTokenResponse

ChallengeClear DebugChallengeClearRequest DebugChallengeClearResponse

MailSend DebugMailSendRequest .google.protobuf.Empty

UserBulkResource DebugUserBulkResourceRequest .google.protobuf.Empty

ShopPurchase DebugShopPurchaseRequest ChangedResourcesResponse

XbPvpSpecifyEnemy DebugXbPvpSpecifyEnemyRequest .google.protobuf.Empty

api/dish.proto

Top

DishOrderRequest

FieldTypeLabelDescription
dish_id int32

current_location neon.model.CurrentLocation

Dish

Method NameRequest TypeResponse TypeDescription
Order DishOrderRequest ChangedResourcesResponse

api/dungeon.proto

Top

DungeonEntryRequest

FieldTypeLabelDescription
dungeon_id int32

current_location neon.model.CurrentLocation

Validated Fields

Field Validations
current_location
  • message.required: true

DungeonEntryResponse

FieldTypeLabelDescription
dungeon_difficulties neon.model.DungeonDifficulty repeated

changed_resources neon.model.Resources

DungeonRestartRequest

FieldTypeLabelDescription
dungeon_difficulty_id int32

DungeonRestartResponse

FieldTypeLabelDescription
dungeon_difficulty neon.model.DungeonDifficulty

dungeon_enemies neon.model.DungeonEnemy repeated

changed_resources neon.model.Resources

DungeonResumeRequest

FieldTypeLabelDescription
dungeon_difficulty_id int32

DungeonResumeResponse

FieldTypeLabelDescription
dungeon_difficulty neon.model.DungeonDifficulty

dungeon_enemies neon.model.DungeonEnemy repeated

changed_resources neon.model.Resources

DungeonStartRequest

FieldTypeLabelDescription
dungeon_difficulty_id int32

blood_stain_location neon.model.BloodStainLocation

Validated Fields

Field Validations
blood_stain_location
  • message.required: true

DungeonStartResponse

FieldTypeLabelDescription
dungeon_difficulty neon.model.DungeonDifficulty

dungeon_enemies neon.model.DungeonEnemy repeated

Dungeon

Method NameRequest TypeResponse TypeDescription
Entry DungeonEntryRequest DungeonEntryResponse

Start DungeonStartRequest DungeonStartResponse

Resume DungeonResumeRequest DungeonResumeResponse

Restart DungeonRestartRequest DungeonRestartResponse

api/field_boss.proto

Top

FieldBossEntryRequest

FieldTypeLabelDescription
field_boss_id int32

current_location neon.model.CurrentLocation

FieldBoss

Method NameRequest TypeResponse TypeDescription
Entry FieldBossEntryRequest ChangedResourcesResponse

api/formation.proto

Top

FormationSwitchRequest

FieldTypeLabelDescription
formation_number int32

Validated Fields

Field Validations
formation_number
  • int32.gte: 1

FormationUpdateRequest

FieldTypeLabelDescription
number int32

members neon.model.FormationMembers

cards neon.model.FormationCards

Validated Fields

Field Validations
number
  • int32.gte: 0

Formation

Method NameRequest TypeResponse TypeDescription
Update FormationUpdateRequest ChangedResourcesResponse

Switch FormationSwitchRequest ChangedResourcesResponse

api/gacha.proto

Top

GachaExecuteRequest

FieldTypeLabelDescription
gacha_id int32

gacha_button_id int32

client_timestamp google.protobuf.Timestamp

Validated Fields

Field Validations
client_timestamp
  • message.required: true

GachaExecuteResponse

FieldTypeLabelDescription
drawn_cards neon.model.GachaCard repeated

drawn_rewards neon.model.Reward repeated

changed_resources neon.model.Resources

gacha neon.model.Gacha

rewards neon.model.Rewards repeated

GachaListResponse

FieldTypeLabelDescription
gachas neon.model.Gacha repeated

gacha_rate_sets neon.model.GachaRateSet repeated

gacha_histories neon.model.GachaHistory repeated

changed_resources neon.model.Resources

Gacha

Method NameRequest TypeResponse TypeDescription
List .google.protobuf.Empty GachaListResponse

Execute GachaExecuteRequest GachaExecuteResponse

api/gear.proto

Top

GearCompressRequest

FieldTypeLabelDescription
gear_entity_ids int32 repeated

Validated Fields

Field Validations
gear_entity_ids
  • repeated.unique: true

GearCompressResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

deleted_resources neon.model.ResourceEntities

rewards neon.model.Rewards repeated

GearEnhanceRequest

FieldTypeLabelDescription
gear_entity_id int32

consumed_gear_entity_ids int32 repeated

consumed_items neon.model.ConsumedItem repeated

Validated Fields

Field Validations
consumed_gear_entity_ids
  • repeated.unique: true

GearEnhanceResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

deleted_resources neon.model.ResourceEntities

GearLockRequest

FieldTypeLabelDescription
gear_entity_ids int32 repeated

Validated Fields

Field Validations
gear_entity_ids
  • repeated.unique: true

GearUnlockRequest

FieldTypeLabelDescription
gear_entity_ids int32 repeated

Validated Fields

Field Validations
gear_entity_ids
  • repeated.unique: true

Gear

Method NameRequest TypeResponse TypeDescription
Enhance GearEnhanceRequest GearEnhanceResponse

Lock GearLockRequest ChangedResourcesResponse

Unlock GearUnlockRequest ChangedResourcesResponse

Compress GearCompressRequest GearCompressResponse

api/happy_worker.proto

Top

HappyWorkerCancelRequest

FieldTypeLabelDescription
happy_worker_item_id int32

HappyWorkerCancelResponse

FieldTypeLabelDescription
happy_worker_item neon.model.HappyWorkerItem

changed_resources neon.model.Resources

HappyWorkerListRequest

FieldTypeLabelDescription
current_location neon.model.CurrentLocation

HappyWorkerListResponse

FieldTypeLabelDescription
happy_worker_items neon.model.HappyWorkerItem repeated

changed_resources neon.model.Resources

HappyWorkerStartRequest

FieldTypeLabelDescription
happy_worker_item_id int32

HappyWorkerStartResponse

FieldTypeLabelDescription
happy_worker_item neon.model.HappyWorkerItem

changed_resources neon.model.Resources

HappyWorker

Method NameRequest TypeResponse TypeDescription
List HappyWorkerListRequest HappyWorkerListResponse

Start HappyWorkerStartRequest HappyWorkerStartResponse

Cancel HappyWorkerCancelRequest HappyWorkerCancelResponse

api/item.proto

Top

ItemExchangeRequest

FieldTypeLabelDescription
item_exchange_id int32

count int32

consumed_item_ids int32 repeated

current_location neon.model.CurrentLocation

Validated Fields

Field Validations
count
  • int32.gte: 1
consumed_item_ids
  • repeated.min_items: 1

ItemSellRequest

FieldTypeLabelDescription
items neon.model.ConsumedItem repeated

Validated Fields

Field Validations
items
  • repeated.min_items: 1

ItemSellSupplyRequest

FieldTypeLabelDescription
item_supply_entity_ids int32 repeated

Validated Fields

Field Validations
item_supply_entity_ids
  • repeated.unique: true

ItemSellSupplyResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

deleted_resources neon.model.ResourceEntities

ItemSynthesizeRequest

FieldTypeLabelDescription
item_synthesis_id int32

count int32

current_location neon.model.CurrentLocation

Validated Fields

Field Validations
count
  • int32.gte: 1

ItemUseRequest

FieldTypeLabelDescription
item_id int32

count int32

character_id int32

Validated Fields

Field Validations
count
  • int32.gte: 1

ItemUseSupplyRequest

FieldTypeLabelDescription
item_supply_entity_ids int32 repeated

character_id int32

Validated Fields

Field Validations
item_supply_entity_ids
  • repeated.unique: true

ItemUseSupplyResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

deleted_resources neon.model.ResourceEntities

Item

Method NameRequest TypeResponse TypeDescription
Synthesize ItemSynthesizeRequest ChangedResourcesResponse

Exchange ItemExchangeRequest ChangedResourcesResponse

Use ItemUseRequest ChangedResourcesResponse

UseSupply ItemUseSupplyRequest ItemUseSupplyResponse

Sell ItemSellRequest ChangedResourcesResponse

SellSupply ItemSellSupplyRequest ItemSellSupplyResponse

api/login_bonus.proto

Top

LoginBonusReceiveRequest

FieldTypeLabelDescription
login_bonus_id int32

LoginBonusReceiveResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

LoginBonus

Method NameRequest TypeResponse TypeDescription
List .google.protobuf.Empty ChangedResourcesResponse

Receive LoginBonusReceiveRequest LoginBonusReceiveResponse

api/mail.proto

Top

MailDeleteRequest

FieldTypeLabelDescription
entity_ids int32 repeated

Validated Fields

Field Validations
entity_ids
  • repeated.min_items: 1
  • repeated.max_items: 200
  • repeated.unique: true

MailDeleteResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

list neon.model.MailList

MailListResponse

FieldTypeLabelDescription
list neon.model.MailList

changed_resources neon.model.Resources

MailOpenRequest

FieldTypeLabelDescription
entity_ids int32 repeated

Validated Fields

Field Validations
entity_ids
  • repeated.min_items: 1
  • repeated.max_items: 200
  • repeated.unique: true

MailOpenResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Reward repeated

overflowed_rewards neon.model.Resource repeated

list neon.model.MailList

Mail

Method NameRequest TypeResponse TypeDescription
List .google.protobuf.Empty MailListResponse

Open MailOpenRequest MailOpenResponse

Delete MailDeleteRequest MailDeleteResponse

api/mission.proto

Top

MissionCountRewardReceiveRequest

FieldTypeLabelDescription
mission_count_reward_id int32

Validated Fields

Field Validations
mission_count_reward_id
  • int32.gte: 1

MissionCountRewardReceiveResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Reward repeated

MissionReceiveRequest

FieldTypeLabelDescription
mission_ids int32 repeated

Validated Fields

Field Validations
mission_ids
  • repeated.min_items: 1
  • repeated.max_items: 200
  • repeated.unique: true

MissionReceiveResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Reward repeated

Mission

Method NameRequest TypeResponse TypeDescription
Receive MissionReceiveRequest MissionReceiveResponse

CountRewardReceive MissionCountRewardReceiveRequest MissionCountRewardReceiveResponse

api/news.proto

Top

NewsListRequest

FieldTypeLabelDescription
language google.protobuf.Int32Value

NewsListResponse

FieldTypeLabelDescription
news neon.model.NewsItem repeated

News

Method NameRequest TypeResponse TypeDescription
List NewsListRequest NewsListResponse

api/profile.proto

Top

ProfileUpdateNameRequest

FieldTypeLabelDescription
name string

Validated Fields

Field Validations
name
  • string.min_len: 1

Profile

Method NameRequest TypeResponse TypeDescription
UpdateName ProfileUpdateNameRequest ChangedResourcesResponse

api/season_pass.proto

Top

SeasonPassReceiveAllRequest

FieldTypeLabelDescription
season_id int32

Validated Fields

Field Validations
season_id
  • int32.gte: 1

SeasonPassReceiveAllResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Reward repeated

SeasonPassReceiveRequest

FieldTypeLabelDescription
season_id int32

season_pass_tier_id int32

season_pass_type int32

Validated Fields

Field Validations
season_id
  • int32.gte: 1
season_pass_tier_id
  • int32.gte: 1

SeasonPassReceiveResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

rewards neon.model.Reward repeated

SeasonPassTierPurchaseRequest

FieldTypeLabelDescription
season_id int32

purchase_count int32

Validated Fields

Field Validations
season_id
  • int32.gte: 1
purchase_count
  • int32.gte: 1

SeasonPass

Method NameRequest TypeResponse TypeDescription
TierPurchase SeasonPassTierPurchaseRequest ChangedResourcesResponse

Receive SeasonPassReceiveRequest SeasonPassReceiveResponse

ReceiveAll SeasonPassReceiveAllRequest SeasonPassReceiveAllResponse

api/shop.proto

Top

ShopGemListResponse

FieldTypeLabelDescription
shop_products neon.model.ShopProduct repeated

store_products neon.model.StoreProduct repeated

ShopPurchaseRequest

FieldTypeLabelDescription
shop_product_id int32

quantity int32

shop_product_limited_discount_id google.protobuf.Int32Value

Validated Fields

Field Validations
quantity
  • int32.gte: 1

Shop

Method NameRequest TypeResponse TypeDescription
GemList .google.protobuf.Empty ShopGemListResponse

Purchase ShopPurchaseRequest ChangedResourcesResponse

api/stamina.proto

Top

StaminaPurchaseRequest

FieldTypeLabelDescription
count int32

Validated Fields

Field Validations
count
  • int32.gte: 1

StaminaUseItemRequest

FieldTypeLabelDescription
item_id int32

count int32

Validated Fields

Field Validations
count
  • int32.gte: 1

Stamina

Method NameRequest TypeResponse TypeDescription
Purchase StaminaPurchaseRequest ChangedResourcesResponse

UseItem StaminaUseItemRequest ChangedResourcesResponse

api/tension_card.proto

Top

TensionCardEnhanceRequest

FieldTypeLabelDescription
tension_card_id int32

consumed_items neon.model.ConsumedItem repeated

Validated Fields

Field Validations
tension_card_id
  • int32.gte: 1
consumed_items
  • repeated.min_items: 1

TensionCardLevelLimitEnhanceRequest

FieldTypeLabelDescription
tension_card_id int32

Validated Fields

Field Validations
tension_card_id
  • int32.gte: 1

TensionCard

Method NameRequest TypeResponse TypeDescription
Enhance TensionCardEnhanceRequest ChangedResourcesResponse

LevelLimitEnhance TensionCardLevelLimitEnhanceRequest ChangedResourcesResponse

api/tip.proto

Top

TipReleaseByBattleRequest

FieldTypeLabelDescription
battle_result neon.enum.BattleResult

TipReleaseRequest

FieldTypeLabelDescription
tip_ids int32 repeated

TipReleaseResponse

FieldTypeLabelDescription
changed_resources neon.model.Resources

area_objects neon.model.AreaObject repeated

Tip

Method NameRequest TypeResponse TypeDescription
Release TipReleaseRequest TipReleaseResponse

ReleaseByBattle TipReleaseByBattleRequest ChangedResourcesResponse

api/user.proto

Top

UserCrossDateResponse

FieldTypeLabelDescription
rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

UserLinkAppleRequest

FieldTypeLabelDescription
id_token string

Validated Fields

Field Validations
id_token
  • string.min_len: 1

UserLinkGoogleRequest

FieldTypeLabelDescription
id_token string

Validated Fields

Field Validations
id_token
  • string.min_len: 1

UserLinksListResponse

FieldTypeLabelDescription
apple bool

google bool

UserLogInResponse

FieldTypeLabelDescription
resources neon.model.Resources

master_data neon.model.MasterData

move_to_area_locator_id google.protobuf.Int32Value

UserUpdateBirthdateRequest

FieldTypeLabelDescription
year int32

month int32

Validated Fields

Field Validations
month
  • int32.lte: 12
  • int32.gte: 1

UserUpdateLanguageRequest

FieldTypeLabelDescription
language int32

User

Method NameRequest TypeResponse TypeDescription
LogIn .google.protobuf.Empty UserLogInResponse

CrossDate .google.protobuf.Empty UserCrossDateResponse

LinksList .google.protobuf.Empty UserLinksListResponse

LinkApple UserLinkAppleRequest .google.protobuf.Empty

UnlinkApple .google.protobuf.Empty .google.protobuf.Empty

LinkGoogle UserLinkGoogleRequest .google.protobuf.Empty

UnlinkGoogle .google.protobuf.Empty .google.protobuf.Empty

UnlinkSteam .google.protobuf.Empty .google.protobuf.Empty

UpdateBirthdate UserUpdateBirthdateRequest ChangedResourcesResponse

UpdateLanguage UserUpdateLanguageRequest .google.protobuf.Empty

Delete .google.protobuf.Empty .google.protobuf.Empty

api/web_session.proto

Top

WebSessionTokenResponse

FieldTypeLabelDescription
token string

WebSession

Method NameRequest TypeResponse TypeDescription
Token .google.protobuf.Empty WebSessionTokenResponse

api/xb_pvp.proto

Top

XbPvpQuickMatchingRequest

FieldTypeLabelDescription
xb_id int32

XbPvpQuickMatchingResponse

FieldTypeLabelDescription
enemy_user_id google.protobuf.Int64Value

XbPvp

Method NameRequest TypeResponse TypeDescription
QuickMatching XbPvpQuickMatchingRequest XbPvpQuickMatchingResponse

api/xb.proto

Top

XbFormationRequest

FieldTypeLabelDescription
xb_id int32

enemy_user_id google.protobuf.Int64Value

XbFormationResponse

FieldTypeLabelDescription
player_members neon.model.XbMember repeated

enemy_members neon.model.XbMember repeated

player_recommended_members neon.model.XbMember repeated

all_player_members neon.model.XbMember repeated

player_tribe_logo_aas_path google.protobuf.StringValue

enemy_tribe_logo_aas_path google.protobuf.StringValue

player_team_name google.protobuf.StringValue

enemy_team_name google.protobuf.StringValue

is_team_edit_enabled bool

player_pvp_user_infos neon.model.XbPvPUserInfo

enemy_pvp_user_infos neon.model.XbPvPUserInfo

XbFormationUpdateRequest

FieldTypeLabelDescription
xb_id int32

player_members XbMemberRequest repeated

Validated Fields

Field Validations
player_members
  • repeated.min_items: 9
  • repeated.max_items: 9

XbFormationUpdateResponse

FieldTypeLabelDescription
player_members neon.model.XbMember repeated

XbMemberRequest

FieldTypeLabelDescription
character_id google.protobuf.Int32Value

xb_character_id google.protobuf.Int32Value

batting_order int32

position int32

Validated Fields

Field Validations
batting_order
  • int32.lte: 9
  • int32.gte: 1

XbPlayRequest

FieldTypeLabelDescription
xb_id int32

zone_area_index int32

command_id int32

Validated Fields

Field Validations
zone_area_index
  • int32.lte: 8
  • int32.gte: 0

XbPlayResponse

FieldTypeLabelDescription
current_at_bat_game_info neon.model.XbGameInfo

next_at_bat_game_info neon.model.XbGameInfo

reward_status neon.enum.RewardReceiveStatus

rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

XbRestoreCheckPointRequest

FieldTypeLabelDescription
xb_id int32

XbRestoreCheckPointResponse

FieldTypeLabelDescription
next_at_bat_game_info neon.model.XbGameInfo

XbRewardRequest

FieldTypeLabelDescription
xb_id int32

recovery_type neon.enum.StaminaRecoveryType

item_id google.protobuf.Int32Value

count int32

Validated Fields

Field Validations
count
  • int32.gte: 0

XbRewardResponse

FieldTypeLabelDescription
rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

XbStartRequest

FieldTypeLabelDescription
xb_id int32

player_members XbMemberRequest repeated

enemy_user_id google.protobuf.Int64Value

Validated Fields

Field Validations
player_members
  • repeated.min_items: 9
  • repeated.max_items: 9

XbStartResponse

FieldTypeLabelDescription
next_at_bat_game_info neon.model.XbGameInfo

XbUpdateTensionRequest

FieldTypeLabelDescription
xb_id int32

tension_fluctuation_ids int32 repeated

Validated Fields

Field Validations
tension_fluctuation_ids
  • repeated.unique: true
  • repeated.items.int32.gte: 1

XbUpdateTensionResponse

FieldTypeLabelDescription
player_tension_infos neon.model.XbTensionInfo repeated

enemy_tension_infos neon.model.XbTensionInfo repeated

current_at_bat_game_info neon.model.XbGameInfo

Xb

Method NameRequest TypeResponse TypeDescription
Formation XbFormationRequest XbFormationResponse

FormationUpdate XbFormationUpdateRequest XbFormationUpdateResponse

Start XbStartRequest XbStartResponse

Play XbPlayRequest XbPlayResponse

RestoreCheckPoint XbRestoreCheckPointRequest XbRestoreCheckPointResponse

Reward XbRewardRequest XbRewardResponse

UpdateTension XbUpdateTensionRequest XbUpdateTensionResponse

api/purchase.proto

Top

PurchaseSessionPublishRequest

FieldTypeLabelDescription
purchase_session_id string

event_type string

transaction_id google.protobuf.StringValue

product_id google.protobuf.StringValue

client_currency google.protobuf.StringValue

client_price google.protobuf.DoubleValue

purchase_data google.protobuf.StringValue

data_signature google.protobuf.StringValue

receipt google.protobuf.StringValue

failure_reason google.protobuf.StringValue

Validated Fields

Field Validations
purchase_session_id
  • string.min_len: 1

PurchaseSessionStartRequest

FieldTypeLabelDescription
shop_product_id int32

PurchaseSessionStartResponse

FieldTypeLabelDescription
purchase_session_id string

transaction_id google.protobuf.StringValue

PurchaseVerifyRequest

FieldTypeLabelDescription
purchase_session_id string

transaction_id string

client_currency google.protobuf.StringValue

client_price google.protobuf.DoubleValue

purchase_data google.protobuf.StringValue

data_signature google.protobuf.StringValue

Validated Fields

Field Validations
purchase_session_id
  • string.min_len: 1
transaction_id
  • string.min_len: 1

Purchase

Method NameRequest TypeResponse TypeDescription
SessionStart PurchaseSessionStartRequest PurchaseSessionStartResponse

SessionPublish PurchaseSessionPublishRequest .google.protobuf.Empty

Verify PurchaseVerifyRequest ChangedResourcesResponse

api/tutorial.proto

Top

TutorialSkipResponse

FieldTypeLabelDescription
move_to_area_locator_id google.protobuf.Int32Value

deleted_character_ids int32 repeated

rewards neon.model.Rewards repeated

changed_resources neon.model.Resources

Validated Fields

Field Validations
deleted_character_ids
  • repeated.items.int32.gte: 1

Tutorial

Method NameRequest TypeResponse TypeDescription
Skip .google.protobuf.Empty TutorialSkipResponse

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)