Documentation ¶
Overview ¶
Package isoworldremote contains protocol buffer definitions for the isoworldremote DFHack plugin.
See https://dfhack.readthedocs.io/en/latest/docs/Plugins.html#isoworldremote for more details.
Index ¶
- Variables
- type BasicMaterial
- type BasicShape
- type ColorDefinition
- func (*ColorDefinition) Descriptor() ([]byte, []int)
- func (m *ColorDefinition) GetBlue() int32
- func (m *ColorDefinition) GetGreen() int32
- func (m *ColorDefinition) GetRed() int32
- func (*ColorDefinition) ProtoMessage()
- func (m *ColorDefinition) Reset()
- func (m *ColorDefinition) String() string
- func (m *ColorDefinition) XXX_DiscardUnknown()
- func (m *ColorDefinition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *ColorDefinition) XXX_Merge(src proto.Message)
- func (m *ColorDefinition) XXX_Size() int
- func (m *ColorDefinition) XXX_Unmarshal(b []byte) error
- type EmbarkTile
- func (*EmbarkTile) Descriptor() ([]byte, []int)
- func (m *EmbarkTile) GetCurrentSeason() int32
- func (m *EmbarkTile) GetCurrentYear() int32
- func (m *EmbarkTile) GetIsValid() bool
- func (m *EmbarkTile) GetTileLayer() []*EmbarkTileLayer
- func (m *EmbarkTile) GetWorldX() int32
- func (m *EmbarkTile) GetWorldY() int32
- func (m *EmbarkTile) GetWorldZ() int32
- func (*EmbarkTile) ProtoMessage()
- func (m *EmbarkTile) Reset()
- func (m *EmbarkTile) String() string
- func (m *EmbarkTile) XXX_DiscardUnknown()
- func (m *EmbarkTile) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *EmbarkTile) XXX_Merge(src proto.Message)
- func (m *EmbarkTile) XXX_Size() int
- func (m *EmbarkTile) XXX_Unmarshal(b []byte) error
- type EmbarkTileLayer
- func (*EmbarkTileLayer) Descriptor() ([]byte, []int)
- func (m *EmbarkTileLayer) GetMatSubtypeTable() []int32
- func (m *EmbarkTileLayer) GetMatTypeTable() []BasicMaterial
- func (m *EmbarkTileLayer) GetTileColorTable() []*ColorDefinition
- func (m *EmbarkTileLayer) GetTileShapeTable() []BasicShape
- func (*EmbarkTileLayer) ProtoMessage()
- func (m *EmbarkTileLayer) Reset()
- func (m *EmbarkTileLayer) String() string
- func (m *EmbarkTileLayer) XXX_DiscardUnknown()
- func (m *EmbarkTileLayer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *EmbarkTileLayer) XXX_Merge(src proto.Message)
- func (m *EmbarkTileLayer) XXX_Size() int
- func (m *EmbarkTileLayer) XXX_Unmarshal(b []byte) error
- type LiquidType
- type MapReply
- func (*MapReply) Descriptor() ([]byte, []int)
- func (m *MapReply) GetAvailable() bool
- func (m *MapReply) GetCurrentSeason() int32
- func (m *MapReply) GetCurrentYear() int32
- func (m *MapReply) GetRegionSizeX() int32
- func (m *MapReply) GetRegionSizeY() int32
- func (m *MapReply) GetRegionX() int32
- func (m *MapReply) GetRegionY() int32
- func (*MapReply) ProtoMessage()
- func (m *MapReply) Reset()
- func (m *MapReply) String() string
- func (m *MapReply) XXX_DiscardUnknown()
- func (m *MapReply) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *MapReply) XXX_Merge(src proto.Message)
- func (m *MapReply) XXX_Size() int
- func (m *MapReply) XXX_Unmarshal(b []byte) error
- type MapRequest
- func (*MapRequest) Descriptor() ([]byte, []int)
- func (m *MapRequest) GetSaveFolder() string
- func (*MapRequest) ProtoMessage()
- func (m *MapRequest) Reset()
- func (m *MapRequest) String() string
- func (m *MapRequest) XXX_DiscardUnknown()
- func (m *MapRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *MapRequest) XXX_Merge(src proto.Message)
- func (m *MapRequest) XXX_Size() int
- func (m *MapRequest) XXX_Unmarshal(b []byte) error
- type RawNames
- func (*RawNames) Descriptor() ([]byte, []int)
- func (m *RawNames) GetAvailable() bool
- func (m *RawNames) GetInorganic() []string
- func (m *RawNames) GetOrganic() []string
- func (*RawNames) ProtoMessage()
- func (m *RawNames) Reset()
- func (m *RawNames) String() string
- func (m *RawNames) XXX_DiscardUnknown()
- func (m *RawNames) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *RawNames) XXX_Merge(src proto.Message)
- func (m *RawNames) XXX_Size() int
- func (m *RawNames) XXX_Unmarshal(b []byte) error
- type TileRequest
- func (*TileRequest) Descriptor() ([]byte, []int)
- func (m *TileRequest) GetWantX() int32
- func (m *TileRequest) GetWantY() int32
- func (*TileRequest) ProtoMessage()
- func (m *TileRequest) Reset()
- func (m *TileRequest) String() string
- func (m *TileRequest) XXX_DiscardUnknown()
- func (m *TileRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *TileRequest) XXX_Merge(src proto.Message)
- func (m *TileRequest) XXX_Size() int
- func (m *TileRequest) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var BasicMaterial_name = map[int32]string{
0: "AIR",
1: "OTHER",
2: "INORGANIC",
3: "LIQUID",
4: "PLANT",
5: "WOOD",
}
View Source
var BasicMaterial_value = map[string]int32{
"AIR": 0,
"OTHER": 1,
"INORGANIC": 2,
"LIQUID": 3,
"PLANT": 4,
"WOOD": 5,
}
View Source
var BasicShape_name = map[int32]string{
0: "NONE",
1: "OPEN",
3: "WALL",
4: "FLOOR",
5: "RAMP_UP",
6: "RAMP_DOWN",
}
View Source
var BasicShape_value = map[string]int32{
"NONE": 0,
"OPEN": 1,
"WALL": 3,
"FLOOR": 4,
"RAMP_UP": 5,
"RAMP_DOWN": 6,
}
View Source
var LiquidType_name = map[int32]string{
0: "ICE",
1: "WATER",
2: "MAGMA",
}
View Source
var LiquidType_value = map[string]int32{
"ICE": 0,
"WATER": 1,
"MAGMA": 2,
}
Functions ¶
This section is empty.
Types ¶
type BasicMaterial ¶
type BasicMaterial int32
const ( BasicMaterial_AIR BasicMaterial = 0 BasicMaterial_OTHER BasicMaterial = 1 BasicMaterial_INORGANIC BasicMaterial = 2 BasicMaterial_LIQUID BasicMaterial = 3 BasicMaterial_PLANT BasicMaterial = 4 BasicMaterial_WOOD BasicMaterial = 5 )
func (BasicMaterial) Enum ¶
func (x BasicMaterial) Enum() *BasicMaterial
func (BasicMaterial) EnumDescriptor ¶
func (BasicMaterial) EnumDescriptor() ([]byte, []int)
func (BasicMaterial) String ¶
func (x BasicMaterial) String() string
func (*BasicMaterial) UnmarshalJSON ¶
func (x *BasicMaterial) UnmarshalJSON(data []byte) error
type BasicShape ¶
type BasicShape int32
const ( BasicShape_NONE BasicShape = 0 BasicShape_OPEN BasicShape = 1 BasicShape_WALL BasicShape = 3 BasicShape_FLOOR BasicShape = 4 BasicShape_RAMP_UP BasicShape = 5 BasicShape_RAMP_DOWN BasicShape = 6 )
func (BasicShape) Enum ¶
func (x BasicShape) Enum() *BasicShape
func (BasicShape) EnumDescriptor ¶
func (BasicShape) EnumDescriptor() ([]byte, []int)
func (BasicShape) String ¶
func (x BasicShape) String() string
func (*BasicShape) UnmarshalJSON ¶
func (x *BasicShape) UnmarshalJSON(data []byte) error
type ColorDefinition ¶
type ColorDefinition struct { Red *int32 `protobuf:"varint,1,req,name=red" json:"red,omitempty"` Green *int32 `protobuf:"varint,2,req,name=green" json:"green,omitempty"` Blue *int32 `protobuf:"varint,3,req,name=blue" json:"blue,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*ColorDefinition) Descriptor ¶
func (*ColorDefinition) Descriptor() ([]byte, []int)
func (*ColorDefinition) GetBlue ¶
func (m *ColorDefinition) GetBlue() int32
func (*ColorDefinition) GetGreen ¶
func (m *ColorDefinition) GetGreen() int32
func (*ColorDefinition) GetRed ¶
func (m *ColorDefinition) GetRed() int32
func (*ColorDefinition) ProtoMessage ¶
func (*ColorDefinition) ProtoMessage()
func (*ColorDefinition) Reset ¶
func (m *ColorDefinition) Reset()
func (*ColorDefinition) String ¶
func (m *ColorDefinition) String() string
func (*ColorDefinition) XXX_DiscardUnknown ¶
func (m *ColorDefinition) XXX_DiscardUnknown()
func (*ColorDefinition) XXX_Marshal ¶
func (m *ColorDefinition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ColorDefinition) XXX_Merge ¶
func (dst *ColorDefinition) XXX_Merge(src proto.Message)
func (*ColorDefinition) XXX_Size ¶
func (m *ColorDefinition) XXX_Size() int
func (*ColorDefinition) XXX_Unmarshal ¶
func (m *ColorDefinition) XXX_Unmarshal(b []byte) error
type EmbarkTile ¶
type EmbarkTile struct { WorldX *int32 `protobuf:"varint,1,req,name=world_x,json=worldX" json:"world_x,omitempty"` WorldY *int32 `protobuf:"varint,2,req,name=world_y,json=worldY" json:"world_y,omitempty"` WorldZ *int32 `protobuf:"zigzag32,3,req,name=world_z,json=worldZ" json:"world_z,omitempty"` TileLayer []*EmbarkTileLayer `protobuf:"bytes,4,rep,name=tile_layer,json=tileLayer" json:"tile_layer,omitempty"` CurrentYear *int32 `protobuf:"varint,5,opt,name=current_year,json=currentYear" json:"current_year,omitempty"` CurrentSeason *int32 `protobuf:"varint,6,opt,name=current_season,json=currentSeason" json:"current_season,omitempty"` IsValid *bool `protobuf:"varint,7,opt,name=is_valid,json=isValid" json:"is_valid,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func CallGetEmbarkTile ¶
func CallGetEmbarkTile(client *dfhackrpc.Client, request *TileRequest) (*EmbarkTile, dfhackrpc.CommandResult, error)
CallGetEmbarkTile is a convenience wrapper around the isoworldremote::GetEmbarkTile RPC method.
func (*EmbarkTile) Descriptor ¶
func (*EmbarkTile) Descriptor() ([]byte, []int)
func (*EmbarkTile) GetCurrentSeason ¶
func (m *EmbarkTile) GetCurrentSeason() int32
func (*EmbarkTile) GetCurrentYear ¶
func (m *EmbarkTile) GetCurrentYear() int32
func (*EmbarkTile) GetIsValid ¶
func (m *EmbarkTile) GetIsValid() bool
func (*EmbarkTile) GetTileLayer ¶
func (m *EmbarkTile) GetTileLayer() []*EmbarkTileLayer
func (*EmbarkTile) GetWorldX ¶
func (m *EmbarkTile) GetWorldX() int32
func (*EmbarkTile) GetWorldY ¶
func (m *EmbarkTile) GetWorldY() int32
func (*EmbarkTile) GetWorldZ ¶
func (m *EmbarkTile) GetWorldZ() int32
func (*EmbarkTile) ProtoMessage ¶
func (*EmbarkTile) ProtoMessage()
func (*EmbarkTile) Reset ¶
func (m *EmbarkTile) Reset()
func (*EmbarkTile) String ¶
func (m *EmbarkTile) String() string
func (*EmbarkTile) XXX_DiscardUnknown ¶
func (m *EmbarkTile) XXX_DiscardUnknown()
func (*EmbarkTile) XXX_Marshal ¶
func (m *EmbarkTile) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EmbarkTile) XXX_Merge ¶
func (dst *EmbarkTile) XXX_Merge(src proto.Message)
func (*EmbarkTile) XXX_Size ¶
func (m *EmbarkTile) XXX_Size() int
func (*EmbarkTile) XXX_Unmarshal ¶
func (m *EmbarkTile) XXX_Unmarshal(b []byte) error
type EmbarkTileLayer ¶
type EmbarkTileLayer struct { MatTypeTable []BasicMaterial `` /* 134-byte string literal not displayed */ MatSubtypeTable []int32 `protobuf:"varint,5,rep,packed,name=mat_subtype_table,json=matSubtypeTable" json:"mat_subtype_table,omitempty"` TileShapeTable []BasicShape `` /* 137-byte string literal not displayed */ TileColorTable []*ColorDefinition `protobuf:"bytes,7,rep,name=tile_color_table,json=tileColorTable" json:"tile_color_table,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*EmbarkTileLayer) Descriptor ¶
func (*EmbarkTileLayer) Descriptor() ([]byte, []int)
func (*EmbarkTileLayer) GetMatSubtypeTable ¶
func (m *EmbarkTileLayer) GetMatSubtypeTable() []int32
func (*EmbarkTileLayer) GetMatTypeTable ¶
func (m *EmbarkTileLayer) GetMatTypeTable() []BasicMaterial
func (*EmbarkTileLayer) GetTileColorTable ¶
func (m *EmbarkTileLayer) GetTileColorTable() []*ColorDefinition
func (*EmbarkTileLayer) GetTileShapeTable ¶
func (m *EmbarkTileLayer) GetTileShapeTable() []BasicShape
func (*EmbarkTileLayer) ProtoMessage ¶
func (*EmbarkTileLayer) ProtoMessage()
func (*EmbarkTileLayer) Reset ¶
func (m *EmbarkTileLayer) Reset()
func (*EmbarkTileLayer) String ¶
func (m *EmbarkTileLayer) String() string
func (*EmbarkTileLayer) XXX_DiscardUnknown ¶
func (m *EmbarkTileLayer) XXX_DiscardUnknown()
func (*EmbarkTileLayer) XXX_Marshal ¶
func (m *EmbarkTileLayer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EmbarkTileLayer) XXX_Merge ¶
func (dst *EmbarkTileLayer) XXX_Merge(src proto.Message)
func (*EmbarkTileLayer) XXX_Size ¶
func (m *EmbarkTileLayer) XXX_Size() int
func (*EmbarkTileLayer) XXX_Unmarshal ¶
func (m *EmbarkTileLayer) XXX_Unmarshal(b []byte) error
type LiquidType ¶
type LiquidType int32
const ( LiquidType_ICE LiquidType = 0 LiquidType_WATER LiquidType = 1 LiquidType_MAGMA LiquidType = 2 )
func (LiquidType) Enum ¶
func (x LiquidType) Enum() *LiquidType
func (LiquidType) EnumDescriptor ¶
func (LiquidType) EnumDescriptor() ([]byte, []int)
func (LiquidType) String ¶
func (x LiquidType) String() string
func (*LiquidType) UnmarshalJSON ¶
func (x *LiquidType) UnmarshalJSON(data []byte) error
type MapReply ¶
type MapReply struct { Available *bool `protobuf:"varint,1,req,name=available" json:"available,omitempty"` RegionX *int32 `protobuf:"varint,2,opt,name=region_x,json=regionX" json:"region_x,omitempty"` RegionY *int32 `protobuf:"varint,3,opt,name=region_y,json=regionY" json:"region_y,omitempty"` RegionSizeX *int32 `protobuf:"varint,4,opt,name=region_size_x,json=regionSizeX" json:"region_size_x,omitempty"` RegionSizeY *int32 `protobuf:"varint,5,opt,name=region_size_y,json=regionSizeY" json:"region_size_y,omitempty"` CurrentYear *int32 `protobuf:"varint,6,opt,name=current_year,json=currentYear" json:"current_year,omitempty"` CurrentSeason *int32 `protobuf:"varint,7,opt,name=current_season,json=currentSeason" json:"current_season,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
RPC GetEmbarkInfo : MapRequest -> MapReply
func CallGetEmbarkInfo ¶
func CallGetEmbarkInfo(client *dfhackrpc.Client, request *MapRequest) (*MapReply, dfhackrpc.CommandResult, error)
CallGetEmbarkInfo is a convenience wrapper around the isoworldremote::GetEmbarkInfo RPC method.
func (*MapReply) Descriptor ¶
func (*MapReply) GetAvailable ¶
func (*MapReply) GetCurrentSeason ¶
func (*MapReply) GetCurrentYear ¶
func (*MapReply) GetRegionSizeX ¶
func (*MapReply) GetRegionSizeY ¶
func (*MapReply) GetRegionX ¶
func (*MapReply) GetRegionY ¶
func (*MapReply) ProtoMessage ¶
func (*MapReply) ProtoMessage()
func (*MapReply) XXX_DiscardUnknown ¶
func (m *MapReply) XXX_DiscardUnknown()
func (*MapReply) XXX_Marshal ¶
func (*MapReply) XXX_Unmarshal ¶
type MapRequest ¶
type MapRequest struct { SaveFolder *string `protobuf:"bytes,1,opt,name=save_folder,json=saveFolder" json:"save_folder,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*MapRequest) Descriptor ¶
func (*MapRequest) Descriptor() ([]byte, []int)
func (*MapRequest) GetSaveFolder ¶
func (m *MapRequest) GetSaveFolder() string
func (*MapRequest) ProtoMessage ¶
func (*MapRequest) ProtoMessage()
func (*MapRequest) Reset ¶
func (m *MapRequest) Reset()
func (*MapRequest) String ¶
func (m *MapRequest) String() string
func (*MapRequest) XXX_DiscardUnknown ¶
func (m *MapRequest) XXX_DiscardUnknown()
func (*MapRequest) XXX_Marshal ¶
func (m *MapRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MapRequest) XXX_Merge ¶
func (dst *MapRequest) XXX_Merge(src proto.Message)
func (*MapRequest) XXX_Size ¶
func (m *MapRequest) XXX_Size() int
func (*MapRequest) XXX_Unmarshal ¶
func (m *MapRequest) XXX_Unmarshal(b []byte) error
type RawNames ¶
type RawNames struct { Available *bool `protobuf:"varint,1,req,name=available" json:"available,omitempty"` Inorganic []string `protobuf:"bytes,2,rep,name=inorganic" json:"inorganic,omitempty"` Organic []string `protobuf:"bytes,3,rep,name=organic" json:"organic,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
RPC GetRawNames : MapRequest -> RawNames
func CallGetRawNames ¶
func CallGetRawNames(client *dfhackrpc.Client, request *MapRequest) (*RawNames, dfhackrpc.CommandResult, error)
CallGetRawNames is a convenience wrapper around the isoworldremote::GetRawNames RPC method.
func (*RawNames) Descriptor ¶
func (*RawNames) GetAvailable ¶
func (*RawNames) GetInorganic ¶
func (*RawNames) GetOrganic ¶
func (*RawNames) ProtoMessage ¶
func (*RawNames) ProtoMessage()
func (*RawNames) XXX_DiscardUnknown ¶
func (m *RawNames) XXX_DiscardUnknown()
func (*RawNames) XXX_Marshal ¶
func (*RawNames) XXX_Unmarshal ¶
type TileRequest ¶
type TileRequest struct { WantX *int32 `protobuf:"varint,1,opt,name=want_x,json=wantX" json:"want_x,omitempty"` WantY *int32 `protobuf:"varint,2,opt,name=want_y,json=wantY" json:"want_y,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
RPC GetEmbarkTile : TileRequest -> EmbarkTile
func (*TileRequest) Descriptor ¶
func (*TileRequest) Descriptor() ([]byte, []int)
func (*TileRequest) GetWantX ¶
func (m *TileRequest) GetWantX() int32
func (*TileRequest) GetWantY ¶
func (m *TileRequest) GetWantY() int32
func (*TileRequest) ProtoMessage ¶
func (*TileRequest) ProtoMessage()
func (*TileRequest) Reset ¶
func (m *TileRequest) Reset()
func (*TileRequest) String ¶
func (m *TileRequest) String() string
func (*TileRequest) XXX_DiscardUnknown ¶
func (m *TileRequest) XXX_DiscardUnknown()
func (*TileRequest) XXX_Marshal ¶
func (m *TileRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TileRequest) XXX_Merge ¶
func (dst *TileRequest) XXX_Merge(src proto.Message)
func (*TileRequest) XXX_Size ¶
func (m *TileRequest) XXX_Size() int
func (*TileRequest) XXX_Unmarshal ¶
func (m *TileRequest) XXX_Unmarshal(b []byte) error
Click to show internal directories.
Click to hide internal directories.