models

Documentation

Index

• Constants
• type ActionDepositBank
• type ActionDepositBankResponse
• type ActionMove
• type ActionWithdrawBank
• type ActiveEvent
• type BankDepositResponse
• type BankInventoryParams
• type BankInventoryResponse
• type BlockedHits
• type CancelTask
• type Character
• type CharacterFight
• type CharacterFightData
• type CharacterGathering
• type CharacterGatheringResponse
• type CharacterMovement
• type CharacterMovementResponse
• type CharacterRecyclingResponse
• type CharacterResponse
• type Content
• type Cooldown
• type CraftInformation
• type CraftingDetails
• type CreateCharacter
• type CreateTask
• type Credentials
• type Destination
• type EventResponse
• type Fight
• type GetAllEventsQueryParameters
• type GetAllItemsQueryParameters
• type GrandExchangeItemDetail
• type InventorySlot
• type Item
• type ItemDetails
• type ItemEffect
• type ItemResponse
• type ItemsResponse
• type ListItemParameters
• type MapContent
• type MapSchema
• type RecyclingItemsResponse
• type RecyclingResponse
• type Task
• type WithdrawBank
• type WithdrawBankResponse

Constants

const (
	AshTree                  string = "ash_tree"
	AshTeeX                  int    = 6
	AshTreeY                 int    = 1
	Bank                     string = "bank"
	BankX                    int    = 4
	BankY                    int    = 1
	SouthBank                string = "south_bank"
	SouthBankX               int    = 7
	SouthBankY               int    = 13
	Bass                     string = "bass"
	BassLevel                int    = 30
	BassX                    int    = 6
	BassY                    int    = 12
	BirchTree                string = "birch_tree"
	BirchTreeLevel           int    = 20
	BirchTreeX               int    = 3
	BirchTreeY               int    = 5
	Crafting                 string = "crafting"
	CoalLevel                int    = 20
	Coal                     string = "coal_rocks"
	CoalX                    int    = 1
	CoalY                    int    = 6
	CookingWorkshop          string = "cooking_workshop"
	CookingWorkshopX         int    = 1
	CookingWorkshopY         int    = 1
	Copper                   string = "copper_ore"
	CopperX                  int    = 2
	CopperY                  int    = 0
	Combat                   string = "combat"
	DeadTree                 string = "dead_tree"
	DeadTreeLevel            int    = 30
	DeadTreeX                int    = 9
	DeadTreeY                int    = 8
	ForgeWorkshop            string = "forge_workshop"
	GearcraftingWorkshop     string = "gearcrafting_workshop"
	GearcraftingWorkshopX    int    = 3
	GearcraftingWorkshopY    int    = 1
	Gudgeon                  string = "gudgeon"
	GudgeonX                 int    = 4
	GudgeonY                 int    = 2
	GoldLevel                int    = 30
	Gold                     string = "gold_rocks"
	GoldX                    int    = 10
	GoldY                    int    = -4
	InventorySize            int    = 100
	ItemTypeConsumable       string = ""
	ItemTypeBodyArmor        string = ""
	IronLevel                int    = 10
	Iron                     string = "iron_rocks"
	IronX                    int    = 1
	IronY                    int    = 7
	JewelrycraftingWorkshop  string = "jewelrycrafting_workshop"
	JewelrycraftingWorkshopX int    = 1
	JewelrycraftingWorkshopY int    = 3
	MiningWorkshop           string = "mining_workshop"
	MiningWorkshopX          int    = 1
	MiningWorkshopY          int    = 5
	MagicTree                string = "magic_tree"
	Shrimp                   string = "shrimp"
	ShrimpLevel              int    = 10
	ShrimpX                  int    = 5
	ShrimpY                  int    = 2
	SpruceTree               string = "spruce_tree"
	SpruceTreeLevel          int    = 10
	SpruceTreeX              int    = 2
	SpruceTreeY              int    = 6
	StrangeRocks             string = "strange_rocks"
	Trout                    string = "trout"
	TroutLevel               int    = 20
	TroutX                   int    = 7
	TroutY                   int    = 12
	ItemRetrieved            string = "item_retrieved"
	TaskCancelled            string = "task_cancelled"
	TaskCreated              string = "task_created"
	TaskRetrieved            string = "task_retrieved"
	WeaponcraftingWorkshop   string = "weaponcrafting_workshop"
	WeaponcraftingWorkshopX  int    = 2
	WeaponcraftingWorkshopY  int    = 1
	WoodcuttingWorkshop      string = "woodcutting_workshop"
	WoodcuttingWorkshopX     int    = -2
	WoodcuttingWorkshopY     int    = -3
)

