Request message for rpc `GetAccountCharacters`.
| Field | Type | Label | Description |
| login | string |
|
Response message for rpc `GetAccountCharacters`.
| Field | Type | Label | Description |
| character_ids | uint32 | repeated |
|
Request message for rpc `GetAccount`.
| Field | Type | Label | Description |
| login | string |
|
Response message for rpc `GetAccount`.
| Field | Type | Label | Description |
| login | string |
|
|
| string |
|
Request message for rpc `IsAccountExist`.
| Field | Type | Label | Description |
| login | string |
|
Response message for rpc `IsAccountExist`.
| Field | Type | Label | Description |
| exists | bool |
|
|
| id | uint32 |
|
Request message for rpc `LogIn`.
| Field | Type | Label | Description |
| login | string |
|
|
| password | string |
|
Response message for rpc `LogIn`.
| Field | Type | Label | Description |
| success | bool |
|
|
| account_id | uint32 |
|
Request message for rpc `RegisterAccount`.
| Field | Type | Label | Description |
| login | string |
|
|
| password | string |
|
|
| string |
|
Response message for rpc `RegisterAccount`.
| Field | Type | Label | Description |
| success | bool |
|
|
| account_id | uint32 |
|
The MruV accounts service provides procedures for managing players accounts.
This service is an additional/intermediary service between the ORY Kratos & ORY Hydra service.
| Method Name | Request Type | Response Type | Description |
| RegisterAccount | RegisterAccountRequest | RegisterAccountResponse | Register a new account. |
| LogIn | LogInRequest | LogInResponse | Sign into an existing account. |
| IsAccountExist | IsAccountExistRequest | IsAccountExistResponse | Check, is account with specified login exist. If yes, it returns account id. |
| GetAccount | GetAccountRequest | GetAccountResponse | Get an account. |
| GetAccountCharacters | GetAccountCharactersRequest | GetAccountCharactersResponse | Get an account characters. |
| Method Name | Method | Pattern | Body |
| RegisterAccount | POST | /v1/accounts/register | * |
| LogIn | POST | /v1/accounts/login | * |
| IsAccountExist | GET | /v1/accounts/{login}/registered | |
| GetAccount | GET | /v1/accounts/{login} | |
| GetAccountCharacters | GET | /v1/accounts/{login}/characters |
Request message for rpc `AssignEstate`.
| Field | Type | Label | Description |
| business_id | uint32 |
|
|
| estate_id | uint32 |
|
Response message for rpc `AssignEstate`.
| Field | Type | Label | Description |
| estate_count | uint32 |
|
Request message for rpc `AssignOwner`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `AssignOwner`.
| Field | Type | Label | Description |
| owner_type | OwnerType |
|
|
| owner_id | uint32 |
|
Business data structure.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
|
| estate_ids | int64 | repeated | Estates that belongs to a business. |
| product_id | uint32 | Purchase price in economy system. |
|
| owner_type | OwnerType | Owner type of the business. |
|
| owner_id | uint32 | Owner of the business. |
|
| business_items | uint32 | repeated | Items that belongs to business. |
| business_group | uint32 | Business group |
Request message for rpc `BuyBusiness`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| buyer_type | OwnerType |
|
|
| buyer_id | uint32 |
|
Response message for rpc `BuyBusiness`.
Request message for rpc `CreateBusiness`.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
|
| product_id | uint32 | Purchase price in economy system. |
Response message for rpc `CreateBusiness`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteBusiness`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteBusiness`.
Request message for rpc `GetBusiness`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetBusiness`.
Request message for rpc `UnassignEstate`.
| Field | Type | Label | Description |
| business_id | uint32 |
|
|
| estate_id | uint32 |
|
Response message for rpc `UnassignEstate`.
| Field | Type | Label | Description |
| estate_count | uint32 |
|
Request message for rpc `UpdateBusiness`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateBusiness`.
Request message for rpc `WatchBusiness`.
Response message for rpc `WatchBusiness`.
Request message for rpc `WatchBusinesses`.
Response message for rpc `WatchBusinesses`.
Owner type.
| Name | Number | Description |
| UNKNOWN | 0 | |
| PLAYER | 1 | |
| GROUP | 2 | |
| SYSTEM | 3 |
The MruV business service provides procedures for managing businesses.
Business can be owned by a player or organisation. Every business have it's own group and products to sell.
Business can have rights to an estates.
Every business has its own type and depends on it, business provides different services.
| Method Name | Request Type | Response Type | Description |
| CreateBusiness | CreateBusinessRequest | CreateBusinessResponse | Create a business. |
| GetBusiness | GetBusinessRequest | Business | Get a business. |
| UpdateBusiness | UpdateBusinessRequest | Business | Update a business. |
| DeleteBusiness | DeleteBusinessRequest | DeleteBusinessResponse | Delete a business. |
| AssignOwner | AssignOwnerRequest | AssignOwnerResponse | Assign a business owner. |
| AssignEstate | AssignEstateRequest | AssignEstateResponse | Assign an estate to a business. |
| UnassignEstate | UnassignEstateRequest | UnassignEstateResponse | |
| BuyBusiness | BuyBusinessRequest | BuyBusinessResponse | Buy a business. |
| WatchBusiness | WatchBusinessRequest | WatchBusinessResponse stream | Subscribe to business events. |
| WatchBusinesses | WatchBusinessesRequest | WatchBusinessesResponse stream | Subscribe to all businesses events. |
| Method Name | Method | Pattern | Body |
| CreateBusiness | POST | /v1/business | * |
| GetBusiness | GET | /v1/business/{id} | |
| UpdateBusiness | PATCH | /v1/business/{id} | * |
| DeleteBusiness | DELETE | /v1/business/{id} | |
| AssignOwner | POST | /v1/business/{id}/owner | * |
| AssignEstate | POST | /v1/business/{business_id}/estates | * |
| UnassignEstate | DELETE | /v1/business/{business_id}/estates/{estate_id} | |
| BuyBusiness | POST | /v1/business/{id}/buy | * |
Request message for rpc `ChangeClothes`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| clothes_id | uint32 |
|
Response message for rpc `ChangeClothes`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| owner_id | uint32 |
|
|
| first_name | string |
|
|
| second_name | string |
|
|
| age | uint32 |
|
|
| sex | uint32 |
|
|
| clothes_id | uint32 | TODO: create clothes api |
|
| x | float |
|
|
| y | float |
|
|
| z | float |
|
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `CreateCharacter`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| owner_id | uint32 |
|
|
| first_name | string |
|
|
| second_name | string |
|
|
| age | uint32 |
|
|
| sex | uint32 |
|
Response message for rpc `CreateCharacter`.
| Field | Type | Label | Description |
| id | uint32 |
|
| Field | Type | Label | Description |
| death_types | DeathType | repeated |
|
| Field | Type | Label | Description |
| character | Character |
|
|
| death_type | DeathType |
|
Request message for rpc `DeleteCharacter`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteCharacter`.
Request message for rpc `GetCharacter`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetCharacter`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| owner_id | uint32 |
|
|
| first_name | string |
|
|
| second_name | string |
|
|
| age | uint32 |
|
|
| sex | uint32 |
|
|
| clothes_id | uint32 |
|
|
| x | float |
|
|
| y | float |
|
|
| z | float |
|
Request message for rpc `UpdateCharacter`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateCharacter`.
| Name | Number | Description |
| DEATH_TYPE_NONE | 0 | |
| DEATH_TYPE_BW | 1 | |
| DEATH_TYPE_BW_KILL | 2 | |
| DEATH_TYPE_CK | 3 |
| Method Name | Request Type | Response Type | Description |
| CreateCharacter | CreateCharacterRequest | CreateCharacterResponse | Create a character. |
| GetCharacter | GetCharacterRequest | GetCharacterResponse | Get a character. |
| UpdateCharacter | UpdateCharacterRequest | UpdateCharacterResponse | Update a character. |
| DeleteCharacter | DeleteCharacterRequest | DeleteCharacterResponse | Delete a character. |
| PermanentCharacterKill | CharacterID | CharacterID | Kill a character. A character that is killed cannot be played anymore. |
| ChangeClothes | ChangeClothesRequest | ChangeClothesResponse | Change player clothes. |
| DeathsStream | DeathStreamRequest | DeathStreamResponse stream | Stream of deaths. |
| GetServiceStatus | .mruv.common.ServiceStatusRequest | .mruv.common.ServiceStatusResponse | Service status |
| GetServiceVersion | .mruv.common.VersionRequest | .mruv.common.VersionResponse |
| Method Name | Method | Pattern | Body |
| CreateCharacter | POST | /v1/characters | * |
| GetCharacter | GET | /v1/characters/{id} | |
| UpdateCharacter | PATCH | /v1/characters/{id} | * |
| DeleteCharacter | DELETE | /v1/characters/{id} | |
| PermanentCharacterKill | DELETE | /v1/characters/permanentKill/{id} | |
| ChangeClothes | PUT | /v1/character/{id}/clothes/{clothes_id} | * |
| GetServiceStatus | GET | /v1/characters/status | |
| GetServiceVersion | GET | /v1/characters/version |
| Field | Type | Label | Description |
| status | string |
|
| Field | Type | Label | Description |
| version | string |
|
|
| build_date | string |
|
|
| commit | string |
|
|
| os_arch | string |
|
| Field | Type | Label | Description |
| x | double |
|
|
| y | double |
|
|
| z | double |
|
| Field | Type | Label | Description |
| rx | double |
|
|
| ry | double |
|
|
| rz | double |
|
Delete position request message.
| Field | Type | Label | Description |
| position | Position |
|
Delete position response message.
| Field | Type | Label | Description |
| success | bool |
|
Get animations request message.
| Field | Type | Label | Description |
| dict | string |
|
|
| name | string |
|
Get animation response message.
| Field | Type | Label | Description |
| animation | Animation |
|
|
| author | Player |
|
Get animations request message.
| Field | Type | Label | Description |
| limit | uint32 |
|
|
| dict | string |
|
|
| name | string |
|
Get animations response message.
| Field | Type | Label | Description |
| animations | GetAnimationsResponse.Row | repeated |
|
| Field | Type | Label | Description |
| animation | Animation |
|
|
| author | Player |
|
Get outfits request message.
| Field | Type | Label | Description |
| name | string |
|
|
| category | string |
|
|
| author | string |
|
Get outfits response message.
| Field | Type | Label | Description |
| outfits | GetOutfitsResponse.Row | repeated |
|
| Field | Type | Label | Description |
| outfit | Outfit |
|
|
| author | Player |
|
Get position request message.
| Field | Type | Label | Description |
| limit | uint32 |
|
|
| category | string |
|
|
| author | Player |
|
Get position response message.
| Field | Type | Label | Description |
| positions | GetPositionsResponse.Row | repeated |
|
| Field | Type | Label | Description |
| position | Position |
|
|
| author | Player |
|
Save animation request message.
| Field | Type | Label | Description |
| animation | Animation |
|
Save animation response message.
| Field | Type | Label | Description |
| success | bool |
|
Save outfit request message.
| Field | Type | Label | Description |
| outfit | Outfit |
|
Save outfit response message.
| Field | Type | Label | Description |
| success | bool |
|
Save position request message.
| Field | Type | Label | Description |
| position | Position |
|
Save position response message.
| Field | Type | Label | Description |
| success | bool |
|
The MruV developer tools service for mruv-devtools package.
| Method Name | Request Type | Response Type | Description |
| GetPositions | GetPositionsRequest | GetPositionsResponse | Get saved positions. |
| SavePosition | SavePositionRequest | SavePositionResponse | Save position. |
| DeletePosition | DeletePositionRequest | DeletePositionResponse | Delete position. |
| GetOutfits | GetOutfitsRequest | GetOutfitsResponse | Get saved outfit. |
| SaveOutfit | SaveOutfitRequest | SaveOutfitResponse | Save outfit. |
| GetAnimations | GetAnimationsRequest | GetAnimationsResponse | Get all saved animations. |
| GetAnimation | GetAnimationRequest | GetAnimationResponse | Get saved animation by name. |
| SaveAnimation | SaveAnimationRequest | SaveAnimationResponse | Save animation. |
| GetServiceStatus | .mruv.common.ServiceStatusRequest | .mruv.common.ServiceStatusResponse | Get service status. |
| GetServiceVersion | .mruv.common.VersionRequest | .mruv.common.VersionResponse | Get service version. |
| Method Name | Method | Pattern | Body |
| GetPositions | GET | /v1/devtools/positions | |
| SavePosition | POST | /v1/devtools/positions | * |
| DeletePosition | DELETE | /v1/devtools/position | |
| GetOutfits | GET | /v1/devtools/outfits | |
| SaveOutfit | POST | /v1/devtools/outfits | * |
| GetAnimations | GET | /v1/devtools/animations | |
| GetAnimation | GET | /v1/devtools/animations/{name} | |
| SaveAnimation | POST | /v1/devtools/animations | * |
| GetServiceStatus | GET | /v1/devtools/status | |
| GetServiceVersion | GET | /v1/devtools/version |
GTA V animation structure.
You can find more information about RageMP outfits [here](https://wiki.rage.mp/index.php?title=Animations "RageMP Animations")
| Field | Type | Label | Description |
| dict | string | Animation dictionary name. |
|
| name | string | Animation name. |
|
| readable_category | string | Animation category, specified by author. |
|
| category | string |
|
GTA V player outfit structure.
You can find more information about RageMP outfits [here](https://wiki.rage.mp/index.php?title=Clothes "RageMP Clothes")
| Field | Type | Label | Description |
| name | string | Name of the outfit. |
|
| category | string | Category of the outfit. |
Player structure for storing authors of devtools saved records.
| Field | Type | Label | Description |
| id | uint32 | Unique id. |
|
| name | string | Unique name. |
|
| hash | string | Password hash. |
Position structure.
| Field | Type | Label | Description |
| x | double |
|
|
| y | double |
|
|
| z | double |
|
|
| name | string | Short position name. |
|
| description | string | Description of the place which the position indicates. |
Request message for rpc `BuyProduct`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
Response message for rpc `BuyProduct`.
Request message for rpc `DeleteProduct`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
Response message for rpc `DeleteProduct`.
Request message for rpc `GetPrice`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
Response message for rpc `GetPrice`.
| Field | Type | Label | Description |
| price | uint32 |
|
Request message for rpc `GetProduct`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
Response message for rpc `GetProduct`.
| Field | Type | Label | Description |
| name | string |
|
|
| full_name | string |
|
|
| description | string |
|
|
| price_class | uint32 |
|
|
| price_ratio | float |
|
|
| starting_price | uint32 |
|
|
| price | uint32 |
|
Request message for rpc `RegisterProduct`.
| Field | Type | Label | Description |
| name | string |
|
|
| full_name | string |
|
|
| description | string |
|
|
| price_class | uint32 |
|
|
| price_ratio | float |
|
|
| starting_price | uint32 |
|
Response message for rpc `RegisterProduct`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `UpdatePrice`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| new_price | uint32 |
|
Response message for rpc `UpdatePrice`.
Request message for rpc `UpdateProduct`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| full_name | string |
|
|
| description | string |
|
|
| price_class | uint32 |
|
|
| price_ratio | float |
|
Response message for rpc `UpdateProduct`.
Request message for rpc `WatchPrice`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
Response message for rpc `WatchPrice`.
| Field | Type | Label | Description |
| price | uint32 |
|
Request message for rpc `WatchProduct`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
Response message for rpc `WatchProduct`.
| Field | Type | Label | Description |
| event | WatchProductResponse.ProductEvent |
|
| Name | Number | Description |
| UNKNOWN | 0 | |
| PRICE_CHANGED | 1 | |
| PRODUCT_BOUGHT | 2 | |
| PRODUCT_INFO_UPDATED | 3 | |
| PRODUCT_DELETED | 4 |
The MruV economy service provides procedures for managing prices and economy.
| Method Name | Request Type | Response Type | Description |
| RegisterProduct | RegisterProductRequest | RegisterProductResponse | Register price in economy system. |
| GetProduct | GetProductRequest | GetProductResponse | Get product information. |
| UpdateProduct | UpdateProductRequest | UpdateProductResponse | Update product information. |
| DeleteProduct | DeleteProductRequest | DeleteProductResponse | |
| UpdatePrice | UpdatePriceRequest | UpdatePriceResponse | Update product price. |
| GetPrice | GetPriceRequest | GetPriceResponse | Get current value for registered price. |
| BuyProduct | BuyProductRequest | BuyProductResponse | Send information to the system, that the product has been purchased. This rpc call can affect a product price. |
| WatchProduct | WatchProductRequest | WatchProductResponse stream | Subscribe to events related to a product. |
| WatchPrice | WatchPriceRequest | WatchPriceResponse stream | Subscribe to product price changes. |
| Method Name | Method | Pattern | Body |
| RegisterProduct | POST | /v1/economy/products | * |
| GetProduct | GET | /v1/economy/products/{name} | |
| UpdateProduct | PATCH | /v1/economy/products/{name} | * |
| DeleteProduct | DELETE | /v1/economy/products/{name} | |
| UpdatePrice | PATCH | /v1/economy/products/{name}/price | * |
| GetPrice | GET | /v1/economy/product/{name}/price | |
| BuyProduct | POST | /v1/economy/product/{name}/buy | * |
Request message for rpc `CreateElevator`.
Response message for rpc `CreateElevator`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteElevator`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteElevator`.
Request message for rpc `GetElevatorFloors`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetElevatorFloors`.
Request message for rpc `GetElevator`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetElevator`.
Request message for rpc `UpdateElevator`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateElevator`.
The MruV entrances service provides procedures for managing an elevators.
Elevators allow all players in the elevator area to move between building floors.
Floor change is processed in following steps:
1. Someone chooses a floor
1. Doors closing event is fired
2. Doors closed event is fired.
3. Everyone in a elevator are registered as players, that will be teleported to chosen floor.
4. X seconds delay (elevator is moving)
5. Teleport players to other floor elevator
6. Doors opening
7. Doors opened - end
You can define a one-man pseudo-elevator where only point 5 is executed.
| Method Name | Request Type | Response Type | Description |
| CreateElevator | CreateElevatorRequest | CreateElevatorResponse | Create an elevator. |
| GetElevator | GetElevatorRequest | GetElevatorResponse | Get an elevator. |
| UpdateElevator | UpdateElevatorRequest | UpdateElevatorResponse | Update an elevator. |
| DeleteElevator | DeleteElevatorRequest | DeleteElevatorResponse | Delete an elevator. |
| GetElevatorFloors | GetElevatorFloorsRequest | GetElevatorFloorsResponse | Get available elevator floors. |
| Method Name | Method | Pattern | Body |
| CreateElevator | POST | /v1/elevators | * |
| GetElevator | GET | /v1/elevators/{id} | |
| UpdateElevator | PATCH | /v1/elevators/{id} | * |
| DeleteElevator | DELETE | /v1/elevators/{id} | |
| GetElevatorFloors | GET | /v1/elevators/{id}/floors |
Request message for rpc `CreateEntrance`.
| Field | Type | Label | Description |
| name | string |
|
|
| out | mruv.spots.Spot |
|
|
| in | mruv.spots.Spot |
|
Response message for rpc `CreateEntrance`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteEntrance`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteEntrance`.
Request message for rpc `Enter`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Enter`.
| Field | Type | Label | Description |
| name | string |
|
|
| out | mruv.spots.Spot |
|
|
| in | mruv.spots.Spot |
|
Request message for rpc `Exit`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Exit`.
Request message for rpc `FetchAllEntrances`.
| Field | Type | Label | Description |
| chunk_size | uint32 |
|
Response message for rpc `FetchAllEntrances`.
| Field | Type | Label | Description |
| entrances | FetchAllEntrancesResponse.EntrancesEntry | repeated |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | Entrance |
|
Request message for rpc `FindNearestEntrance`.
| Field | Type | Label | Description |
| x | float |
|
|
| y | float |
|
|
| z | float |
|
|
| max_distance | float |
|
Response message for rpc `FindNearestEntrance`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| distance | float |
|
|
| inside | bool | Is found entrance position is in spot (out spot otherwise) |
Request message for rpc `GetEntrance`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetEntrance`.
| Field | Type | Label | Description |
| name | string |
|
|
| in_spot | mruv.spots.Spot |
|
|
| out_spot | mruv.spots.Spot |
|
Request message for rpc `Lock`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Lock`.
Request message for rpc `Unlock`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Unlock`.
Request message for rpc `UpdateEntrance`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| in_spot_id | uint32 |
|
|
| out_spot_id | uint32 |
|
Response message for rpc `UpdateEntrance`.
The MruV entrances service provides procedures for managing an entrances to estates and teleportation to locations.
| Method Name | Request Type | Response Type | Description |
| CreateEntrance | CreateEntranceRequest | CreateEntranceResponse | Create an entrance to building or teleport to location. |
| GetEntrance | GetEntranceRequest | GetEntranceResponse | Get an entrance to building or a teleport to location. |
| UpdateEntrance | UpdateEntranceRequest | UpdateEntranceResponse | Update an entrance to building or a teleport to location. |
| DeleteEntrance | DeleteEntranceRequest | DeleteEntranceResponse | Delete an entrance to building or a teleport to location. |
| Lock | LockRequest | LockResponse | Lock entrance. |
| Unlock | UnlockRequest | UnlockResponse | Unload entrance. |
| FindNearestEntrance | FindNearestEntranceRequest | FindNearestEntranceResponse | Find gate that is closest to a specific position. |
| Enter | EnterRequest | EnterResponse | Enter an entrance (player teleport from in spot position to out spot position). |
| Exit | ExitRequest | ExitResponse | Exit from entrance (player teleport from out spot position to in spot position). |
| FetchAll | FetchAllEntrancesRequest | FetchAllEntrancesResponse stream |
| Method Name | Method | Pattern | Body |
| CreateEntrance | POST | /v1/entrances | * |
| GetEntrance | GET | /v1/entrances/{id} | |
| UpdateEntrance | PATCH | /v1/entrances/{id} | * |
| DeleteEntrance | DELETE | /v1/entrances/{id} | |
| Lock | POST | /v1/entrances/{id}/lock | * |
| Unlock | POST | /v1/entrances/{id}/unlock | * |
| FindNearestEntrance | GET | /v1/entrances/nearest | |
| Enter | POST | /v1/entrances/{id}/enter | * |
| Exit | POST | /v1/entrances/{id}/exit | * |
Request message for rpc `AddEntrance`.
| Field | Type | Label | Description |
| estate_id | uint32 |
|
|
| entrance_id | uint32 |
|
Response message for rpc `AddEntrance`.
Request message for rpc `AddGate`.
| Field | Type | Label | Description |
| estate_id | uint32 |
|
|
| gate_id | uint32 |
|
Response message for rpc `AddGate`.
Request message for rpc `CreateEstate`.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
Response message for rpc `CreateEstate`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteEstate`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteEstate`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| description | string |
|
|
| entrances | uint32 | repeated |
|
| gates | uint32 | repeated |
|
| rooms | uint32 | repeated |
|
| product_id | uint32 |
|
Request message for rpc `FetchAll`.
| Field | Type | Label | Description |
| chunk_size | uint32 |
|
Response message for rpc `FetchAll`.
| Field | Type | Label | Description |
| estates | FullEstate | repeated |
|
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| description | string |
|
|
| objects | FullEstate.ObjectsEntry | repeated |
|
| removed_buildings | FullEstate.RemovedBuildingsEntry | repeated |
|
| entrances | FullEstate.EntrancesEntry | repeated |
|
| gates | FullEstate.GatesEntry | repeated | TODO: map<uint32, mruv.plots.Plot> rooms = 8; |
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | mruv.entrances.Entrance |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | mruv.gates.Gate |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | mruv.objects.Object |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | mruv.objects.RemovedBuilding |
|
Request message for rpc `GetEstateEntrances`.
| Field | Type | Label | Description |
| estate_id | uint32 |
|
Response message for rpc `GetEstateEntrances`.
| Field | Type | Label | Description |
| entrances | mruv.entrances.Entrance | repeated |
|
Request message for rpc `GetEstateGates`.
| Field | Type | Label | Description |
| estate_id | uint32 |
|
Response message for rpc `GetEstateGates`.
| Field | Type | Label | Description |
| gates | mruv.gates.Gate | repeated |
|
Request message for rpc `GetEstate`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `GetEstates`.
| Field | Type | Label | Description |
| from | uint32 |
|
|
| limit | uint32 |
|
Response message for rpc `GetEstates`.
| Field | Type | Label | Description |
| estates | Estate | repeated |
|
Request message for rpc `RemoveEntrance`.
| Field | Type | Label | Description |
| estate_id | uint32 |
|
|
| entrance_id | uint32 |
|
Response message for rpc `RemoveEntrance`.
Request message for rpc `RemoveGate`.
| Field | Type | Label | Description |
| estate_id | uint32 |
|
|
| gate_id | uint32 |
|
Response message for rpc `RemoveGate`.
Request message for rpc `UpdateEstate`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| description | string |
|
Response message for rpc `UpdateEstate`.
The MruV estate service provides procedures for managing buildings and other estates.
| Method Name | Request Type | Response Type | Description |
| CreateEstate | CreateEstateRequest | CreateEstateResponse | Create real estate. |
| GetEstate | GetEstateRequest | Estate | Get real estate. |
| UpdateEstate | UpdateEstateRequest | UpdateEstateResponse | Update real estate. |
| DeleteEstate | DeleteEstateRequest | DeleteEstateResponse | Delete real estate. |
| GetEstates | GetEstatesRequest | GetEstatesResponse | Get all created real estates. |
| AddGate | AddGateRequest | AddGateResponse | Add a gate to an estate. |
| RemoveGate | RemoveGateRequest | RemoveGateResponse | Delete a gate from estate. |
| GetEstateGates | GetEstateGatesRequest | GetEstateGatesResponse | Get all estate gates. |
| AddEntrance | AddEntranceRequest | AddEntranceResponse | Add an entrance to estate. |
| RemoveEntrance | RemoveEntranceRequest | RemoveEntranceResponse | Remove an entrance from estate. |
| GetEstateEntrances | GetEstateEntrancesRequest | GetEstateEntrancesResponse | Get all estate entrances. |
| FetchAll | FetchAllEstatesRequest | FetchAllEstatesResponse stream | Get full estates data |
| Method Name | Method | Pattern | Body |
| CreateEstate | POST | /v1/estates | * |
| GetEstate | GET | /v1/estates/{id} | |
| UpdateEstate | PATCH | /v1/estates/{id} | * |
| DeleteEstate | DELETE | /v1/estates/{id} | |
| GetEstates | GET | /v1/estates | |
| AddGate | POST | /v1/estates/{estate_id}/gates | * |
| RemoveGate | DELETE | /v1/estates/{estate_id}/gates/{gate_id} | |
| GetEstateGates | GET | /v1/estate/{estate_id}/gates | |
| AddEntrance | POST | /v1/estates/{estate_id}/entrances | * |
| RemoveEntrance | DELETE | /v1/estates/{estate_id}/entrances/{entrance_id} | |
| GetEstateEntrances | GET | /v1/estate/{estate_id}/entrances |
Request message for rpc `Close`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Close`.
Request message for rpc `CreateGate`.
| Field | Type | Label | Description |
| name | string |
|
|
| gate_objects | mruv.objects.MovableObject | repeated | List of objects to move on gate close/open. Every object should have only 2 states: opened, closed. |
| spot | mruv.spots.Spot | Gate spot. This spot define gate position. |
Response message for rpc `CreateGate`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteGate`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteGate`.
Request message for rpc `FetchAllGates`.
| Field | Type | Label | Description |
| chunk_size | uint32 |
|
Response message for rpc `FetchAllGates`.
| Field | Type | Label | Description |
| gates | FetchAllGatesResponse.GatesEntry | repeated |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | Gate |
|
Request message for rpc `FindNearestGate`.
| Field | Type | Label | Description |
| x | float |
|
|
| y | float |
|
|
| z | float |
|
|
| max_distance | float |
|
Response message for rpc `FindNearestGate`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| distance | float |
|
| Field | Type | Label | Description |
| name | string |
|
|
| gate_objects | mruv.objects.MovableObject | repeated |
|
| spot | mruv.spots.Spot |
|
|
| opened | bool |
|
|
| locked | bool |
|
Request message for rpc `GetGate`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetGate`.
| Field | Type | Label | Description |
| name | string |
|
|
| movable_objects | mruv.objects.MovableObject | repeated | List of objects to move on gate close/open. Every object should have only 2 states: opened, closed. |
| spot | mruv.spots.Spot |
|
|
| opened | bool |
|
|
| locked | bool |
|
Request message for rpc `Lock`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Lock`.
Request message for rpc `Open`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Open`.
Request message for rpc `Unlock`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `Unlock`.
Request message for rpc `UpdateGate`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| spot_id | uint32 |
|
|
| gate_movable_objects | uint32 | repeated |
|
Response message for rpc `UpdateGate`.
The MruV gates service provides procedures for managing gates and moving objects groups.
| Method Name | Request Type | Response Type | Description |
| CreateGate | CreateGateRequest | CreateGateResponse | Create a gate or a moving objects objects group. |
| GetGate | GetGateRequest | GetGateResponse | Get a gate or a moving objects objects group. |
| UpdateGate | UpdateGateRequest | UpdateGateResponse | Update a gate or a moving objects objects group. |
| DeleteGate | DeleteGateRequest | DeleteGateResponse | Delete a gate or a moving objects objects group. |
| Lock | LockRequest | LockResponse | Lock a gate. Locked gate cannot be opened. |
| Unlock | UnlockRequest | UnlockResponse | Unload a gate, so it can be open. |
| Open | OpenRequest | OpenResponse | Opens a gate. |
| Close | CloseRequest | CloseResponse | Close a gate. |
| FindNearestGate | FindNearestGateRequest | FindNearestGateResponse | Find gate that is closest to a specific position. |
| FetchAll | FetchAllGatesRequest | FetchAllGatesResponse stream |
| Method Name | Method | Pattern | Body |
| CreateGate | POST | /v1/gates | * |
| GetGate | GET | /v1/gates/{id} | |
| UpdateGate | PATCH | /v1/gates/{id} | * |
| DeleteGate | DELETE | /v1/gates/{id} | |
| Lock | POST | /v1/gates/{id}/lock | * |
| Unlock | POST | /v1/gates/{id}/unlock | * |
| Open | POST | /v1/gates/{id}/open | * |
| Close | POST | /v1/gates/{id}/close | * |
| FindNearestGate | GET | /v1/gates/nearest |
Request message for rpc `AddMember`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| member_id | uint32 |
|
Response message for rpc `AddMember`.
Request message for rpc `AddPermission`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| name | string |
|
|
| definition | string |
|
Response message for rpc `AddPermission`.
| Field | Type | Label | Description |
| permission_id | uint32 |
|
Request message for rpc `AddSubgroup`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| subgroup_id | uint32 |
|
Response message for rpc `AddSubgroup`.
Request message for rpc `AssignOwner`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| owner_type | OwnerType |
|
|
| owner_id | uint32 |
|
Response message for rpc `AssignOwner`.
Request message for rpc `CreateGroup`.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
Response message for rpc `CreateGroup`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
Request message for rpc `DeleteGroup`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
Response message for rpc `DeleteGroup`.
Request message for rpc `GetGroup`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
Response message for rpc `GetGroup`.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
Request message for rpc `GetGroups`.
| Field | Type | Label | Description |
| limit | uint32 |
|
|
| begin_from | uint32 |
|
Response message for rpc `GetGroups`.
| Field | Type | Label | Description |
| groups | GetGroupsResponse.Group | repeated |
|
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| description | string |
|
Request message for rpc `GetMembers`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
Response message for rpc `GetMembers`.
| Field | Type | Label | Description |
| member_type | MemberType |
|
|
| member_ids | uint32 | repeated |
|
Request message for rpc `GetOwner`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
Response message for rpc `GetOwner`.
| Field | Type | Label | Description |
| owner_id | uint32 |
|
|
| owner_type | OwnerType |
|
Request message for rpc `GetPermissions`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
Response message for rpc `GetPermissions`.
| Field | Type | Label | Description |
| permissions | GetPermissionsResponse.Permission | repeated |
|
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| definition | string |
|
Request message for rpc `GetSubgroups`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
Response message for rpc `GetSubgroups`.
| Field | Type | Label | Description |
| subgroup_ids | uint32 | repeated |
|
Request message for rpc `IsPermitted`.
| Field | Type | Label | Description |
| member_id | uint32 |
|
|
| member_type | MemberType |
|
|
| action | string |
|
Response message for rpc `IsPermitted`.
| Field | Type | Label | Description |
| permitted | bool |
|
Request message for rpc `RemoveMember`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| member_id | uint32 |
|
Response message for rpc `RemoveMember`.
Request message for rpc `RemovePermission`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| permission_id | uint32 |
|
Response message for rpc `RemovePermission`.
Request message for rpc `RemoveSubgroup`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| subgroup_id | uint32 |
|
Response message for rpc `RemoveSubgroup`.
Request message for rpc `UpdateGroup`.
| Field | Type | Label | Description |
| group_id | uint32 |
|
|
| name | string |
|
|
| description | string |
|
Response message for rpc `UpdateGroup`.
Member type.
| Name | Number | Description |
| MEMBER_TYPE_UNKNOWN | 0 | |
| MEMBER_TYPE_ACCOUNT | 1 | |
| MEMBER_TYPE_CHARACTER | 2 |
Owner types.
| Name | Number | Description |
| OWNER_TYPE_UNKNOWN | 0 | |
| OWNER_TYPE_ACCOUNT | 1 | |
| OWNER_TYPE_CHARACTER | 2 | |
| OWNER_TYPE_GROUP | 3 |
The MruV groups service provides procedures for managing groups.
| Method Name | Request Type | Response Type | Description |
| CreateGroup | CreateGroupRequest | CreateGroupResponse | Create a group. |
| GetGroup | GetGroupRequest | GetGroupResponse | Get a group. |
| UpdateGroup | UpdateGroupRequest | UpdateGroupResponse | Update a group. |
| DeleteGroup | DeleteGroupRequest | DeleteGroupResponse | Delete a group. |
| GetGroups | GetGroupsRequest | GetGroupsResponse | Get all groups. |
| AssignOwner | AssignOwnerRequest | AssignOwnerResponse | Assign an owner. Group can have only one owner. Owner can be a player, a group or an account. |
| GetOwner | GetOwnerRequest | GetOwnerResponse | Get group owner. |
| AddMember | AddMemberRequest | AddMemberResponse | Add a group member. |
| GetMembers | GetMembersRequest | GetMembersResponse | Get a group member. |
| RemoveMember | RemoveMemberRequest | RemoveMemberResponse | Remove a group member. |
| AddPermission | AddPermissionRequest | AddPermissionResponse | Add a permission to a group. |
| GetPermissions | GetPermissionsRequest | GetPermissionsResponse | Get all group permissions. |
| RemovePermission | RemovePermissionRequest | RemovePermissionResponse | Remove group permission. |
| AddSubgroup | AddSubgroupRequest | AddSubgroupResponse | Add a subgroup to a group. |
| GetSubgroups | GetSubgroupsRequest | GetSubgroupsResponse | Get all subgroups. |
| RemoveSubgroup | RemoveSubgroupRequest | RemoveSubgroupResponse | Remove a subgroup from group. |
| IsPermitted | IsPermittedRequest | IsPermittedResponse | Check is member of a group is permitted to do specific action. |
| GetServiceStatus | .mruv.common.ServiceStatusRequest | .mruv.common.ServiceStatusResponse | Service status |
| GetServiceVersion | .mruv.common.VersionRequest | .mruv.common.VersionResponse |
| Method Name | Method | Pattern | Body |
| CreateGroup | POST | /v1/groups | * |
| GetGroup | GET | /v1/groups/{group_id} | |
| UpdateGroup | PATCH | /v1/groups/{group_id} | * |
| DeleteGroup | DELETE | /v1/groups/{group_id} | |
| GetGroups | GET | /v1/groups | |
| AssignOwner | PUT | /v1/groups/{group_id}/owner | * |
| GetOwner | GET | /v1/groups/{group_id}/owner | |
| AddMember | POST | /v1/groups/{group_id}/members/{member_id} | * |
| GetMembers | GET | /v1/groups/{group_id}/members | |
| RemoveMember | DELETE | /v1/groups/{group_id}/members/{member_id} | |
| AddPermission | POST | /v1/groups/{group_id}/permissions | * |
| GetPermissions | GET | /v1/groups/{group_id}/permissions | |
| RemovePermission | DELETE | /v1/groups/{group_id}/permissions | |
| AddSubgroup | POST | /v1/groups/{group_id}/subgroups/{subgroup_id} | * |
| GetSubgroups | GET | /v1/groups/{group_id}/subgroups | |
| RemoveSubgroup | DELETE | /v1/groups/{group_id}/subgroups/{subgroup_id} | |
| IsPermitted | GET | /v1/groups/members/{member_id}/permitted | |
| GetServiceStatus | GET | /v1/groups/status | |
| GetServiceVersion | GET | /v1/groups/version |
Request message for rpc `CreateHouse`.
Response message for rpc `CreateHouse`.
Request message for rpc `DeleteHouse`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteHouse`.
Request message for rpc `GetHouse`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetHouse`.
Request message for rpc `UpdateHouse`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateHouse`.
The MruV houses service provides procedures for managing houses.
| Method Name | Request Type | Response Type | Description |
| CreateHouse | CreateHouseRequest | CreateHouseResponse | Create a house. |
| GetHouse | GetHouseRequest | GetHouseResponse | Get a house. |
| UpdateHouse | UpdateHouseRequest | UpdateHouseResponse | Update a house. |
| DeleteHouse | DeleteHouseRequest | DeleteHouseResponse | Delete a house. |
| Method Name | Method | Pattern | Body |
| CreateHouse | POST | /v1/houses | * |
| GetHouse | GET | /v1/houses/{id} | |
| UpdateHouse | PATCH | /v1/houses/{id} | * |
| DeleteHouse | DELETE | /v1/houses/{id} |
Request message for `MruVItemsService.GetContainerItems`.
| Field | Type | Label | Description |
| container_id | uint32 | ID of container with items. |
|
| limit | uint32 | Limit of the returned items. |
Request message for `MruVItemsService.GetContainerItems`.
| Field | Type | Label | Description |
| items | InsideItem | repeated | List of items inside containers. |
Request message for `MruVItemsService.GetContainerTypes`.
| Field | Type | Label | Description |
| limit | uint32 | Limit of the returned container types. |
Response message for `MruVItemsService.GetContainers`.
| Field | Type | Label | Description |
| container_types | ContainerType | repeated | List of container types. |
Request message for `MruVItemsService.GetContainers`.
| Field | Type | Label | Description |
| limit | uint32 | Limit of the returned containers. |
Response message for `MruVItemsService.GetContainers`.
| Field | Type | Label | Description |
| containers | Container | repeated | List of containers. |
Request message for `MruVItemsService.GetItemTypes`.
| Field | Type | Label | Description |
| limit | uint32 | Limit of the returned item types. |
Response message for `MruVItemsService.GetItemTypes`.
| Field | Type | Label | Description |
| item_types | ItemType | repeated | List of item types. |
Request message for `MruVItemsService.GetItems`.
| Field | Type | Label | Description |
| limit | uint32 | Limit of the returned items. |
Response message for `MruVItemsService.GetItems`.
| Field | Type | Label | Description |
| items | Item | repeated | List of items. |
Request message for `MruVItemsService.GetNearestItems`.
| Field | Type | Label | Description |
| position | mruv.common.Position | Position from which to calculate the distance |
|
| container_id | uint32 | ID of container that contains items. |
|
| distance_limit | double | The distance over which the items are ignored. |
Response message for `MruVItemsService.GetNearestItems`.
| Field | Type | Label | Description |
| item | InsideItem | repeated | List of items sorted from nearest to farthest. |
Request message for `MruVItemsService.PullItem`.
| Field | Type | Label | Description |
| container_id | uint32 | ID of the container from which we pull out a item. |
|
| item_id | uint32 | ID of the item we want to pull out. That item must be inside the container. |
Request message for `MruVItemsService.PutItem`.
| Field | Type | Label | Description |
| container_id | uint32 | ID of container where to put item. |
|
| item_id | uint32 | ID of item we wan to put in. |
|
| slot | int32 | Position used for sorting items |
Response message for `MruVItemsService.PutItem`
| Field | Type | Label | Description |
| inside_item | InsideItem | Container with items inside. |
Request message for `MruVItemsService.SortItems`.
| Field | Type | Label | Description |
| container_id | uint32 | ID of the container which contain items. |
|
| sort_by | SortingMode | Sorting mode. |
Response message for `MruVItemsService.SortItems`.
| Field | Type | Label | Description |
| container | Container | Container with sorted items inside. |
Request message for `MruVItemsService.UseItem`.
| Field | Type | Label | Description |
| item_id | uint32 |
|
Response message for `MruVItemsService.UseItem`.
| Field | Type | Label | Description |
| success | bool | Is item usage was successful. |
The MruV items service provides procedures for managing items and containers
| Method Name | Request Type | Response Type | Description |
| CreateItem | Item | ItemID | Create new item. |
| GetItem | ItemID | Item | Get item by id. |
| DeleteItem | ItemID | ItemID | Delete item by id. |
| GetItems | GetItemsRequest | GetItemsResponse | Gets all items. |
| CreateItemType | ItemType | ItemTypeID | Create item type. |
| GetItemType | ItemTypeID | ItemType | Get item type by id. |
| DeleteItemType | ItemTypeID | ItemTypeID | Delete item type by id. |
| GetItemTypes | GetItemTypesRequest | GetItemTypesResponse | Gets all item types. |
| CreateContainer | Container | ContainerID | Create container. |
| GetContainer | ContainerID | Container | Get container by id. |
| DeleteContainer | ContainerID | ContainerID | Delete container by id. |
| GetContainers | GetContainersRequest | GetContainersResponse | Get all containers. |
| CreateContainerType | ContainerType | ContainerTypeID | Create a container type. |
| GetContainerType | ContainerTypeID | ContainerType | Get a container type by id. |
| DeleteContainerType | ContainerTypeID | ContainerTypeID | Delete a container type by id. |
| GetContainerTypes | GetContainerTypesRequest | GetContainerTypesResponse | Get all container types. |
| GetContainerItems | GetContainerItemsRequest | GetContainerItemsResponse | Get items inside a container. |
| PullItem | PullItemRequest | Item | Pull an item from container. |
| PutItem | PutItemRequest | PutItemResponse | Put an item into container. |
| SortItems | SortItemsRequest | SortItemsResponse | Sort items inside container. This procedure change order of items inside container. |
| GetNearestItems | GetNearestItemsRequest | GetNearestItemsResponse | Retrieves from the container the list of items nearest to the given position. |
| UseItem | UseItemRequest | UseItemResponse | Trigger action associated with the item usage. |
| GetServiceStatus | .mruv.common.ServiceStatusRequest | .mruv.common.ServiceStatusResponse | Get service health status. |
| GetServiceVersion | .mruv.common.VersionRequest | .mruv.common.VersionResponse | Get service current version. |
| Method Name | Method | Pattern | Body |
| CreateItem | POST | /v1/items | * |
| GetItem | GET | /v1/items/{id} | |
| DeleteItem | DELETE | /v1/items/{id} | |
| GetItems | GET | /v1/items | |
| CreateItemType | POST | /v1/itemTypes | * |
| GetItemType | GET | /v1/itemTypes/{id} | |
| DeleteItemType | DELETE | /v1/itemTypes/{id} | |
| GetItemTypes | GET | /v1/itemTypes | |
| CreateContainer | POST | /v1/containers | * |
| GetContainer | GET | /v1/containers/{id} | |
| DeleteContainer | DELETE | /v1/containers/{id} | |
| GetContainers | GET | /v1/containers | |
| CreateContainerType | POST | /v1/containerTypes | * |
| GetContainerType | GET | /v1/containerTypes/{id} | |
| DeleteContainerType | DELETE | /v1/containerTypes/{id} | |
| GetContainerTypes | GET | /v1/containerTypes | |
| GetContainerItems | GET | /v1/containers/{container_id}/items | |
| PullItem | DELETE | /v1/containers/{container_id}/items/{item_id} | |
| PutItem | PUT | /v1/containers/{container_id}/items/{item_id} | * |
| SortItems | GET | /v1/containers/{container_id}/items/sort/{sort_by} | |
| GetNearestItems | GET | /v1/containers/{container_id}/items/nearest/x/{position.x}/y/{position.y}/z/{position.z} | |
| UseItem | GET | /v1/items/{item_id}/use | |
| GetServiceStatus | GET | /v1/items/status | |
| GetServiceVersion | GET | /v1/items/version |
Container data structure.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| type_id | uint32 | ID of an container type. |
|
| item_id | uint32 | ID of container item representing container. |
|
| items_inside | uint32 | Number of items inside container. |
|
| items | InsideItem | repeated | List of items inside container. |
Container ID.
| Field | Type | Label | Description |
| id | uint32 |
|
Container type data structure.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| container_item_type_id | uint32 | ID of an item type. |
|
| max_number | uint32 | Max items in the container. |
|
| max_volume | float | Max volume of items in the container. |
|
| max_weight | float | Max weight of items in the container. |
|
| valid_item_types | int64 | repeated |
|
Container type ID.
| Field | Type | Label | Description |
| id | uint32 |
|
Item inside container data structure.
| Field | Type | Label | Description |
| container_id | uint32 | ID of container containing the item. |
|
| item_id | uint32 |
|
|
| item | Item |
|
|
| position | int32 | Position representing order in container. In ascending manner. |
Item data structure.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| item_type_id | uint32 | ID of an item type. |
|
| weight | float | Current weight of the item. |
|
| volume | float | Current volume of the item. |
Item ID.
| Field | Type | Label | Description |
| id | uint32 |
|
Item type data structure
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string | Short name of item type. |
|
| description | string | Description of item type. |
|
| base_weight | float | Default weight of items created with that item type. |
|
| base_volume | float | Default volume of items created with that item type. |
|
| model_name | string | GTA V model name. |
|
| model_hash | int32 | GTA V model hash. |
Item type ID.
| Field | Type | Label | Description |
| id | uint32 |
|
Sorting modes for container items.
| Name | Number | Description |
| UNKNOWN | 0 | undefined behaviour |
| WEIGHT_DESC | 1 | sort by weight descending |
| WEIGHT_ASC | 2 | sort by weight ascending |
| VOLUME_DESC | 3 | sort by volume descending |
| VOLUME_ASC | 4 | sort by volume ascending |
Request message for rpc `CreateJob`.
Response message for rpc `CreateJob`.
Request message for rpc `DeleteJob`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteJob`.
Request message for rpc `GetJob`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetJob`.
Request message for rpc `UpdateJob`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateJob`.
The MruV jobs service provides procedures for managing jobs.
| Method Name | Request Type | Response Type | Description |
| CreateJob | CreateJobRequest | CreateJobResponse | Create a job. |
| GetJob | GetJobRequest | GetJobResponse | Get a job. |
| UpdateJob | UpdateJobRequest | UpdateJobResponse | Update a job. |
| DeleteJob | DeleteJobRequest | DeleteJobResponse | Delete a job. |
| Method Name | Method | Pattern | Body |
| CreateJob | POST | /v1/jobs | * |
| GetJob | GET | /v1/jobs/{id} | |
| UpdateJob | PATCH | /v1/jobs/{id} | * |
| DeleteJob | DELETE | /v1/jobs/{id} |
Request message for rpc `CreateObjectModel`.
| Field | Type | Label | Description |
| object_type | ObjectModel |
|
Response message for rpc `CreateObjectModel`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteObjectModel`.
| Field | Type | Label | Description |
| model | int32 |
|
Response message for rpc `DeleteObjectModel`.
Request message for rpc `FetchAll`.
| Field | Type | Label | Description |
| chunk_size | uint32 |
|
Response message for rpc `FetchAll`.
| Field | Type | Label | Description |
| models | FetchAllModelsResponse.ModelsEntry | repeated |
|
| Field | Type | Label | Description |
| key | int32 |
|
|
| value | ObjectModel |
|
Request message for rpc `GetObjectModel`.
| Field | Type | Label | Description |
| model | int32 |
|
Response message for rpc `GetObjectModel`.
| Field | Type | Label | Description |
| object_type | ObjectModel |
|
SA-MP Object type data structure.
| Field | Type | Label | Description |
| model | int32 |
|
|
| model_name | string |
|
|
| name | string |
|
|
| category | string |
|
|
| length | double |
|
|
| width | double |
|
|
| height | double |
|
|
| size | double | if no size specified, it will be calculated based on length, width and height |
|
| tags | string | repeated |
|
| has_collision | bool |
|
|
| breaks_on_hit | bool |
|
|
| has_animation | bool |
|
|
| visible_by_time | bool |
|
|
| visible_from | uint32 |
|
|
| visible_to | uint32 |
|
Request message for rpc `UpdateObjectModel`.
| Field | Type | Label | Description |
| object_type | ObjectModel |
|
Response message for rpc `UpdateObjectModel`.
The MruV objects service provides procedures for game object models.
| Method Name | Request Type | Response Type | Description |
| CreateObjectModel | CreateObjectModelRequest | CreateObjectModelResponse | Create an object model. |
| GetObjectModel | GetObjectModelRequest | GetObjectModelResponse | Get an object model. |
| UpdateObjectModel | UpdateObjectModelRequest | UpdateObjectModelResponse | Update an object model. |
| DeleteObjectModel | DeleteObjectModelRequest | DeleteObjectModelResponse | Delete an object model. |
| FetchAllModels | FetchAllModelsRequest | FetchAllModelsResponse stream | Get all models. |
| Method Name | Method | Pattern | Body |
| CreateObjectModel | POST | /v1/objectTypes | * |
| GetObjectModel | GET | /v1/objectTypes/{model} | |
| UpdateObjectModel | PATCH | /v1/objectTypes/{object_type.model} | * |
| DeleteObjectModel | DELETE | /v1/objectTypes/{model} | |
| FetchAllModels | GET | /v1/objectTypes |
Request message for rpc `CreateMovableObject`.
| Field | Type | Label | Description |
| object | Object |
|
|
| states | State | repeated | List of states that an object can take. |
Response message for rpc `CreateMovableObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteMovableObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteMovableObject`.
Request message for rpc `FetchAllMovableObjects`.
| Field | Type | Label | Description |
| chunk_size | uint32 |
|
Response message for rpc `FetchAllMovableObjects`.
| Field | Type | Label | Description |
| movable_objects | FetchAllMovableObjectsResponse.MovableObjectsEntry | repeated |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | MovableObject |
|
Request message for rpc `GetMovableObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetMovableObject`.
| Field | Type | Label | Description |
| object | Object |
|
|
| states | State | repeated |
|
| current_state_id | uint32 |
|
|
| current_state_name | string |
|
A movable object.
| Field | Type | Label | Description |
| object | Object |
|
|
| states | State | repeated | List of states that an object can take. |
Request message for rpc `MoveObjectNext`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `MoveObjectNext`.
| Field | Type | Label | Description |
| state_id | uint32 |
|
|
| state_name | string |
|
Request message for rpc `MoveObjectPrevious`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `MoveObjectPrevious`.
| Field | Type | Label | Description |
| state_id | uint32 |
|
|
| state_name | string |
|
Request message for rpc `MoveObject`.
| Field | Type | Label | Description |
| state | uint32 |
|
Response message for rpc `MoveObject`.
Position and rotation state of moving object.
| Field | Type | Label | Description |
| name | string |
|
|
| x | float |
|
|
| y | float |
|
|
| z | float |
|
|
| rx | float |
|
|
| ry | float |
|
|
| rz | float |
|
|
| transition_speed | float |
|
Request message for rpc `UpdateMovableObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| object_id | uint32 | 0 for no changes. |
|
| states | State | repeated |
|
Response message for rpc `UpdateMovableObject`.
The MruV objects service provides procedures for movable game objects.
| Method Name | Request Type | Response Type | Description |
| CreateMovableObject | CreateMovableObjectRequest | CreateMovableObjectResponse | Create a movable object. |
| GetMovableObject | GetMovableObjectRequest | GetMovableObjectResponse | Get a movable object. |
| UpdateMovableObject | UpdateMovableObjectRequest | UpdateMovableObjectResponse | Update a movable object. |
| DeleteMovableObject | DeleteMovableObjectRequest | DeleteMovableObjectResponse | Delete a movable object. |
| MoveObject | MoveObjectRequest | MoveObjectResponse | Move an object to other state. |
| MoveObjectNext | MoveObjectNextRequest | MoveObjectNextResponse | Move an object to next state. |
| MoveObjectPrevious | MoveObjectPreviousRequest | MoveObjectPreviousResponse | Move an object to previous state. |
| FetchAllMovableObjects | FetchAllMovableObjectsRequest | FetchAllMovableObjectsResponse stream |
| Method Name | Method | Pattern | Body |
| CreateMovableObject | POST | /v1/movableObjects | * |
| GetMovableObject | GET | /v1/movableObjects/{id} | |
| UpdateMovableObject | PATCH | /v1/movableObjects/{id} | * |
| DeleteMovableObject | DELETE | /v1/movableObjects/{id} | |
| MoveObject | POST | /v1/movableObjects/moves | * |
| MoveObjectNext | POST | /v1/movableObjects/moves/next | * |
| MoveObjectPrevious | POST | /v1/movableObjects/moves/previous | * |
Request message for rpc `AddObjectMaterial`.
| Field | Type | Label | Description |
| object_id | uint32 |
|
|
| index | uint32 | The material index on the object to change (0 to 15) |
|
| material | Material |
|
Response message for rpc `AddObjectMaterial`.
Request message for rpc `AddObjectMaterialText`.
| Field | Type | Label | Description |
| object_id | uint32 |
|
|
| index | uint32 | The object's material index to replace with text (0 to 15). |
|
| material_text | MaterialText |
|
Response message for rpc `AddObjectMaterialText`.
Request message for rpc `AddRemoveBuilding`.
| Field | Type | Label | Description |
| removed_building | RemovedBuilding |
|
Response message for rpc `AddRemoveBuilding`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `CreateObject`.
| Field | Type | Label | Description |
| object | Object |
|
Response message for rpc `CreateObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteObjectMaterial`.
| Field | Type | Label | Description |
| object_id | uint32 |
|
|
| index | uint32 | The material index on the object to delete (0 to 15). |
Response message for rpc `DeleteObjectMaterial`.
Request message for rpc `DeleteObjectMaterialText`.
| Field | Type | Label | Description |
| object_id | uint32 |
|
|
| index | uint32 | The object's material index to delete (0 to 15). |
Response message for rpc `DeleteObjectMaterialText`.
Request message for rpc `DeleteObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteObject`.
Request message for rpc `DeleteRemoveBuilding`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteRemoveBuilding`.
Request message for rpc `FetchAll`.
| Field | Type | Label | Description |
| chunk_size | uint32 |
|
|
| estate_id | uint32 | optional filter for estate id |
Response message for rpc `FetchAll`.
| Field | Type | Label | Description |
| objects | FetchAllObjectsResponse.ObjectsEntry | repeated |
|
| Field | Type | Label | Description |
| key | int32 |
|
|
| value | Object |
|
Request message for rpc `GetObjectMaterialTexts`.
| Field | Type | Label | Description |
| object_id | uint32 |
|
Response message for rpc `GetObjectMaterialTexts`.
| Field | Type | Label | Description |
| material_texts | GetObjectMaterialTextsResponse.MaterialTextsEntry | repeated | Map of material texts, key - material index (0-15). |
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | MaterialText |
|
Request message for rpc `GetObjectMaterials`.
| Field | Type | Label | Description |
| object_id | uint32 |
|
Response message for rpc `GetObjectMaterials`.
| Field | Type | Label | Description |
| materials | GetObjectMaterialsResponse.MaterialsEntry | repeated | Map of materials, key - material index (0-15) |
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | Material |
|
Request message for rpc `GetObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetObject`.
| Field | Type | Label | Description |
| object | Object |
|
Request message for rpc `GetRemovedBuildings`.
| Field | Type | Label | Description |
| estate_id | uint32 | optional filter for estate id |
Response message for rpc `GetRemovedBuildings`.
| Field | Type | Label | Description |
| removed_buildings | RemovedBuilding | repeated |
|
Replace the texture of an object with the texture from another model in the game.
| Field | Type | Label | Description |
| model_id | int32 | The modelid on which the replacement texture is located. Use 0 for alpha. Use -1 to change the material color without altering the texture. |
|
| txd_name | string | The name of the txd file which contains the replacement texture (use "none" if not required) |
|
| texture_name | string | The name of the texture to use as the replacement (use "none" if not required) |
|
| material_color | int32 | The object color to set, as an integer or hex in ARGB color format. Using 0 keeps the existing material color. |
Replace the texture of an object with text.
| Field | Type | Label | Description |
| text | string | The text to show on the object (MAX 2048 characters). |
|
| material_size | MaterialSize | The size of the material (default: 256x128). |
|
| font_face | string | The font to use (default: Arial). |
|
| font_size | uint32 | The size of the text (default: 24) (MAX 255). |
|
| bold | bool | Bold text. Set to 1 for bold, 0 for not (default: 1). |
|
| font_color | int32 | The color of the text, in ARGB format (default: White). |
|
| back_color | int32 | The background color, in ARGB format (default: None (transparent)). |
|
| text_alignment | int32 | The alignment of the text (default: left). |
SA-MP Dynamic object data structure.
| Field | Type | Label | Description |
| model | int32 |
|
|
| x | float |
|
|
| y | float |
|
|
| z | float |
|
|
| rx | float |
|
|
| ry | float |
|
|
| rz | float |
|
|
| world_id | int32 | Virtual world id for which object will be visible. Set -1 to be visible for all. |
|
| interior_id | int32 | Interior id for which object will be visible. Set -1 to be visible for all. |
|
| player_id | int32 | SA-MP player id for which object will be visible. Set -1 to be visible for all. |
|
| area_id | int32 | Dynamic area id for which object will be visible. Set -1 to be visible for all. |
|
| stream_distance | float | Default streamer setting is 300.0 |
|
| draw_distance | float | Default streamer setting is 0.0 = default game draw distance |
|
| priority | int32 |
|
|
| estate_id | uint32 |
|
|
| materials | Object.MaterialsEntry | repeated |
|
| material_texts | Object.MaterialTextsEntry | repeated |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | MaterialText |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | Material |
|
Removes a standard San Andreas model for a single player within a specified range.
| Field | Type | Label | Description |
| model | uint32 | The model to remove. |
|
| x | float | The X coordinate around which the objects will be removed. |
|
| y | float | The Y coordinate around which the objects will be removed. |
|
| z | float | The Z coordinate around which the objects will be removed. |
|
| radius | float | The radius around the specified point to remove objects with the specified model. |
|
| estate_id | uint32 | Estate to with removed object belong. |
Request message for rpc `UpdateObject`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| object | Object |
|
Response message for rpc `UpdateObject`.
| Name | Number | Description |
| OBJECT_MATERIAL_SIZE_0 | 0 | |
| OBJECT_MATERIAL_SIZE_32X32 | 10 | |
| OBJECT_MATERIAL_SIZE_64X32 | 20 | |
| OBJECT_MATERIAL_SIZE_64X64 | 30 | |
| OBJECT_MATERIAL_SIZE_128X32 | 40 | |
| OBJECT_MATERIAL_SIZE_128X64 | 50 | |
| OBJECT_MATERIAL_SIZE_128X128 | 60 | |
| OBJECT_MATERIAL_SIZE_256X32 | 70 | |
| OBJECT_MATERIAL_SIZE_256X64 | 80 | |
| OBJECT_MATERIAL_SIZE_256X128 | 90 | |
| OBJECT_MATERIAL_SIZE_256X256 | 100 | |
| OBJECT_MATERIAL_SIZE_512X64 | 110 | |
| OBJECT_MATERIAL_SIZE_512X128 | 120 | |
| OBJECT_MATERIAL_SIZE_512X256 | 130 | |
| OBJECT_MATERIAL_SIZE_512X512 | 140 |
The MruV objects service provides procedures for game objects.
| Method Name | Request Type | Response Type | Description |
| CreateObject | CreateObjectRequest | CreateObjectResponse | Create an object. |
| GetObject | GetObjectRequest | GetObjectResponse | Get an object. |
| UpdateObject | UpdateObjectRequest | UpdateObjectResponse | Update an object. |
| DeleteObject | DeleteObjectRequest | DeleteObjectResponse | Delete an object. |
| AddObjectMaterial | AddObjectMaterialRequest | AddObjectMaterialResponse | Add a material to existing object. |
| GetObjectMaterials | GetObjectMaterialsRequest | GetObjectMaterialsResponse | Get all object materials. |
| DeleteObjectMaterial | DeleteObjectMaterialRequest | DeleteObjectMaterialResponse | Delete a material assigned to an object. |
| AddObjectMaterialText | AddObjectMaterialTextRequest | AddObjectMaterialTextResponse | Add a material text to existing object. |
| GetObjectMaterialTexts | GetObjectMaterialTextsRequest | GetObjectMaterialTextsResponse | Get all object material texts. |
| DeleteObjectMaterialText | DeleteObjectMaterialTextRequest | DeleteObjectMaterialTextResponse | Delete a material text assigned to an object. |
| AddRemoveBuilding | AddRemoveBuildingRequest | AddRemoveBuildingResponse | Removes a object from GTA SA map. |
| GetRemovedBuildings | GetRemovedBuildingsRequest | GetRemovedBuildingsResponse | Get all removed objects. |
| DeleteRemoveBuilding | DeleteRemoveBuildingRequest | DeleteRemoveBuildingResponse | Delete removed buildings. |
| FetchAllObjects | FetchAllObjectsRequest | FetchAllObjectsResponse stream | Fetch all existing objects. |
| Method Name | Method | Pattern | Body |
| CreateObject | POST | /v1/objects | * |
| GetObject | GET | /v1/objects/{id} | |
| UpdateObject | PATCH | /v1/objects/{id} | * |
| DeleteObject | DELETE | /v1/objects/{id} | |
| AddObjectMaterial | PUT | /v1/objects/{object_id}/materials | * |
| GetObjectMaterials | GET | /v1/objects/{object_id}/materials | |
| DeleteObjectMaterial | DELETE | /v1/objects/{object_id}/materials/{index} | |
| AddObjectMaterialText | PUT | /v1/objects/{object_id}/materialTexts | * |
| GetObjectMaterialTexts | GET | /v1/objects/{object_id}/materialTexts | |
| DeleteObjectMaterialText | DELETE | /v1/objects/{object_id}/materialTexts | |
| AddRemoveBuilding | POST | /v1/objects/removed | * |
| GetRemovedBuildings | GET | /v1/objects/removed | |
| DeleteRemoveBuilding | DELETE | /v1/objects/removed/{id} | |
| FetchAllObjects | GET | /v1/objects |
Request message for rpc `AcceptOffer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `AcceptOffer`.
Request message for rpc `CreateOffer`.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
|
| offer | string |
|
|
| end_date | int64 |
|
|
| price | uint32 |
|
|
| offer_type | OfferType |
|
|
| offer_entity_id | uint32 |
|
Response message for rpc `CreateOffer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteOffer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteOffer`.
Request message for rpc `GetOffer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetOffer`.
Request message for rpc `UpdateOffer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateOffer`.
| Name | Number | Description |
| UNKNOWN | 0 |
The MruV offers service.
| Method Name | Request Type | Response Type | Description |
| CreateOffer | CreateOfferRequest | CreateOfferResponse | Create an offer. |
| GetOffer | GetOfferRequest | GetOfferResponse | Get an offer. |
| UpdateOffer | UpdateOfferRequest | UpdateOfferResponse | Update an offer. |
| DeleteOffer | DeleteOfferRequest | DeleteOfferResponse | Delete an offer. |
| AcceptOffer | AcceptOfferRequest | AcceptOfferResponse | Accept an offer and proceed transaction. |
| Method Name | Method | Pattern | Body |
| CreateOffer | POST | /v1/offers | * |
| GetOffer | GET | /v1/offers/{id} | |
| UpdateOffer | PATCH | /v1/offers/{id} | * |
| DeleteOffer | DELETE | /v1/offers/{id} | |
| AcceptOffer | POST | /v1/offers/{id}/accept | * |
Request message for rpc `AssignLeader`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `AssignLeader`.
Request message for rpc `CreateOrganization`.
Response message for rpc `CreateOrganization`.
Request message for rpc `DeleteOrganization`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteOrganization`.
Request message for rpc `GetOrganization`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetOrganization`.
Request message for rpc `UnassignLeader`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UnassignLeader`.
Request message for rpc `UpdateOrganization`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateOrganization`.
The MruV jobs service provides procedures for managing organizations and fractions.
| Method Name | Request Type | Response Type | Description |
| CreateOrganization | CreateOrganizationRequest | CreateOrganizationResponse | Create a organization. |
| GetOrganization | GetOrganizationRequest | GetOrganizationResponse | Get organization. |
| UpdateOrganization | UpdateOrganizationRequest | UpdateOrganizationResponse | Update organization. |
| DeleteOrganization | DeleteOrganizationRequest | DeleteOrganizationResponse | Delete organization. |
| AssignLeader | AssignLeaderRequest | AssignLeaderResponse | Assign an organization leader. Leader is a main administrator of a organization, have all rights to manage organization. If the organization leader already exists, the leader will be overwritten. |
| UnassignLeader | UnassignLeaderRequest | UnassignLeaderResponse |
| Method Name | Method | Pattern | Body |
| CreateOrganization | POST | /v1/organizations | * |
| GetOrganization | GET | /v1/organizations/{id} | |
| UpdateOrganization | PATCH | /v1/organizations/{id} | * |
| DeleteOrganization | DELETE | /v1/organizations/{id} | |
| AssignLeader | PUT | /v1/organizations/{id}/leader | * |
| UnassignLeader | DELETE | /v1/organizations/{id}/leader |
Request message for rpc `CreatePlot`.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
|
| points | mruv.common.Position | repeated |
|
Response message for rpc `CreatePlot`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeletePlot`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeletePlot`.
Request message for rpc `GetPlot`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetPlot`.
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
|
| points | mruv.common.Position | repeated |
|
| area | double |
|
| Field | Type | Label | Description |
| name | string |
|
|
| description | string |
|
|
| points | mruv.common.Position | repeated |
|
Request message for rpc `UpdatePlot`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| name | string |
|
|
| description | string |
|
Response message for rpc `UpdatePlot`.
The MruV plots service provides procedures for managing buildings plots and other areas.
| Method Name | Request Type | Response Type | Description |
| CreatePlot | CreatePlotRequest | CreatePlotResponse | Create a plot. |
| GetPlot | GetPlotRequest | GetPlotResponse | Get a plot. |
| UpdatePlot | UpdatePlotRequest | UpdatePlotResponse | Update a plot. |
| DeletePlot | DeletePlotRequest | DeletePlotResponse | Delete a plot. |
| Method Name | Method | Pattern | Body |
| CreatePlot | POST | /v1/plots | * |
| GetPlot | GET | /v1/plots/{id} | |
| UpdatePlot | PATCH | /v1/plots/{id} | * |
| DeletePlot | DELETE | /v1/plots/{id} |
| Field | Type | Label | Description |
| player | uint32 | A player, that owns a jailed character. |
|
| character | uint32 | Character that has been jailed. |
|
| reason | string | An admin jail reason. |
|
| admin | uint32 | Admin that jail a player. 0 = system jail. |
|
| aj_date | int64 | Date on which an admin jail was issued in Unix time. |
|
| jail_time | uint32 | Time of admin jail in seconds. |
Request message for rpc `AdminJail`.
| Field | Type | Label | Description |
| character | uint32 |
|
|
| time | uint32 | Admin jail time. |
|
| reason | string | Admin jail reason. |
|
| admin | uint32 | Admin that gave an admin jail to a player. |
Response message for rpc `AdminJail`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| character | uint32 |
|
|
| ip | string |
|
|
| expiration_date | int64 | Expiration date in Unix time. |
|
| reason | string | A ban reason. |
|
| admin | uint32 | Admin that banned a player. 0 = system ban. |
|
| ban_date | int64 | Date on which a ban was issued in Unix time. |
|
| active | bool | Ban status. True = active, false = deactivated. |
|
| unban_date | int64 | Date of unban in Unix time. This field is set only when ban was deactivated. |
|
| unban_admin | uint32 | Admin that deactivated this ban. This field is set only when ban was deactivated. |
Request message for rpc `Ban`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| character | uint32 | Player character that was accused. Optional. |
|
| ip | string |
|
|
| time | uint32 | Ban expiration time in days. 0 = permanent ban. |
|
| reason | string | Ban reason. |
|
| admin | uint32 | Admin that banned a player. 0 = system ban. |
Response message for rpc `Ban`.
| Field | Type | Label | Description |
| ban_id | uint32 |
|
| Field | Type | Label | Description |
| player | uint32 | A player, that owns a blocked character. |
|
| character | uint32 | Blocked character. |
|
| reason | string | A block reason. |
|
| admin | uint32 | Admin that blocked a player. 0 = system block. |
|
| block_date | int64 | Date on which a block was issued in Unix time. |
|
| active | bool |
|
|
| unblock_date | int64 | Date of unblock in Unix time. This field is set only when a block was deactivated. |
|
| unblock_admin | uint32 | An admin that unblocked a player. This field is set only when a block was deactivated. |
Request message for rpc `Block`.
| Field | Type | Label | Description |
| character | uint32 |
|
|
| reason | string | Block reason. |
|
| admin | uint32 | Admin that blocked a player. 0 = system ban. |
Response message for rpc `Block`.
| Field | Type | Label | Description |
| block_id | uint32 |
|
Request message for rpc `GetBan`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `GetBlock`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `GetPlayerAdminJail`.
| Field | Type | Label | Description |
| character | uint32 |
|
Response message for rpc `GetPlayerAdminJail`.
| Field | Type | Label | Description |
| jail_time | uint32 | Time of admin jail in seconds. |
|
| reason | string | Admin jail reason. |
|
| admin | uint32 | An admin that put a player in the admin jail. |
|
| date | int64 | Date when the player was thrown into admin jail in Unix time. |
Request message for rpc `GetPlayerBans`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| ip | string |
|
Response message for rpc `GetPlayerBans`.
| Field | Type | Label | Description |
| bans | BanMessage | repeated |
|
Request message for rpc `GetPlayerWarns`.
| Field | Type | Label | Description |
| player | uint32 |
|
Response message for rpc `GetPlayerWarns`.
| Field | Type | Label | Description |
| warns | WarnMessage | repeated |
|
Request message for rpc `GetWarn`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `IsCharacterBlocked`.
| Field | Type | Label | Description |
| character | uint32 |
|
Response message for rpc `IsCharacterBlocked`.
| Field | Type | Label | Description |
| blocked | bool |
|
|
| block_id | uint32 |
|
Request message for rpc `IsCharacterJailed`.
| Field | Type | Label | Description |
| character | uint32 |
|
Response message for rpc `IsCharacterJailed`.
| Field | Type | Label | Description |
| jailed | bool |
|
|
| jail_time | uint32 |
|
Request message for rpc `IsPlayerBanned`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| ip | string |
|
Response message for rpc `IsPlayerBanned`.
| Field | Type | Label | Description |
| banned | bool |
|
|
| ban_id | uint32 |
|
Request message for rpc `MuteGlobalChats`.
| Field | Type | Label | Description |
| account | uint32 |
|
Response message for rpc `MuteGlobalChats`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| character | uint32 |
|
Request message for rpc `UnAdminJail`.
| Field | Type | Label | Description |
| character | uint32 |
|
Response message for rpc `UnAdminJail`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| ban_id | uint32 |
|
Request message for rpc `UnBan`.
| Field | Type | Label | Description |
| ban_id | uint32 |
|
|
| reason | string |
|
Response message for rpc `UnBan`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| block_id | uint32 |
|
Request message for rpc `UnBlock`.
| Field | Type | Label | Description |
| block_id | uint32 |
|
|
| reason | string |
|
Response message for rpc `UnBlock`.
Request message for rpc `UnMuteGlobalChats`.
| Field | Type | Label | Description |
| account | uint32 |
|
Response message for rpc `UnMuteGlobalChats`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| warn_id | uint32 |
|
Request message for rpc `UnWarn`.
| Field | Type | Label | Description |
| warn_id | uint32 |
|
|
| reason | string |
|
Response message for rpc `UnWarn`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| character | uint32 | A character, that was given a warning. |
|
| expiration_date | int64 | Expiration date in Unix time. |
|
| reason | string | A warn reason. |
|
| admin | uint32 | Admin that warned a player. 0 = system warn. |
|
| warn_date | int64 | Date on which a warn was issued in Unix time. |
|
| active | bool | Warn status. True = active, false = deactivated. |
|
| unwarn_date | int64 | Date of unwarn in Unix time. This field is set only when warn was deactivated. |
|
| unwarn_admin | uint32 | Admin that deactivated a warn. This field is set only when warn was deactivated. |
Request message for rpc `Warn`.
| Field | Type | Label | Description |
| player | uint32 |
|
|
| character | uint32 | Player character that was accused. Optional. |
|
| time | uint32 | Warn expiration time in days. 0 = permanent warn. |
|
| reason | string | Warn reason. |
|
| admin | uint32 | Admin that warned player. 0 = system warn. |
Response message for rpc `Warn`.
| Field | Type | Label | Description |
| warn_id | uint32 |
|
Request message for rpc `WatchAdminJails`.
Request message for rpc `WatchBans`.
Request message for rpc `WatchBlocks`.
Request message for rpc `WatchPlayerAcquittals`.
Response message for rpc `WatchPlayerAcquittals`.
Request message for rpc `WatchPlayerPunishments`.
Response message for rpc `WatchPlayerPunishments`.
| Field | Type | Label | Description |
| type | PunishmentType |
|
|
| punishment_id | uint32 |
|
Request message for rpc `WatchPunishments`.
Response message for rpc `WatchPunishments`.
| Field | Type | Label | Description |
| type | PunishmentType |
|
|
| punishment_id | uint32 |
|
|
| player | uint32 |
|
|
| character | uint32 |
|
Request message for rpc `WatchUnAdminJails`.
Request message for rpc `WatchUnBans`.
Request message for rpc `WatchUnBlocks`.
Request message for rpc `WatchUnWarns`.
Request message for rpc `WatchWarns`.
| Name | Number | Description |
| UNKNOWN_ACQUITAL | 0 | |
| UNBAN | 1 | |
| UNBLOCK | 2 | |
| UNWARN | 3 | |
| UN_ADMIN_JAIL | 4 |
| Name | Number | Description |
| UNKNOWN_PUNISHMENT | 0 | |
| BAN | 1 | |
| BLOCK | 2 | |
| WARN | 3 | |
| ADMIN_JAIL | 4 |
This service provides interface for managing punishments for players.
| Method Name | Request Type | Response Type | Description |
| Ban | BanRequest | BanResponse | Ban player on account and/or ip. If ban_time is 0, ban will never expire. |
| Block | BlockRequest | BlockResponse | Block player character. |
| Warn | WarnRequest | WarnResponse | Warn player. If warn_time is 0, warn will never expire. |
| AdminJail | AdminJailRequest | AdminJailResponse | Put player in an admin jail. |
| MuteGlobalChats | MuteGlobalChatsRequest | MuteGlobalChatsResponse | Mute player global chats. |
| UnBan | UnBanRequest | UnBanResponse | Deactivate a specific player ban. |
| UnBlock | UnBlockRequest | UnBlockResponse | Deactivate a character block. |
| UnWarn | UnWarnRequest | UnWarnResponse | Deactivate a specific player warning. If a player was banned by reaching the warning limit, a player will be unbanned. |
| UnAdminJail | UnAdminJailRequest | UnAdminJailResponse | Remove player from admin jail. |
| UnMuteGlobalChats | UnMuteGlobalChatsRequest | UnMuteGlobalChatsResponse | |
| GetPlayerBans | GetPlayerBansRequest | GetPlayerBansResponse | Get all player bans. |
| GetPlayerWarns | GetPlayerWarnsRequest | GetPlayerWarnsResponse | Get all player warns. |
| GetPlayerAdminJail | GetPlayerAdminJailRequest | GetPlayerAdminJailResponse | Get player admin jail time. |
| GetBan | GetBanRequest | BanMessage | Get ban info. |
| GetWarn | GetWarnRequest | WarnMessage | Get warn info. |
| GetBlock | GetBlockRequest | BlockMessage | Get block info. |
| IsPlayerBanned | IsPlayerBannedRequest | IsPlayerBannedResponse | Check is player or ip banned. |
| IsCharacterBlocked | IsCharacterBlockedRequest | IsCharacterBlockedResponse | Check is character is blocked. |
| IsCharacterJailed | IsCharacterJailedRequest | IsCharacterJailedResponse | |
| WatchBans | WatchBansRequest | BanMessage stream | Subscribe to ban events. |
| WatchBlocks | WatchBlocksRequest | BlockMessage stream | Subscribe to block events. |
| WatchWarns | WatchWarnsRequest | WarnMessage stream | Subscribe to warn events. |
| WatchAdminJails | WatchAdminJailsRequest | AdminJailMessage stream | Subscribe to admin jail events. |
| WatchUnBans | WatchUnBansRequest | UnBanMessage stream | Subscribe to unban events. |
| WatchUnBlocks | WatchUnBlocksRequest | UnBlockMessage stream | Subscribe to unblock events. |
| WatchUnWarns | WatchUnWarnsRequest | UnWarnMessage stream | Subscribe to unwarn events. |
| WatchUnAdminJails | WatchUnAdminJailsRequest | UnAdminJailMessage stream | Subscribe to admin jail release events. |
| WatchPlayerPunishments | WatchPlayerPunishmentsRequest | WatchPlayerPunishmentsResponse stream | Subscribe to player punishments. |
| WatchPlayerAcquittals | WatchPlayerAcquittalsRequest | WatchPlayerAcquittalsResponse stream | Subscribe to player acquittals. |
| WatchPunishments | WatchPunishmentsRequest | WatchPunishmentsResponse stream | Subscribe to all punishments and acquittals events. |
| Method Name | Method | Pattern | Body |
| Ban | POST | /v1/punishments/ban/{player} | * |
| Block | POST | /v1/punishments/block/{character} | * |
| Warn | POST | /v1/punishments/warn/{player} | * |
| AdminJail | POST | /v1/punishments/aj/{character} | * |
| MuteGlobalChats | POST | /v1/punishments/mute/{account} | * |
| UnBan | DELETE | /v1/punishments/ban/{ban_id} | |
| UnBlock | DELETE | /v1/punishments/blocks/{block_id} | |
| UnWarn | DELETE | /v1/punishments/warn/{warn_id} | |
| UnAdminJail | DELETE | /v1/punishments/aj/{character} | |
| UnMuteGlobalChats | DELETE | /v1/punishments/mute/{account} | |
| GetPlayerBans | GET | /v1/punishments/bans/{player} | |
| GetPlayerWarns | GET | /v1/punishments/warns/{player} | |
| GetPlayerAdminJail | GET | /v1/punishments/aj/{character} | |
| GetBan | GET | /v1/punishments/bans/{id} | |
| GetWarn | GET | /v1/punishments/warns/{id} | |
| GetBlock | GET | /v1/punishments/blocks/{id} | |
| IsPlayerBanned | GET | /v1/punishments/bans/{player}/{ip} |
Request message for `MruVServerService.GetRegisteredServers`.
Response message for `MruVServerService.GetRegisteredServers`.
| Field | Type | Label | Description |
| servers | ServerInfo | repeated |
|
Server event.
Response message for `MruVServerService.ServerEventsStream`.
| Field | Type | Label | Description |
| type | ServerEvent.ServerEventType | Type of a server event. |
Request message for `MruVServerService.ServerEventsStream`.
| Field | Type | Label | Description |
| id | uint32 | The ID of the server from which we want to receive events. |
Request message for `MruVServerService.UpdateServerStatus`.
| Field | Type | Label | Description |
| id | uint32 | Id of the server. |
|
| status | ServerStatus | Status of the server. |
|
| players | uint32 | How many players are registered on that server. |
Response message for `MruVServerService.UpdateServerStatus`.
Types of server events.
| Name | Number | Description |
| UNKNOWN | 0 | |
| REGISTERED | 1 | |
| SERVER_DOWN | 2 | |
| SERVER_UP | 3 | |
| PLAYERS_CHANGED | 4 |
The MruV server service provides procedures for managing game platform server actions.
| Method Name | Request Type | Response Type | Description |
| RegisterServer | ServerInfo | ServerID | Register instance of server for further managing. |
| GetRegisteredServers | GetRegisteredServersRequest | GetRegisteredServersResponse | Get all registered servers. |
| GetServerInfo | ServerID | ServerInfo | Get game server status. |
| UpdateServerStatus | UpdateServerStatusRequest | UpdateServerStatusResponse | Update game server status. |
| ServerEventsStream | ServerEventsStreamRequest | ServerEvent stream | Stream of server events. Events are streamed back in real-time for chosen server. TODO: Change name to: SubscribeServerEvents |
| Method Name | Method | Pattern | Body |
| RegisterServer | POST | /v1/servers | * |
| GetRegisteredServers | GET | /v1/servers | |
| GetServerInfo | GET | /v1/servers/{id} | |
| UpdateServerStatus | PATCH | /v1/servers/{id}/status | * |
| Field | Type | Label | Description |
| id | uint32 |
|
Data that describe server.
| Field | Type | Label | Description |
| id | uint32 | Id of the server. |
|
| name | string | Short name of the server. |
|
| host | string | Host (ip) of the server. |
|
| port | string | Port of the server. |
|
| platform | string | Platform of the server. |
|
| status | ServerStatus | Status of the server. |
|
| players | uint32 | How many players are playing on the server. |
| Name | Number | Description |
| UNKNOWN | 0 | |
| ON | 1 | |
| OFF | 2 |
Request message for rpc `CreateSpot`.
| Field | Type | Label | Description |
| spot | Spot |
|
Response message for rpc `CreateSpot`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `DeleteSpot`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteSpot`.
Request message for rpc `FetchAllSpots`.
| Field | Type | Label | Description |
| chunk_size | uint32 |
|
Response message for rpc `FetchAllSpots`.
| Field | Type | Label | Description |
| spots | FetchAllSpotsResponse.SpotsEntry | repeated |
|
| Field | Type | Label | Description |
| key | uint32 |
|
|
| value | Spot |
|
Request message for rpc `GetSpot`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetSpot`.
| Field | Type | Label | Description |
| spot | Spot |
|
Spot.
| Field | Type | Label | Description |
| name | string |
|
|
| message | string |
|
|
| icon | int32 |
|
|
| marker | int32 |
|
|
| x | float |
|
|
| y | float |
|
|
| z | float |
|
|
| vw | int32 |
|
|
| int | int32 |
|
Request message for rpc `UpdateSpot`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| spot | Spot |
|
Response message for rpc `UpdateSpot`.
The MruV spots service provides procedures for managing spots.
| Method Name | Request Type | Response Type | Description |
| CreateSpot | CreateSpotRequest | CreateSpotResponse | Create a spot. |
| GetSpot | GetSpotRequest | GetSpotResponse | Get a spot. |
| UpdateSpot | UpdateSpotRequest | UpdateSpotResponse | Update a spot. |
| DeleteSpot | DeleteSpotRequest | DeleteSpotResponse | Delete a spot. |
| FetchAll | FetchAllSpotsRequest | FetchAllSpotsResponse stream | Fetch all spots. |
| Method Name | Method | Pattern | Body |
| CreateSpot | POST | /v1/spots | * |
| GetSpot | GET | /v1/spots/{id} | |
| UpdateSpot | PATCH | /v1/spots/{id} | * |
| DeleteSpot | DELETE | /v1/spots/{id} |
Request message for rpc `CreateServer`.
| Field | Type | Label | Description |
| owner_id | uint32 |
|
Response message for rpc `CreateServer`.
| Field | Type | Label | Description |
| id | uint32 |
|
|
| port | uint32 |
|
Request message for rpc `DeleteServer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteServer`.
Request message for rpc `GetServers`.
Response message for rpc `GetServers`.
| Field | Type | Label | Description |
| id | uint32 | repeated |
|
Request message for rpc `MyServer`.
Response message for rpc `MyServer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Request message for rpc `TransferOwnership`.
| Field | Type | Label | Description |
| server_id | uint32 |
|
|
| owner_id | uint32 |
|
Response message for rpc `TransferOwnership`.
Service to manage texture studio servers cluster.
| Method Name | Request Type | Response Type | Description |
| CreateServer | CreateServerRequest | CreateServerResponse | Create a new texture studio server. |
| GetServers | GetServersRequest | GetServersResponse | Get all existing servers |
| MyServer | MyServerRequest | MyServerResponse | Get texture studio server id for current user. |
| TransferOwnership | TransferOwnershipRequest | TransferOwnershipResponse | Change owner of texture studio server. |
| DeleteServer | DeleteServerRequest | DeleteServerResponse | Delete a texture studio server. |
| Method Name | Method | Pattern | Body |
| CreateServer | POST | /v1/texturestudio/servers | * |
| GetServers | GET | /v1/texturestudio/servers | |
| MyServer | GET | /v1/texturestudio/servers/my | |
| TransferOwnership | PATCH | /v1/texturestudio/servers/{server_id} | * |
| DeleteServer | DELETE | /v1/texturestudio/servers/{id} |
Request message for rpc `GetProject`.
| Field | Type | Label | Description |
| server_id | uint32 |
|
|
| name | string |
|
Response message for rpc `GetProject`.
| Field | Type | Label | Description |
| code | string |
|
Request message for rpc `GetProjects`.
| Field | Type | Label | Description |
| server_id | uint32 |
|
Response message for rpc `GetProjects`.
| Field | Type | Label | Description |
| names | string | repeated |
|
Request message for rpc `RestartServer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `RestartServer`.
Request message for rpc `ServerStatus`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `ServerStatus`.
| Field | Type | Label | Description |
| port | uint32 |
|
|
| status | ServerStatus |
|
Request message for rpc `StartServer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `StartServer`.
Request message for rpc `StopServer`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `StopServer`.
Request message for rpc `SubscribeToProjectsChanges`.
| Field | Type | Label | Description |
| server_id | uint32 |
|
Response message for rpc `SubscribeToProjectsChanges`.
| Field | Type | Label | Description |
| name | string |
|
Request message for rpc `UploadProject`.
| Field | Type | Label | Description |
| server_id | uint32 |
|
|
| project_name | string |
|
|
| code | string |
|
|
| file | bytes |
|
Response message for rpc `UploadProject`.
| Name | Number | Description |
| UNKNOWN_STATUS | 0 | |
| ON | 1 | |
| OFF | 2 |
Service to manage texture studio server.
| Method Name | Request Type | Response Type | Description |
| StartServer | StartServerRequest | StartServerResponse | Start a texture studio server. |
| StopServer | StopServerRequest | StopServerResponse | Stop a texture studio server. |
| RestartServer | RestartServerRequest | RestartServerResponse | Restart a texture studio server. |
| ServerStatus | ServerStatusRequest | ServerStatusResponse | Get texture studio server status. |
| UploadProject | UploadProjectRequest | UploadProjectResponse | Upload project to texture studio. |
| GetProject | GetProjectRequest | GetProjectResponse | Get texture-studio objects project. |
| GetProjects | GetProjectsRequest | GetProjectsResponse | Get all projects. |
| SubscribeToProjectsChanges | SubscribeToProjectsChangesRequest | SubscribeToProjectsChangesResponse stream | Listen for project changes - if texture studio project has been created or modified, this will trigger an event. |
| Method Name | Method | Pattern | Body |
| StartServer | POST | /v1/texturestudio/server/{id}/start | * |
| StopServer | POST | /v1/texturestudio/server/{id}/stop | * |
| RestartServer | POST | /v1/texturestudio/server/{id}/restart | * |
| ServerStatus | GET | /v1/texturestudio/server/{id}/status | |
| UploadProject | POST | /v1/texturestudio/server/{server_id}/projects | * |
| GetProject | GET | /v1/texturestudio/server/{server_id}/projects/{name} | |
| GetProjects | GET | /v1/texturestudio/server/{server_id}/projects |
Request message for rpc `CreateVehicle`.
Response message for rpc `CreateVehicle`.
Request message for rpc `DeleteVehicle`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `DeleteVehicle`.
Request message for rpc `GetVehicle`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `GetVehicle`.
Request message for rpc `UpdateVehicle`.
| Field | Type | Label | Description |
| id | uint32 |
|
Response message for rpc `UpdateVehicle`.
The MruV vehicles service provides procedures for managing vehicles.
| Method Name | Request Type | Response Type | Description |
| CreateVehicle | CreateVehicleRequest | CreateVehicleResponse | Create a vehicle. |
| GetVehicle | GetVehicleRequest | GetVehicleResponse | Get a vehicle. |
| UpdateVehicle | UpdateVehicleRequest | UpdateVehicleResponse | Update a vehicle. |
| DeleteVehicle | DeleteVehicleRequest | DeleteVehicleResponse | Delete a vehicle. |
| Method Name | Method | Pattern | Body |
| CreateVehicle | POST | /v1/vehicles | * |
| GetVehicle | GET | /v1/vehicles/{id} | |
| UpdateVehicle | PATCH | /v1/vehicles/{id} | * |
| DeleteVehicle | DELETE | /v1/vehicles/{id} |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| 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) |


Mesoscale atmospheric modeling
Environmental and Earth Science Thrust Area
Coordinator
Eugene
S. Takle
3010 Agronomy Hall
Iowa State University
Ames, Ia 50011
Tel:<PHONE_NUMBER>
Fax:<PHONE_NUMBER>
email<EMAIL_ADDRESS>Thrust Area Plan
Current Research Projects
Information on Mesoscale Modeling at ISU
Mesoscale Weather Computer Based Information
United States Meteorological Information
International Meteorlogical Information
Return to IITAP home
page