Click or drag to resize
OrganismState Properties

The OrganismState type exposes the following members.

Properties
  NameDescription
Public propertyActualDirection

Determines the direction the creature is moving in degrees. This along with Speed can be used to calculate where a creature will be in the future.

Public propertyCellRadius

Determines the number of game cells a creature uses on the screen. Each grid cell is 8 pixels in width and height.

Public propertyCurrentMoveToAction
Retrieves information about the creature's current movement vector. If the creature is moving this value will always be non null, and null if the creature isn't currently moving. This is used by the game engine since movement can encompass many turns.
Public propertyCurrentReproduceAction
Used to obtain or modify the current action representing the creature's reproduction status. If this value is not null then the creature is reproducing.
Public propertyDeathReason

Describes the reason why the creature died. This is most often OldAge, Starvation, Killed, or Sickness. If the creature is not dead yet then the value will be NotDead.

Public propertyEnergyState

Determine the current energy state of a creature by comparing the current amount of stored energy versus the various energy buckets.

Public propertyFoodChunks

Determines the amount of food value this creature represents. This can be used to determine if attacking a creature will be worth the effort.

Public propertyGeneration

Generation will be 0 the first time a creature is introduced. Each offspring of a creature will be labeled with its generation plus one. This helps define the longevity of a creature.

Public propertyGridX

Retrieves the creature's current grid location. This is useful for movement algorithms and is used by the engine for computing organism location in a fast and memory efficient manner.

Public propertyGridY

Retrieves the creature's current grid location. This is useful for movement algorithms and is used by the engine for computing organism location in a fast and memory efficient manner.

Public propertyGrowthWait

Determines the amount of time in game ticks a creature must wait before they are able to grow. If a creature is not yet mature, and the GrowthWait is 0, then it is possible the creature does not have enough energy or enough space in order to grow. This should be remedied quickly.

Public propertyID

A string number in the form of a GUID that uniquely represents this creature in the EcoSystem.

Public propertyIncubationTicks

Determines the number of ticks the creature must wait before it has finished reproducing. If your creature just needs to know if it's currently reproducing use the IsIncubating property.

Public propertyIsAlive

Determines if the creature is alive or dead. This is used by Carnivores so they can find food in the form of corpses.

Public propertyIsImmutable
Determines if the current creature state is immutable.
Public propertyIsIncubating

Determines if the creature is in the process of reproduction. Use IncubationTicks to find out exactly how long the creature has left to incubate.

Public propertyIsMature

Determines if the creature is mature by comparing the current Radius to the Radius it will have when mature.

Public propertyIsStopped

Determines if the creature is moving or is completely stopped.

Public propertyOrganismEvents
When events are completed the completion actions get listed into a collection of completed events. These are then used by the processing functions to fire off events on the creature.
Public propertyPercentEnergy

Determines the decimal percentage of the amount of energy a creature currently has, versus the total amount of energy the creature can store.

Public propertyPercentInjured
Must be overriden in derived classes and compute a factor that can be used to represent the injury done to the creature.
Public propertyPercentLifespanRemaining

Determines the decimal percentage of the amount of life remaining a creature currently has, versus the total amount of LifeSpan.

Public propertyPosition

Returns the creature's current position as a Point.

Public propertyPreviousDisplayAction
Returns the action that the organism was performing between the last state and this one. I.e. what ended on this state.
Public propertyRadius

Determines the actual radius of the creature. This is used to determine how close to maturity a creature has gotten or in various computations on attack, defense, and movement.

Public propertyReadyToReproduce

Determines if a creature is ready to reproduce based on the elapsed time since its previous reproduction. Use ReproductionWait to determine exactly how long the creature has to go.

Public propertyRenderInfo
This property remains mutable even though the rest of the object is immutable because it is used by the renderer and maintains rendering state across worldstate instances (like whether the organism is selected or not).
Public propertyReproductionWait

Determines the number of ticks the creature must wait before reproducing again. If your creature just needs to know if it's ready the ReadyToReproduce property can be used instead.

Public propertySpecies

Describes the characteristics of a creature through the use of the ISpecies interface.

Public propertySpeed

Determines the speed at which the creature is moving. Useful in calculating overtake speeds for Carnivores and run-away speeds for Herbivores.

Public propertyStoredEnergy

Determines how much energy a creature has stored. This is used to compute the energy state of the creature.

Public propertyTickAge

Represents the age of a creature in game ticks. Once a creature reaches a TickAge identical to its LifeSpan the creature will die from PopulationChangeReason.OldAge.

Top
See Also