const (
	TaskStatusCancelled = "cancelled"
	TaskStatusPending   = "pending"
	TaskStatusRunning   = "running"
	TaskStatusSuccess   = "success"
	TaskStatusError     = "error"
)

Types

type ActionDepositBank

type ActionDepositBank struct {
	Code     string `json:"code"`
	Quantity int    `json:"quantity"`
}

type ActionDepositBankResponse

type ActionDepositBankResponse struct {
	Data BankDepositResponse `json:"data"`
}

type ActionMove

type ActionMove struct {
	X int `json:"x"`
	Y int `json:"y"`
}

type ActionWithdrawBank

type ActionWithdrawBank struct {
	Code     string `json:"code"`
	Quantity int    `json:"quantity"`
}

type ActiveEvent

type ActiveEvent struct {
	Name         string    `json:"name"`
	Map          MapSchema `json:"map"`
	PreviousSkin string    `json:"previous_skin"`
	Duration     int       `json:"duration"`
	Expiration   time.Time `json:"expiration"`
	CreatedAt    time.Time `json:"created_at"`
}

type BankDepositResponse

type BankDepositResponse struct {
	Cooldown  Cooldown    `json:"cooldown"`
	Item      ItemDetails `json:"item"`
	Bank      []Item      `json:"bank"`
	Character Character   `json:"character"`
}

type BankInventoryParams

type BankInventoryParams struct {
	ItemCode string `json:"itemCode"`
	Page     int    `json:"page"`
	Size     int    `json:"size"`
}

type BankInventoryResponse

type BankInventoryResponse struct {
	Data  []Item `json:"data"`
	Total int    `json:"total"`
	Page  int    `json:"page"`
	Size  int    `json:"size"`
	Pages int    `json:"pages"`
}

type BlockedHits

type BlockedHits struct {
	Fire  int `json:"fire"`
	Earth int `json:"earth"`
	Water int `json:"water"`
	Air   int `json:"air"`
	Total int `json:"total"`
}

type CancelTask

type CancelTask struct {
	Reason string `json:"reason"`
}

type Character

type Character struct {
	Name                    string          `json:"name"`
	Skin                    string          `json:"skin"`
	Level                   int             `json:"level"`
	XP                      int             `json:"xp"`
	MaxXp                   int             `json:"max_xp"`
	TotalXp                 int             `json:"total_xp"`
	Gold                    int             `json:"gold"`
	Speed                   int             `json:"speed"`
	MiningLevel             int             `json:"mining_level"`
	MiningXp                int             `json:"mining_xp"`
	MiningMaxXp             int             `json:"mining_max_xp"`
	WoodcuttingLevel        int             `json:"woodcutting_level"`
	WoodcuttingMaxXp        int             `json:"woodcutting_max_xp"`
	FishingLevel            int             `json:"fishing_level"`
	FishingXp               int             `json:"fishing_xp"`
	FishingMaxXp            int             `json:"fishing_max_xp"`
	WeaponCraftingLevel     int             `json:"weaponcrafting_level"`
	WeaponCraftingXp        int             `json:"weaponcrafting_xp"`
	WeaponCraftingMaxXp     int             `json:"weaponcrafting_max_xp"`
	GearCraftingLevel       int             `json:"gearcrafting_level"`
	GearCraftingXp          int             `json:"gearcrafting_xp"`
	GearCraftingMaxXp       int             `json:"gearcrafting_max_xp"`
	JewelryCraftingLevel    int             `json:"jewelrycrafting_level"`
	JewelryCraftingXp       int             `json:"jewelrycrafting_xp"`
	JewelryCraftingMaxXp    int             `json:"jewelrycrafting_max_xp"`
	CookingLevel            int             `json:"cooking_level"`
	CookingXp               int             `json:"cooking_xp"`
	CookingMaxXp            int             `json:"cooking_max_xp"`
	Hp                      int             `json:"hp"`
	Haste                   int             `json:"haste"`
	CriticalStrike          int             `json:"critical_strike"`
	Stamina                 int             `json:"stamina"`
	AttackFire              int             `json:"attack_fire"`
	AttackEarth             int             `json:"attack_earth"`
	AttackWater             int             `json:"attack_water"`
	AttackAir               int             `json:"attack_air"`
	DmgFire                 int             `json:"dmg_fire"`
	DmgEarth                int             `json:"dmg_earth"`
	DmgWater                int             `json:"dmg_water"`
	DmgAir                  int             `json:"dmg_air"`
	ResFire                 int             `json:"res_fire"`
	ResEarth                int             `json:"res_earth"`
	ResWater                int             `json:"res_water"`
	ResAir                  int             `json:"res_air"`
	X                       int             `json:"x"`
	Y                       int             `json:"y"`
	Cooldown                int             `json:"cooldown"`
	CooldownExpiration      time.Time       `json:"cooldown_expiration"`
	WeaponSlot              string          `json:"weapon_slot"`
	ShieldSlot              string          `json:"shield_slot"`
	HelmetSlot              string          `json:"helmet_slot"`
	BodyArmorSlot           string          `json:"body_armor_slot"`
	LegArmorSlot            string          `json:"leg_armor_slot"`
	BootsSlot               string          `json:"boots_slot"`
	Ring1Slot               string          `json:"ring1_slot"`
	Ring2Slot               string          `json:"ring2_slot"`
	AmuletSlot              string          `json:"amulet_slot"`
	Artifact1Slot           string          `json:"artifact1_slot"`
	Artifact2Slot           string          `json:"artifact2_slot"`
	Artifact3Slot           string          `json:"artifact3_slot"`
	Consumable1Slot         string          `json:"consumable1_slot"`
	Consumable1SlotQuantity int             `json:"consumable1_slot_quantity"`
	Consumable2Slot         string          `json:"consumable2_slot"`
	Consumable2SlotQuantity int             `json:"consumable2_slot_quantity"`
	Task                    string          `json:"task"`
	TaskType                string          `json:"task_type"`
	TaskProgress            int             `json:"task_progress"`
	TaskTotal               int             `json:"task_total"`
	InventoryMaxItems       int             `json:"inventory_max_items"`
	Inventory               []InventorySlot `json:"inventory"`
}

