rename

Documentation

Overview

Package rename contains protocol buffer definitions for the rename DFHack plugin.

See https://dfhack.readthedocs.io/en/latest/docs/Plugins.html#rename for more details.

Index

• func CallRenameBuilding(client *dfhackrpc.Client, request *RenameBuildingIn) (dfhackrpc.CommandResult, error)
• func CallRenameSquad(client *dfhackrpc.Client, request *RenameSquadIn) (dfhackrpc.CommandResult, error)
• func CallRenameUnit(client *dfhackrpc.Client, request *RenameUnitIn) (dfhackrpc.CommandResult, error)
• type RenameBuildingIn
  • func (*RenameBuildingIn) Descriptor() ([]byte, []int)
  • func (m *RenameBuildingIn) GetBuildingId() int32
  • func (m *RenameBuildingIn) GetName() string
  • func (*RenameBuildingIn) ProtoMessage()
  • func (m *RenameBuildingIn) Reset()
  • func (m *RenameBuildingIn) String() string
  • func (m *RenameBuildingIn) XXX_DiscardUnknown()
  • func (m *RenameBuildingIn) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *RenameBuildingIn) XXX_Merge(src proto.Message)
  • func (m *RenameBuildingIn) XXX_Size() int
  • func (m *RenameBuildingIn) XXX_Unmarshal(b []byte) error
• type RenameSquadIn
  • func (*RenameSquadIn) Descriptor() ([]byte, []int)
  • func (m *RenameSquadIn) GetAlias() string
  • func (m *RenameSquadIn) GetNickname() string
  • func (m *RenameSquadIn) GetSquadId() int32
  • func (*RenameSquadIn) ProtoMessage()
  • func (m *RenameSquadIn) Reset()
  • func (m *RenameSquadIn) String() string
  • func (m *RenameSquadIn) XXX_DiscardUnknown()
  • func (m *RenameSquadIn) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *RenameSquadIn) XXX_Merge(src proto.Message)
  • func (m *RenameSquadIn) XXX_Size() int
  • func (m *RenameSquadIn) XXX_Unmarshal(b []byte) error
• type RenameUnitIn
  • func (*RenameUnitIn) Descriptor() ([]byte, []int)
  • func (m *RenameUnitIn) GetNickname() string
  • func (m *RenameUnitIn) GetProfession() string
  • func (m *RenameUnitIn) GetUnitId() int32
  • func (*RenameUnitIn) ProtoMessage()
  • func (m *RenameUnitIn) Reset()
  • func (m *RenameUnitIn) String() string
  • func (m *RenameUnitIn) XXX_DiscardUnknown()
  • func (m *RenameUnitIn) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (dst *RenameUnitIn) XXX_Merge(src proto.Message)
  • func (m *RenameUnitIn) XXX_Size() int
  • func (m *RenameUnitIn) XXX_Unmarshal(b []byte) error

Functions

func CallRenameBuilding

func CallRenameBuilding(client *dfhackrpc.Client, request *RenameBuildingIn) (dfhackrpc.CommandResult, error)

CallRenameBuilding is a convenience wrapper around the rename::RenameBuilding RPC method.

func CallRenameSquad

func CallRenameSquad(client *dfhackrpc.Client, request *RenameSquadIn) (dfhackrpc.CommandResult, error)

CallRenameSquad is a convenience wrapper around the rename::RenameSquad RPC method.

func CallRenameUnit

func CallRenameUnit(client *dfhackrpc.Client, request *RenameUnitIn) (dfhackrpc.CommandResult, error)

CallRenameUnit is a convenience wrapper around the rename::RenameUnit RPC method.

Types

type RenameBuildingIn

