Project Hoshimi Documented Class Library
Player Class
NamespacesPH.CommonPlayer
Class representing a player
Declaration Syntax
C#Visual BasicVisual C++
public class Player
Public Class Player
public ref class Player
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
Player()()()
Constructor

Player(String, Int32)
Constructor you must create

AI
AI of your team

Bots
Typed collection of bots of the player

BotTypes
Collection of types of bots in your assembly. Used by GameEngine

ChooseLandingPoint
Event generated at the beginning of the game to choose where you want to be injected

CurrentTurn
Current Turn in the Game

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.)
Flag
Bitmap used in Viewers.

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.)
IsAIDead
Indicate if your AI have been destroyed

IsInSafeArea(Point)
Indicate if the point (at the beginning of the turn) is in a Safe Area

IsLPCreatorCreated
Indicate if a LPCreator have already been created. You can create only one LPCreator in a game

LandingPoint
Point where you are injected.

LandingPointWanted

Point where you want to be injected.

Log
LogText
Text that appear in Log window in viewer (if log enabled)

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Mission
Reference to the Mission that contains objectives that must be reached to gain points

Name
Name of the player

OtherBotsInfo
Typed collection of other entities visible by your bots

OtherLandingPointsInfo
Collection of other Landing Point you discovered in the Terrain (ie Landing Point that your bots can see)

PierreExistingFactories
List of Points where Pierre Factorys are at the beginning of the Game.

PierreExistingFactoriesCount
Numbers of Factories of Pierre's Team at the beginig of the game

PlayerID
ID of the player

Score
Score of your player. See Score property of Needle to know how it is calculated

Terrain
Reference to the Terrain

Thinking
Used by GameEngine

ToString()()()
Overloads of ToString method
(Overrides Object.ToString()()().)
WhatToDoNext
Event generated each turn

Winner
Indicate if you are a winner at the end of the game

Remarks
Every player must create a (and only one) class that inherits Player. At the begining of the game, LandingPoint event is fired to allow player to choose its Landing point Each turn of a party, WhatToDoNextEvent event is fired.
Inheritance Hierarchy
Object
Player

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