type CharacterFight

type CharacterFight struct {
	Cooldown  Cooldown  `json:"cooldown"`
	Fight     Fight     `json:"fight"`
	Character Character `json:"character"`
}

type CharacterFightData

type CharacterFightData struct {
	Data CharacterFight `json:"data"`
}

type CharacterGathering

type CharacterGathering struct {
	Cooldown  Cooldown        `json:"cooldown"`
	Details   CraftingDetails `json:"details"`
	Character Character       `json:"character"`
}

type CharacterGatheringResponse

type CharacterGatheringResponse struct {
	Data CharacterGathering `json:"data"`
}

type CharacterMovement

type CharacterMovement struct {
	Cooldown    Cooldown    `json:"cooldown"`
	Destination Destination `json:"destination"`
	Character   Character   `json:"character"`
}

type CharacterMovementResponse

type CharacterMovementResponse struct {
	Data CharacterMovement `json:"data"`
}

type CharacterRecyclingResponse

type CharacterRecyclingResponse struct {
	Data RecyclingResponse `json:"data"`
}

type CharacterResponse

type CharacterResponse struct {
	Data Character `json:"data"`
}

type Content

type Content struct {
	Name string `json:"name"`
	X    int    `json:"x"`
	Y    int    `json:"y"`
}

type Cooldown

type Cooldown struct {
	TotalSeconds     int       `json:"total_seconds"`
	RemainingSeconds int       `json:"remaining_seconds"`
	StartedAt        time.Time `json:"started_at"`
	Expiration       time.Time `json:"expiration"`
	Reason           string    `json:"reason"`
}

type CraftInformation

type CraftInformation struct {
	Skill    string `bson:"skill,omitempty" json:"skill,omitempty"`
	Level    int    `bson:"level,omitempty" json:"level,omitempty"`
	Items    []Item `bson:"items,omitempty" json:"items,omitempty"`
	Quantity int    `bson:"quantity,omitempty" json:"quantity,omitempty"`
}

type CraftingDetails

type CraftingDetails struct {
	Xp    int    `json:"xp"`
	Items []Item `json:"items"`
}

type CreateCharacter

type CreateCharacter struct {
	Name string `json:"name"`
	Skin string `json:"skin"`
}

type CreateTask

type CreateTask struct {
	Action         string `json:"action,omitempty"`
	ActionCategory string `json:"actionCategory"`
	Monster        string `json:"monster,omitempty"`
	Item           string `json:"item,omitempty"`
	Quantity       int    `json:"quantity"`
	Character      string `json:"character"`
}

type Credentials

type Credentials struct {
	CharacterName string `json:"characterName"`
	Token         string `json:"token"`
}

type Destination

type Destination struct {
	Name    string  `json:"name"`
	Skin    string  `json:"skin"`
	X       int     `json:"x"`
	Y       int     `json:"y"`
	Content Content `json:"content,omitempty"`
}

type EventResponse

type EventResponse struct {
	Data  []ActiveEvent `json:"data"`
	Total int           `json:"total"`
	Page  int           `json:"page"`
	Size  int           `json:"size"`
	Pages int           `json:"pages"`
}

type Fight

type Fight struct {
	Xp                 int         `json:"xp"`
	Gold               int         `json:"gold"`
	Drops              []Item      `json:"drops"`
	Turns              int         `json:"turns"`
	MonsterBlockedHits BlockedHits `json:"monster_blocked_hits"`
	PlayerBlockedHits  BlockedHits `json:"player_blocked_hits"`
	Logs               []string    `json:"logs"`
	Result             string      `json:"result"`
}

type GetAllEventsQueryParameters

type GetAllEventsQueryParameters struct {
	Page int `json:"page"`
	Size int `json:"size"`
}

type GetAllItemsQueryParameters

type GetAllItemsQueryParameters struct {
	CraftMaterial string `json:"craft_material"`
	CraftSkill    string `json:"craft_skill"`
	MaxLevel      int    `json:"max_level"`
	MinLevel      int    `json:"min_level"`
	Name          string `json:"name"`
	Page          int    `json:"page"`
	Size          int    `json:"size"`
	Type          string `json:"type"`
}

type GrandExchangeItemDetail

type GrandExchangeItemDetail struct {
	Code      string `json:"code"`
	Stock     int    `json:"stock"`
	SellPrice int    `json:"sell_price"`
	BuyPrice  int    `json:"buy_price"`
}

type InventorySlot

type InventorySlot struct {
	Slot     int    `json:"slot"`
	Code     string `json:"code"`
	Quantity int    `json:"quantity"`
}

type Item

type Item struct {
	Code     string `bson:"code" json:"code"`
	Quantity int    `bson:"quantity" json:"quantity"`
}

type ItemDetails

type ItemDetails struct {
	Name        string           `bson:"name" json:"name"`
	Code        string           `bson:"code" json:"code"`
	Level       int              `bson:"level" json:"level"`
	Type        string           `bson:"type" json:"type"`
	SubType     string           `bson:"subType" json:"subType"`
	Description string           `bson:"description" json:"description"`
	Effects     []ItemEffect     `bson:"effects,omitempty" json:"effects,omitempty"`
	Craft       CraftInformation `bson:"craft,omitempty" json:"craft,omitempty"`
}

type ItemEffect

type ItemEffect struct {
	Name  string `bson:"name" json:"name"`
	Value int    `bson:"value" json:"value"`
}

type ItemResponse

type ItemResponse struct {
	Data ItemDetails             `json:"data"`
	Ge   GrandExchangeItemDetail `json:"ge,omitempty"`
}

type ItemsResponse

type ItemsResponse struct {
	Data  []ItemDetails `json:"data"`
	Total int           `json:"total"`
	Page  int           `json:"page"`
	Size  int           `json:"size"`
	Pages int           `json:"pages"`
}

type ListItemParameters

type ListItemParameters struct {
	Type    string `json:"type"`
	SubType string `json:"subtype"`
	Level   int    `json:"level"`
}

type MapContent

type MapContent struct {
	Type string `json:"type"`
	Code string `json:"code"`
}

type MapSchema

type MapSchema struct {
	Name    string     `json:"name"`
	Skin    string     `json:"skin"`
	X       int        `json:"x"`
	Y       int        `json:"y"`
	Content MapContent `json:"content"`
}

type RecyclingItemsResponse

type RecyclingItemsResponse struct {
	Items []Item `json:"items"`
}

type RecyclingResponse

type RecyclingResponse struct {
	Cooldown  Cooldown               `json:"cooldown"`
	Details   RecyclingItemsResponse `json:"details"`
	Character Character              `json:"character"`
}

type Task

type Task struct {
	Id                string `bson:"_id" json:"id"`
	Action            string `bson:"action,omitempty" json:"action,omitempty"`
	ActionCategory    string `bson:"actionCategory" json:"actionCategory"`
	Item              string `bson:"item,omitempty" json:"item,omitempty"`
	Monster           string `bson:"monster,omitempty" json:"monster,omitempty"`
	Quantity          int    `bson:"quantity" json:"quantity"`
	QuantityCompleted int    `bson:"quantityCompleted" json:"quantityCompleted"`
	Status            string `bson:"status" json:"status"`
	ErrorReason       string `bson:"errorReason" json:"errorReason"`
	Character         string `bson:"character" json:"character"`
}

type WithdrawBank

type WithdrawBank struct {
	Cooldown  Cooldown    `json:"cooldown"`
	Item      ItemDetails `json:"item"`
	Bank      []Item      `json:"bank"`
	Character Character   `json:"character"`
}

type WithdrawBankResponse

type WithdrawBankResponse struct {
	Data WithdrawBank `json:"data"`
}