package SoapstoneLib.Proto.Internal

Get desktop application:
View/edit binary Protocol Buffers messages

• 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 DescribeParam (DescribeParamRequest, DescribeParamResponse)

  soapstone.proto:48

  Get detailed information about a specific param: its type, row count, and field definitions.

  message DescribeParamRequest

  internal.proto:240

  • string param_name = 1

    The param name, e.g. "EquipParamWeapon"

  message DescribeParamResponse

  internal.proto:245

  • string param_name = 1

    The param name

  • string param_type = 2

    The param type string, e.g. "EQUIP_PARAM_WEAPON_ST"

  • int32 row_count = 3

    Number of rows in this param

  • repeated ParamFieldInfo fields = 4

    All columns/fields in this param

• rpc ExecuteMassEdit (ExecuteMassEditRequest, ExecuteMassEditResponse)

  soapstone.proto:38

  Execute a mass edit script on the server's param data. The script uses the same syntax as the Param Editor's Mass Edit system.

  message ExecuteMassEditRequest

  internal.proto:194

  • string script = 1

    The mass edit script text, semicolon-delimited commands.

  message ExecuteMassEditResponse

  internal.proto:199

  • string result = 1

    Human-readable result information

  • int32 changes = 2

    Number of changes made

  • bool success = 3

    Whether the operation succeeded

• 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 GetParamRow (GetParamRowRequest, GetParamRowResponse)

  soapstone.proto:51

  Get all field values for a specific row, by row index (position).

  message GetParamRowRequest

  internal.proto:277

  • string param_name = 1

    The param name, e.g. "EquipParamWeapon"

  • int32 row_index = 2

    The row index within the param (0-based position, handles duplicate IDs)

  • bool vanilla = 3

    If true, read from vanilla (original game) bank instead of modified

• rpc GetParamRows (GetParamRowsRequest, GetParamRowsResponse)

  soapstone.proto:54

  Get all rows that share a given row ID (handles duplicate IDs).

  message GetParamRowsRequest

  internal.proto:312

  • string param_name = 1

  • int32 row_id = 2

  • bool vanilla = 3

  message GetParamRowsResponse

  internal.proto:318

  • string param_name = 1

  • int32 row_id = 2

  • int32 count = 3

  • repeated GetParamRowResponse rows = 4

• 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 ListParamRows (ListParamRowsRequest, ListParamRowsResponse)

  soapstone.proto:57

  List all rows in a param (ID, Name, and index summary).

  message ListParamRowsRequest

  internal.proto:329

  • string param_name = 1

  • bool vanilla = 2

  message ListParamRowsResponse

  internal.proto:334

  • string param_name = 1

  • repeated ParamRowSummary rows = 2

• rpc ListParams (ListParamsRequest, ListParamsResponse)

  soapstone.proto:45

  List all available param names in the currently loaded project.

  message ListParamsRequest

  internal.proto:228

  (message has no fields)

  message ListParamsResponse

  internal.proto:231

  • repeated string param_names = 1

    All param names in the currently loaded project

• 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 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 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)

• rpc ReloadParams (ReloadParamsRequest, ReloadParamsResponse)

  soapstone.proto:42

  Hot-reload param changes to the running game process. If param_names is empty, all reloadable params are reloaded.

  message ReloadParamsRequest

  internal.proto:212

  • repeated string param_names = 1

    Param names to reload. If empty, all reloadable params are reloaded.

  message ReloadParamsResponse

  internal.proto:217

  • repeated string reloaded_params = 1

    Params that were successfully reloaded to game memory

  • repeated string failed_params = 2

    Params that failed to reload (not supported, not found in memory, etc.)

• 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 SetParamCell (SetParamCellRequest, SetParamCellResponse)

  soapstone.proto:60

  Set a single cell value by row index. Handles duplicate-ID params precisely.

  message SetParamCellRequest

  internal.proto:339

  • string param_name = 1

    The param name, e.g. "AttachEffectTableParam"

  • int32 row_index = 2

    The row index (0-based position in the param)

  • string field_name = 3

    The field internal name, e.g. "chanceWeight"

  • string value = 4

    The new value as a string

  message SetParamCellResponse

  internal.proto:350

  • bool success = 1

  • string message = 2

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 as response type in: Soapstone.GetParamRow

Used as field type in: GetParamRowsResponse

• string param_name = 1

  The param name

• int32 row_id = 2

  The row ID

• string row_name = 3

  The row name (may be empty)

• repeated ParamFieldValue values = 4

  All field values for this row

• int32 row_index = 5

  The row index (0-based position in the param, for disambiguation)

Used in: PropertySearch

• repeated PropertyCondition conditions = 3

Used in: DescribeParamResponse

• string display_name = 1

  Human-readable display name

• string internal_name = 2

  Internal engine name (e.g. "attackBasePhysics" or "weaponId:16" for bitfields)

• string def_type = 3

  Data type: s8, u8, s16, u16, s32, u32, b32, f32, angle32, f64, dummy8, fixstr, fixstrW

• int32 bit_size = 4

  Bit size for bitfields, -1 if not a bitfield

• int32 array_length = 5

  Array length for arrays/strings, 1 if not an array

• string description = 6

  Optional description text

• int32 sort_id = 7

  Sort order in the editor

Used in: GetParamRowResponse

• string internal_name = 1

  Internal engine name of the field

• string value = 2

  The value as a string (numbers, floats, strings are all string-encoded)

• string def_type = 3

  Data type for interpretation

Used in: ListParamRowsResponse

• int32 id = 1

• string name = 2

• int32 index = 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