model

type AnimationID int

type AttackStyle int

type Boundary uint8

type ChatColor int

type ChatEffect int

type ChatMessage struct {
	Color  ChatColor
	Effect ChatEffect
	Text   string
}

type ChatMode int

type ClientTab int

type Color struct {
	Red   int
	Green int
	Blue  int
}

type Direction int

type Entity struct {
	// ID is the globally unique identifier for the entity.
	ID int
	// GlobalPos is the position of the entity in global coordinates.
	GlobalPos Vector3D
}

type EntityAppearance struct {
	// Base is the base model appearance.
	Base EntityBase
	// NPCAppearance is a flag that indicates if the entity assumes a predefined NPC appearance.
	NPCAppearance int
	// Equipment is a map of equipment slots to the items equipped at those slots.
	Equipment map[EquipmentSlotType]*EquipmentSlot
	// BodyColors is a slice of color codes for each body part.
	BodyColors []int
	// Animations is a map of animation types to their animation sequence IDs.
	Animations map[AnimationID]int
	// GraphicID is the ID of a graphic the player assumes, or -1 if none.
	GraphicID int
	// GraphicHeight is the height offset from the ground where the graphic should be rendered.
	GraphicHeight int
	// GraphicDelay is the amount of game ticks to wait before initially displaying the graphic.
	GraphicDelay int
	// Gender is the entity's gender.
	Gender EntityGender
	// OverheadIconID is the ID of the graphic to use for an overhead icon.
	OverheadIconID int
	// CombatLevel is the entity's combat level.
	CombatLevel int
	// TotalLevel is the entity's total skill level.
	TotalLevel int
}

type EntityBase struct {
	Head  int
	Face  int
	Body  int
	Arms  int
	Hands int
	Legs  int
	Feet  int
}

type EntityCombatAttributes struct {
	Stab  int
	Slash int
	Crush int
	Magic int
	Range int
}

type EntityCombatStats struct {
	Attack   EntityCombatAttributes
	Defense  EntityCombatAttributes
	Strength int
	Prayer   int
}

type EntityGender int

type EquipmentSlot struct {
	SlotType EquipmentSlotType
	Item     *Item
	Amount   int
}

type EquipmentSlotType int

type FriendsListStatus int

type InteractionMode int

type Interface struct {
	// ID is the identifier for this interface.
	ID int
	// Parent is the parent interface.
	Parent *Interface
	// Children is a slice of child interfaces.
	Children []*Interface
	// Type is the type of interface.
	Type int
	// Actions is a slice of actions that this interface supports.
	Actions []string
	// Conditions is a slice of conditions for this interface.
	Conditions []InterfaceCondition
	// OpCodes is a map of op codes to their sub codes
	OpCodes map[int][]int
}

type InterfaceCondition struct {
	Type  int
	Value int
}

type InventorySlot struct {
	// ID is the identifier of the inventory slot.
	ID int
	// Item is a pointer to a model.Item in this slot.
	Item *Item
	// Amount is the stack size of the item in this slot.
	Amount int
}

type Item struct {
	ID             int
	Name           string
	Description    string
	Rotation       Vector3D
	Scale          Vector3D
	Stackable      bool
	MembersOnly    bool
	NoteID         int
	NoteTemplateID int
	TeamID         int
	GroundActions  []string
	Actions        []string
	Stackables     []ItemStackable
	Attributes     *ItemAttributes
}

type ItemAttributes struct {
	// ItemID is the ID of the item.
	ItemID int
	// Nature describes the uses for the item.
	Nature ItemNature
	// EquipSlotType is the equipment slot where the item is equipped to.
	EquipSlotType EquipmentSlotType
	// WeaponStyle is the set of attack options for a weapon item.
	WeaponStyle WeaponStyle
	// Speed is the amount of milliseconds between item actions.
	Speed int
	// Weight is the weight of the item.
	Weight float32
	// Value is the value of the item, in coins.
	Value int
	// AttackBonuses are the offensive combat attributes.
	Attack ItemCombatAttributes
	// DefenseBonuses are the defensive combat attributes.
	Defense ItemCombatAttributes
	// StrengthBonus is the bonus granted to an entity's strength level.
	StrengthBonus int
	// PrayerBonus is the bonus granted to an entity's prayer level.
	PrayerBonus int
}

type ItemCombatAttributes struct {
	Stab  int
	Slash int
	Crush int
	Magic int
	Range int
}

type ItemNature int

type ItemStackable struct {
	ID     int
	Amount int
}

type Map struct {
	// Tiles are stored in (z, x, y) coordinates.
	Tiles map[int]map[int]map[int]*Tile
	// RegionOrigins enumerate all region origins in global coordinates that are on the map.
	RegionOrigins []Vector3D
	// MaxTile is the position of the tile the furthest on the x- and y-axes.
	MaxTile Vector2D
}

