XposeCraft  1.0.1-rc1
Developer API
XposeCraft.Game.Arguments Class Reference

Description of a Game Event occurrence. More...

Inheritance diagram for XposeCraft.Game.Arguments:

Public Member Functions

 Arguments ()
 
 Arguments (Arguments arguments, GameEvent thisGameEvent)
 Clone constructor. More...
 

Properties

GameEvent ThisGameEvent [get, set]
 Before running the function, the instance to this current GameEvent will be returned here and can be used, for example, to unregister it after the run. More...
 
IDictionary< string, string > StringMap [get]
 
int Minerals [get, set]
 Minerals available to the Player. More...
 
IUnit MyUnit [get, set]
 My Unit related to the Event. More...
 
IBuilding MyBuilding [get, set]
 My Building related to the Event. More...
 
IUnit [] EnemyUnits [get, set]
 Enemy Units related to the Event. More...
 
IBuilding [] EnemyBuildings [get, set]
 Enemy Buildings related to the Event. More...
 

Detailed Description

Description of a Game Event occurrence.

Constructor & Destructor Documentation

◆ Arguments() [1/2]

XposeCraft.Game.Arguments.Arguments ( )

◆ Arguments() [2/2]

XposeCraft.Game.Arguments.Arguments ( Arguments  arguments,
GameEvent  thisGameEvent 
)

Clone constructor.

TODO: do a deep clone.

Parameters
argumentsArguments to have its parameters copied to the new instance.
thisGameEventGameEvent represented by the Arguments instance.

Property Documentation

◆ EnemyBuildings

IBuilding [] XposeCraft.Game.Arguments.EnemyBuildings
getset

Enemy Buildings related to the Event.

◆ EnemyUnits

IUnit [] XposeCraft.Game.Arguments.EnemyUnits
getset

Enemy Units related to the Event.

◆ Minerals

int XposeCraft.Game.Arguments.Minerals
getset

Minerals available to the Player.

◆ MyBuilding

IBuilding XposeCraft.Game.Arguments.MyBuilding
getset

My Building related to the Event.

◆ MyUnit

IUnit XposeCraft.Game.Arguments.MyUnit
getset

My Unit related to the Event.

◆ StringMap

IDictionary<string, string> XposeCraft.Game.Arguments.StringMap
get

◆ ThisGameEvent

GameEvent XposeCraft.Game.Arguments.ThisGameEvent
getset

Before running the function, the instance to this current GameEvent will be returned here and can be used, for example, to unregister it after the run.


The documentation for this class was generated from the following file: