package SoapstoneLib.Proto.Internal

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetServerInfo (ServerInfoRequest, ServerInfoResponse)

  soapstone.proto:12

  Returns basic info about the editor's current state. All servers must implement this. Editor resources are parts of an editor which can be individually loaded or unloaded. Once a resource is loaded, various objects and functionality can be straightforwardly accessed within it.

• rpc SearchObjects (SearchObjectsRequest, SearchObjectsResponse)

  soapstone.proto:16

  Get objects matching a search query, with requested properties. A property does not have to be requested to search against it.

  message SearchObjectsRequest

  internal.proto:11

  • optional EditorResource resource = 1

  • optional PrimaryKeyType result_type = 2

  • optional PropertySearch search = 3

  • repeated RequestedProperty properties = 4

  • optional SearchOptions options = 5

  message SearchObjectsResponse

  internal.proto:19

  • repeated GameObject results = 1

• rpc GetObject (GetObjectRequest, GetObjectResponse)

  soapstone.proto:21

  Returns a single object, within an editor resource type. This can be used if the exact key is known, or to get more properties after a broader search. It returns empty if object is not found (as opposed to an error).

  message GetObjectRequest

  internal.proto:23

  • optional EditorResource resource = 1

  • optional PrimaryKey key = 2

  • repeated RequestedProperty properties = 3

  message GetObjectResponse

  internal.proto:29

  • optional GameObject result = 1

• rpc BatchGetObjects (BatchGetObjectsRequest, BatchGetObjectsResponse)

  soapstone.proto:25

  Returns objects in batch, within an editor resource type. It returns only the objects which could be found.

  message BatchGetObjectsRequest

  internal.proto:33

  • optional EditorResource resource = 1

  • repeated PrimaryKey keys = 2

  • repeated RequestedProperty properties = 3

  message BatchGetObjectsResponse

  internal.proto:39

  • repeated GameObject results = 1

• rpc OpenResource (OpenResourceRequest, OpenResourceResponse)

  soapstone.proto:28

  Open a resource, like a map by name.

  message OpenResourceRequest

  internal.proto:43

  • optional EditorResource resource = 1

  message OpenResourceResponse

  internal.proto:47

  (message has no fields)

• rpc OpenObject (OpenObjectRequest, OpenObjectResponse)

  soapstone.proto:31

  Jump to or frame the given object within the editor.

  message OpenObjectRequest

  internal.proto:50

  • optional EditorResource resource = 1

  • optional PrimaryKey key = 2

  message OpenObjectResponse

  internal.proto:55

  (message has no fields)

• rpc OpenSearch (OpenSearchRequest, OpenSearchResponse)

  soapstone.proto:34

  Start a given search in the editor.

  message OpenSearchRequest

  internal.proto:58

  • optional EditorResource resource = 1

  • optional PrimaryKeyType result_type = 2

  • optional PropertySearch search = 3

  • bool open_first_result = 4

    Likewise, editors can do this if supported

  message OpenSearchResponse

  internal.proto:66

  (message has no fields)

Used in: BatchGetObjectsResponse, GetObjectResponse, SearchObjectsResponse

• optional PrimaryKey key = 1

  Identifier for the object, to use for subsequent UI operations

• repeated GameProperty properties = 2

  All requested properties. The same property name can repeat multiple times, like EntityGroupIDs. Alternatively, PropertyValue could support arrays.

Used in: GameObject

• string key = 1

  For the moment, use a string key here. This could become more richly typed in the future.

• optional PropertyValue value = 2

Used in: PropertySearch

• repeated PropertyCondition conditions = 3

Some relatively unique identifier for a game object: the file it's in and an id within it. Clients should not examine this directly. Prefer to use properties. Note that EntityID is *not* a valid primary key. It would be a property of an entity. Clients should avoid constructing this key object directly. Instead, use high-level methods in a C# library to ensure that different editors use the same representation for game objects. Failing that, try to use keys returned by servers, rather than constructing them in clients. It is possible for key representations to change over time (and maybe even proto fields), but try to maintain backwards compatibility if it's not too arduous. This system is meant for data in straightforward key-value pairs, not complex recursive data.