type MovementSpeed int

type NPC struct {
	*Entity
	// DefinitionID is the identifier for the NPC's appearance.
	DefinitionID int
	// ScriptSlug is the slug for the game script to execute for this NPC.
	ScriptSlug string
}

type Player struct {
	*Entity
	// Username is the player's display name.
	Username string
	// PasswordHash is the player's hashed password.
	PasswordHash string
	// Type determines the level of access this player is granted.
	Type PlayerType
	// Flagged is true when the player is suspected of cheating, false if not.
	Flagged bool
	// Appearance is the player's model appearance.
	Appearance EntityAppearance
	// AutoRetaliate controls if the player automatically responds to combat.
	AutoRetaliate bool
	// Modes determine what level of chat and trade interaction the player has configured.
	Modes PlayerModes
	// Muted is true when the player is not able to chat, false if not.
	Muted bool
	// Friends is a slice of usernames of players added as friends.
	Friends []string
	// Ignored is a slice of usernames of players that are ignored.
	Ignored []string
	// Skills is a map of this player's skill levels and experience.
	Skills SkillMap
	// Member is true when the player has an active subscription, false if not.
	Member bool
	// MemberDays is the number of days of subscription remaining.
	MemberDays int
	// Inventory is the player's current inventory of items.
	Inventory [MaxInventorySlots]*InventorySlot
	// CombatStats are the player's combat statistics.
	CombatStats EntityCombatStats
	// AttackStyles if a map of the player's preferred attack styles for a given weapon style.
	AttackStyles map[WeaponStyle]AttackStyle
	// GameOptions is a map of client/game option IDs to their values.
	GameOptions map[int]string
	// RunEnergy is the player's run energy.
	RunEnergy int
	// QuestStatus is a map of quest IDs to their status.
	QuestStatuses map[int]QuestStatus
	// QuestFlags is a map of quest IDs to maps of their flag IDs to values.
	QuestFlags map[int]map[int]int
	// MusicTracks is a map of song IDs to flags indicating if the player has unlocked them.
	MusicTracks map[int]bool
	// UpdateDesign is true when the player should be shown the character design interface, false if not.
	UpdateDesign bool
	// MovementSpeed determines if the player is moving by walking or running
	MovementSpeed MovementSpeed
	// PrayerDrainCounter is the player's current usage of activated prayer drain points.
	PrayerDrainCounter int
	// ActivePrayers is a map of prayer IDs and drain effects for prayers that are currently active on the player.
	ActivePrayers map[int]int
	// HitpointsRegenRate is the amount of hitpoints recovered after each interval.
	HitpointsRegenRate int
	// StatRegenRate is the amount of stat levels for non-hitpoints skills recovered after each interval.
	StatRegenRate int
}

type PlayerChangeEvent int

type PlayerModes struct {
	// PublicChat is the player's public chat interaction setting.
	PublicChat ChatMode
	// PrivateChat is the player's public chat interaction setting.
	PrivateChat ChatMode
	// Interaction is the player's trade/duel request interaction setting.
	Interaction InteractionMode
}

type PlayerType int

type QuestStatus int

type Rectangle struct {
	X1 int
	Y1 int
	X2 int
	Y2 int
}

type Skill struct {
	// Type is the unique identifier for the skill.
	Type SkillType
	// StatLevel is the current, effective level for the skill modified by (de)buffs.
	StatLevel int
	// BaseLevel is the skill's level based on experience points.
	BaseLevel int
	// Experience is the number of experience points gained in the skill.
	Experience float64
}

type SkillMap map[SkillType]*Skill

type SkillType int

type Tile struct {
	Height     int
	OverlayID  int
	RenderFlag int
	UnderlayID int
	// contains filtered or unexported fields
}

type TileGroundItem struct {
	InstanceUUID uuid.UUID
	ItemID       int
	Amount       int
}

type Vector2D struct {
	X int
	Y int
}

type Vector3D struct {
	X int
	Y int
	Z int
}

type WeaponStyle int

type WorldObject struct {
	ID              int
	Description     string
	Name            string
	Walkable        bool
	Actions         []string
	UnwalkableSolid bool
	Translation     Vector3D
	Size            Vector2D
	Scale           Vector3D
	FaceID          int
	MapSceneID      int
	Shadowless      bool
	Rotated         bool
	OffsetAmplified bool
	AdjustToTerrain bool
	DelayedShading  bool
	HasActions      bool
	Solid           bool
	Wall            bool
	Static          bool
	VariableID      int
	ConfigID        int
	ChildIDs        []int
}