type RenameBuildingIn struct {
	BuildingId           *int32   `protobuf:"varint,1,req,name=building_id,json=buildingId" json:"building_id,omitempty"`
	Name                 *string  `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RPC RenameBuilding : RenameBuildingIn -> EmptyMessage

func (*RenameBuildingIn) Descriptor

func (*RenameBuildingIn) Descriptor() ([]byte, []int)

func (*RenameBuildingIn) GetBuildingId

func (m *RenameBuildingIn) GetBuildingId() int32

func (*RenameBuildingIn) GetName

func (m *RenameBuildingIn) GetName() string

func (*RenameBuildingIn) ProtoMessage

func (*RenameBuildingIn) ProtoMessage()

func (*RenameBuildingIn) Reset

func (m *RenameBuildingIn) Reset()

func (*RenameBuildingIn) String

func (m *RenameBuildingIn) String() string

func (*RenameBuildingIn) XXX_DiscardUnknown

func (m *RenameBuildingIn) XXX_DiscardUnknown()

func (*RenameBuildingIn) XXX_Marshal

func (m *RenameBuildingIn) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RenameBuildingIn) XXX_Merge

func (dst *RenameBuildingIn) XXX_Merge(src proto.Message)

func (*RenameBuildingIn) XXX_Size

func (m *RenameBuildingIn) XXX_Size() int

func (*RenameBuildingIn) XXX_Unmarshal

func (m *RenameBuildingIn) XXX_Unmarshal(b []byte) error

type RenameSquadIn

type RenameSquadIn struct {
	SquadId              *int32   `protobuf:"varint,1,req,name=squad_id,json=squadId" json:"squad_id,omitempty"`
	Nickname             *string  `protobuf:"bytes,2,opt,name=nickname" json:"nickname,omitempty"`
	Alias                *string  `protobuf:"bytes,3,opt,name=alias" json:"alias,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RPC RenameSquad : RenameSquadIn -> EmptyMessage

func (*RenameSquadIn) Descriptor

func (*RenameSquadIn) Descriptor() ([]byte, []int)

func (*RenameSquadIn) GetAlias

func (m *RenameSquadIn) GetAlias() string

func (*RenameSquadIn) GetNickname

func (m *RenameSquadIn) GetNickname() string

func (*RenameSquadIn) GetSquadId

func (m *RenameSquadIn) GetSquadId() int32

func (*RenameSquadIn) ProtoMessage

func (*RenameSquadIn) ProtoMessage()

func (*RenameSquadIn) Reset

func (m *RenameSquadIn) Reset()

func (*RenameSquadIn) String

func (m *RenameSquadIn) String() string

func (*RenameSquadIn) XXX_DiscardUnknown

func (m *RenameSquadIn) XXX_DiscardUnknown()

func (*RenameSquadIn) XXX_Marshal

func (m *RenameSquadIn) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RenameSquadIn) XXX_Merge

func (dst *RenameSquadIn) XXX_Merge(src proto.Message)

func (*RenameSquadIn) XXX_Size

func (m *RenameSquadIn) XXX_Size() int

func (*RenameSquadIn) XXX_Unmarshal

func (m *RenameSquadIn) XXX_Unmarshal(b []byte) error

type RenameUnitIn

type RenameUnitIn struct {
	UnitId               *int32   `protobuf:"varint,1,req,name=unit_id,json=unitId" json:"unit_id,omitempty"`
	Nickname             *string  `protobuf:"bytes,2,opt,name=nickname" json:"nickname,omitempty"`
	Profession           *string  `protobuf:"bytes,3,opt,name=profession" json:"profession,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RPC RenameUnit : RenameUnitIn -> EmptyMessage

func (*RenameUnitIn) Descriptor

func (*RenameUnitIn) Descriptor() ([]byte, []int)

func (*RenameUnitIn) GetNickname

func (m *RenameUnitIn) GetNickname() string

func (*RenameUnitIn) GetProfession

func (m *RenameUnitIn) GetProfession() string

func (*RenameUnitIn) GetUnitId

func (m *RenameUnitIn) GetUnitId() int32

func (*RenameUnitIn) ProtoMessage

func (*RenameUnitIn) ProtoMessage()

func (*RenameUnitIn) Reset

func (m *RenameUnitIn) Reset()

func (*RenameUnitIn) String

func (m *RenameUnitIn) String() string

func (*RenameUnitIn) XXX_DiscardUnknown

func (m *RenameUnitIn) XXX_DiscardUnknown()

func (*RenameUnitIn) XXX_Marshal

func (m *RenameUnitIn) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RenameUnitIn) XXX_Merge

func (dst *RenameUnitIn) XXX_Merge(src proto.Message)

func (*RenameUnitIn) XXX_Size

func (m *RenameUnitIn) XXX_Size() int

func (*RenameUnitIn) XXX_Unmarshal

func (m *RenameUnitIn) XXX_Unmarshal(b []byte) error