Project Hoshimi Documented Class Library
Bot Class
NamespacesPH.CommonBot
Base class (abstract) for all bots.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class Bot : BotTypeBase
Public MustInherit Class Bot _
	Inherits BotTypeBase
public ref class Bot abstract : public BotTypeBase
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
Bot()()()
Constructor. In the constructor, Game Engine read and validate characteristics of the bot. It create too a unique Guid for it.

BotInfo
Informations about the bot.

BotType
return the type of the bot.
(Overrides BotTypeBase.BotType.)
CollectTransfertSpeed
Number of OXY transfered while collecting or transfering in one turn.

Constitution
Number of hit points of the bot when it is created.

ContainerCapacity
Maximum number of OXY this bot can carry

DefenseDistance
Maximum distance of a defense. If bot try to defend greater than this value, defense is not valid (and canceled)

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
ForceAutoDestruction()()()
Allow you to destroy your bot directly

GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HitPoint
Number of hit points of the bot. If equal or less than 0, it is destroyed.

ID
Unique ID for this bot (you can identify it with this Guid)

InternalName
Name used by the Viewer to show the name of the bot

Location
Point on the map where is located the bot

MaxDamage
Maximum numbers of damage of defense in one turn. Number of damage is determined randomly by the Game Engine at each turn of a defense. This number is between 0 and MaxDamage.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
PlayerID
ID of the Player

PlayerOwner
Reference to the Player instance owner of this bot

PointInfo
Point used for different operation. While moving, it is the point at the end of the movement. While defending, it is the point where it shoot. While Transfering, it must be the location of the Needle where it want to tranfer OXY. While Collecting, it must be the point where OXY Landing point is.

Scan
Scan distance. If an enemie is nearer than this value, it is seen by this bot (and added to the OtherbotsInfo property of the Player)

Shield
Intensity of the shield of the bot.

State
State of the bot

Stock
Number of OXY in its container.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks

[Missing <remarks> documentation for T:PH.Common.Bot]

Inheritance Hierarchy

Assembly: PH.Common (Module: PH.Common) Version: 6.0.0.0