Skip to content
Mirror
Clone

Clone over HTTPS

No sign-in. Pulls work; pushes go upstream to the monorepo.

Download .tar.gz

Protocol buffer schemas shared by KBVE services, games and sites.

Last changed in19476db91on

101 lines2.9 KB
APIRaw
syntax = "proto3";

package kbve.rows.v1;

import "google/protobuf/timestamp.proto";
import "kbve/rows/v1/rows.proto";
import "kbve/type/v1/id.proto";

// World servers, the maps they host, and the instances of those maps.

// Where a map instance is in its life.
//
// MapInstance.status was a bare int32 while WorldServer.server_status was
// already an enum and ServerHeartbeat.server_status was a string -- three
// spellings of one idea. This is the instance's own, because an instance can
// be draining while its host is online.
enum MapInstanceStatus {
  MAP_INSTANCE_STATUS_UNSPECIFIED = 0;
  MAP_INSTANCE_STATUS_STARTING = 1;
  MAP_INSTANCE_STATUS_RUNNING = 2;
  MAP_INSTANCE_STATUS_DRAINING = 3;
  MAP_INSTANCE_STATUS_STOPPED = 4;
  MAP_INSTANCE_STATUS_FAILED = 5;
}

// A machine that hosts map instances.
message WorldServer {
  kbve.type.v1.Uuid customer_id = 1;
  int32 world_server_id = 2;
  optional string server_ip = 3;
  int32 max_number_of_instances = 4;
  optional google.protobuf.Timestamp active_start_at = 5;
  int32 port = 6;
  ServerStatus server_status = 7;
  optional string internal_server_ip = 8;
  int32 starting_map_instance_port = 9;
  optional kbve.type.v1.Uuid zone_server_id = 10;
}

// A map definition.
message Map {
  kbve.type.v1.Uuid customer_id = 1;
  int32 map_id = 2;
  string map_name = 3;
  optional string zone_name = 4;
  optional int32 width = 5;
  optional int32 height = 6;
  MapMode map_mode = 7;
  int32 soft_player_cap = 8;
  int32 hard_player_cap = 9;
  int32 minutes_to_shutdown_after_empty = 10;
  optional string world_comp_contains_filter = 11;
  optional string world_comp_list_filter = 12;
}

// A running copy of a map.
message MapInstance {
  kbve.type.v1.Uuid customer_id = 1;
  int32 map_instance_id = 2;
  int32 world_server_id = 3;
  int32 map_id = 4;
  int32 port = 5;
  // 6 was `status`, an int32 with no enum behind it.
  reserved 6;
  MapInstanceStatus status = 11;
  int32 number_of_reported_players = 7;
  optional google.protobuf.Timestamp last_update_from_server_at = 8;
  optional google.protobuf.Timestamp last_server_empty_at = 9;
  optional kbve.type.v1.Uuid map_instance_guid = 10;
}

// Tenant-wide world clock settings.
message WorldSettings {
  kbve.type.v1.Uuid customer_id = 1;
  int32 world_settings_id = 2;
  optional google.protobuf.Timestamp start_at = 3;
  optional double time_multiplier = 4;
}

message AreaOfInterestType {
  int32 area_of_interest_type_id = 1;
  string description = 2;
}

// A trigger volume on a map.
message AreaOfInterest {
  kbve.type.v1.Uuid customer_id = 1;
  kbve.type.v1.Uuid id = 2;
  int32 map_zone_id = 3;
  string name = 4;
  double radius = 5;
  // 6 was `area_of_interest_type`, which reads as the type itself and is the
  // foreign key to AreaOfInterestType.
  reserved 6;
  reserved "area_of_interest_type";
  int32 area_of_interest_type_id = 14;
  // 7 through 12 were x, y, z, rx, ry, rz.
  reserved 7, 8, 9, 10, 11, 12;
  Pose pose = 15;
  optional string custom_data = 13;
}