Used in: BatchGetObjectsRequest, GameObject, GetObjectRequest, OpenObjectRequest

• string file = 1

  The lowercase name of the file that this game object appears in, after the interrot prefix (or other redundant prefixes if no interroot), and without the dcx extension. Overall, it should be reasonably stable across games. This might be "map/mapstudio/m10_00_00_00.msb" for a map, which is a top-level file. For a resource within a BND, this would be the path name, like "script/talk/m10_00_00_00/t204101000.esd" or "chr/c0000/tae/a00.tae" or "param/GameParam/ThrowParam.param". Note that protobuf interns strings while deserializing, so this is fairly cheap, but if necessary we can do some kind of reference table or RLE-type compression.

• KeyNamespace namespace = 2

  Optionally, a namespace within a file for scoping ids. For instance, in MSB, names are disambiguated only within regions/parts. FMGs don't need this - all ids are entry ids. Feel free to create dozens of these as appropriate for disambiguation purposes, but don't rely on this for precise type information (e.g. distinguishing enemies and objects) - use properties for that.

• int32 index = 3

  If there are multiple instances of something with the same id, like a param row for instance, this identifies which one it is, starting from 0, then 1, etc. This number should be stable but is not otherwise meaningful.

• oneof id

  The main stable identifier for the object, scoped within the file and namespace. Generally, this should represent how the object is referenced within the format. If the object has a numerical identifier, use that. If it has a name field, use that. Try to avoid indices if there is a more stable alternative. If there is a multipart numerical id, separate parts using underscores. If this field is missing, this primary key can be used to mean the entire file.

  • string str_id = 4

    String name, or specially formatted name

  • int64 int_id = 5

    Integer id (any width)

Used in: PrimaryKeyType

• PRIMARY_KEY_CATEGORY_UNSPECIFIED = 0

• PRIMARY_KEY_CATEGORY_FILE = 1

  A game file with a unique path. This includes both bnd files and files within bnds.

• PRIMARY_KEY_CATEGORY_ENTRY = 2

  A key-value entry in a game file.

An internal representation of a type of a PrimaryKey object. This is mainly for filtering search results.

Used in: OpenSearchRequest, SearchObjectsRequest

• string file = 1

  A template version of the PrimaryKey file key, using {0} {1} by convention. For instance, using the examples given in PrimaryKey, the types would be "script/talk/{0}/{1}.esd" or "chr/{0}/tae/{1}.tae" or "param/GameParam/{0}.param".

• PrimaryKeyCategory category = 2

  The PrimaryKey namespace. Must not be unspecified.

Some basic search condition like EntityID == 5555

Used in: MultiPropertyCondition

• PropertyComparisonType type = 1

• string key = 2

• optional PropertyValue value = 3

Representation of a search. For anything more complex, an expression language can be added later.

Used in: OpenSearchRequest, SearchObjectsRequest

• repeated MultiPropertyCondition all_of_any_conditions = 1

  Conjunctive normal form (AND of ORs)

This is a wrapper for scalar values supported by SearchProperties. The oneof includes a case enum by default, plus the value itself. shorts/bytes are represented using varint 32-bit values, as they have no special proto type.

Used in: GameProperty, PropertyCondition

• oneof value

  • sint32 s8_value = 1

    This is quite a few values, but tag numbers are kept in one byte (<2^4, protobuf-net tag number performance) and it's stored with low overhead (private object value_).

  • uint32 u8_value = 2

  • sint32 s16_value = 3

  • uint32 u16_value = 4

  • sint32 s32_value = 5

  • uint32 u32_value = 6

  • sint64 s64_value = 7

  • uint64 u64_value = 8

  • float f32_value = 9

  • double f64_value = 10

  • bool bool_value = 11

  • string string_value = 12