Player - uosagas/assistant GitHub Wiki

Here is the documentation for the Player class, adapted to Lua, similar to the format you provided for the Mobiles class:

Overview

Player.Say(message[, hue[, type[, font]]])
Player.SayParty(message)
Player.SayGuild(message)
Player.SayAlliance(message)
Player.SayWhisper(message)
Player.SayYell(message)
Player.SayChat(message)
Player.SayEmote(message)
Player.UseObject(serial)
Player.UseObjectByType(type)
Player.ClickObject(serial)
Player.Attack(serial)
Player.ToggleFly()
Player.ClearHands(command)
Player.Turn(direction)
Player.Equip(serial)
Player.PickUp(serial)
Player.DropInBackpack()
Player.DropInContainer(serial)
Player.ToggleWarMode()
Player.PopPouch()

Attributes

Attribute	Type	Description
`X`	`Integer`	The x-coordinate of the game object's position.
`Y`	`Integer`	The y-coordinate of the game object's position.
`Z`	`Integer`	The z-coordinate of the game object's position.
`Hue`	`Integer`	The hue or color of the game object.
`Graphic`	`Integer`	The graphic ID representing the game object.
`Name`	`String`	The name of the entity.
`Serial`	`Integer`	The unique serial number of the entity.
`Distance`	`Integer`	The distance of the entity from the player.
`Direction`	`String`	The direction the entity is facing (e.g., North, South).
`IsDestroyed`	`Boolean`	Indicates whether the entity is destroyed.
`Hits`	`Integer`	The current health of the mobile.
`HitsMax`	`Integer`	The maximum health of the mobile.
`DiffHits`	`Integer`	The difference between the mobile's maximum and current health.
`Stamina (Stam)`	`Integer`	The current stamina of the mobile.
`MaxStam`	`Integer`	The maximum stamina of the mobile.
`Mana`	`Integer`	The current mana of the mobile.
`MaxMana`	`Integer`	The maximum mana of the mobile.
`IsRunning`	`Boolean`	Indicates whether the mobile is running.
`IsParalyzed`	`Boolean`	Indicates whether the mobile is paralyzed.
`IsDead`	`Boolean`	Indicates whether the mobile is dead.
`IsHidden`	`Boolean`	Indicates whether the mobile is hidden.
`IsPoisoned`	`Boolean`	Indicates whether the mobile is poisoned.
`IsMounted`	`Boolean`	Indicates whether the mobile is mounted.
`IsFlying`	`Boolean`	Indicates whether the mobile is flying.
`IsHuman`	`Boolean`	Indicates whether the mobile is human.
`IsGargoyle`	`Boolean`	Indicates whether the mobile is a gargoyle.
`IsYellowHits`	`Boolean`	Indicates whether the mobile's health bar is yellow.
`IsRenamable`	`Boolean`	Indicates whether the mobile can be renamed.
`IsFemale`	`Boolean`	Indicates whether the mobile is female.
`IgnoreCharacters`	`Boolean`	Indicates whether the mobile ignores other characters.
`NotorietyFlag`	`String`	The notoriety flag of the mobile (e.g., criminal).
`Race`	`String`	The race of the mobile (e.g., human, elf).
`Title`	`String`	The title or profession of the mobile.
`SpeedMode`	`String`	The speed mode of the mobile.
`PhysicalResistance`	`Integer`	The player's physical resistance.
`FireResistance`	`Integer`	The player's fire resistance.
`ColdResistance`	`Integer`	The player's cold resistance.
`PoisonResistance`	`Integer`	The player's poison resistance.
`EnergyResistance`	`Integer`	The player's energy resistance.
`Str`	`Integer`	The player's strength.
`Dex`	`Integer`	The player's dexterity.
`Int`	`Integer`	The player's intelligence.
`DamageMin`	`Integer`	The player's minimum combat damage.
`DamageMax`	`Integer`	The player's maximum combat damage.
`Followers`	`Integer`	The number of creatures currently following the player.
`MaxFollowers`	`Integer`	The maximum number of creatures that can follow the player.
`Gold`	`Integer`	The amount of gold the player has.
`Luck`	`Integer`	The player's luck.
`TithingPoints`	`Integer`	The player's tithing points.
`Weight`	`Integer`	The player's current weight.
`MaxWeight`	`Integer`	The player's maximum weight.
`DiffWeight`	`Integer`	The difference between the player's maximum and current weight.
`StatsCap`	`Integer`	The total cap for the player's stats.
`SwingSpeedIncrease`	`Integer`	Bonus to the player's weapon swing speed.
`HitPointsRegeneration`	`Integer`	The rate of the player's health regeneration.
`ManaRegeneration`	`Integer`	The rate of the player's mana regeneration.
`StaminaRegeneration`	`Integer`	The rate of the player's stamina regeneration.
`LowerManaCost`	`Integer`	Reduction in mana cost for the player.
`LowerReagentCost`	`Integer`	Reduction in reagent cost for the player.
`HitChanceIncrease`	`Integer`	Bonus to the player's hit chance.
`DefenseChanceIncrease`	`Integer`	Bonus to the player's defense chance.
`SpellDamageIncrease`	`Integer`	Bonus to the player's spell damage.
`ReflectPhysicalDamage`	`Integer`	The percentage of physical damage reflected by the player.
`Backpack`	`Item`	Item representation of the player's backpack.

Example

Messages.Print('Location of myself is x:'..Player.X..' y:'..Player.Y)

Say

Player.Say(message[, hue[, type[, font]]])

Parameters
message: String value representing the message to say
hue: Optional numeric value representing the hue (default: regular hue)
type: Optional numeric value representing the message type (default: regular message type)
font: Optional numeric value representing the font (default: regular font)