Click or drag to resize
Terrarium.Sdk.Classes.Creature.Events Namespace

[Missing <summary> documentation for "N:Terrarium.Sdk.Classes.Creature.Events"]

Classes
  ClassDescription
Public classActionResponseEventArgs
Base class used to define other events that are in response to an action
Public classAttackCompletedEventArgs

Special object used to hold arguments passed to the AttackCompletedEventHandler delegate. This class provides information about the results of the attack including damage inflicted, whether the creature was killed, or whether the creature escaped.

Public classAttackedEventArgs

Special object used to hold arguments passed to the AttackedEventHandler delegate. Contains the state of the creature attacking your creature. This is useful in setting up a good defense

Public classBornEventArgs

Special object used to hold arguments passed to the BornEventHandler delegate. Currently only a byte[] containing special initialization values for the new born creature is available.

Public classDefendCompletedEventArgs

Special object used to hold arguments passed to the DefendCompletedEventHandler delegate. This class provides information about the creature that was blocked against so it can be used for future defensive strategies.

Public classEatCompletedEventArgs

Special object used to hold arguments passed to the EatCompletedEventHandler delegate. This class provides information about whether a creature's eat action was successful.

Public classIdleEventArgs

Special object used to hold arguments passed to the IdleEventHandler delegate. Currently no information is passed to creatures using this object.

Public classLoadEventArgs

Special object used to hold arguments passed to the LoadEventHandler delegate. Currently no information is passed to creatures using this object.

Public classMoveCompletedEventArgs

Special object used to hold arguments passed to the MoveCompletedEventHandler delegate. This class provides information about why the creature stopped, a MoveToAction describing the movement that took place or was to take place, and the state of the organism blocking the creatures path if the reason for stopping was being blocked.

Public classOrganismEventArgs
Public classReproduceCompletedEventArgs

Special object used to hold arguments passed to the ReproduceCompletedEventHandler delegate. This class contains information about the results of reproduction.

Public classTeleportedEventArgs

Special object used to hold arguments passed to the TeleportedEventHandler delegate. Currently no information is passed to a creature after teleportation.

Delegates
  DelegateDescription
Public delegateAttackCompletedEventHandler

Describes the event handler required in order to hook into a creature's AttackCompleted event. The sender will always be your creature, and AttackCompletedEventArgs will be filled with information to help your creature process it's turn.

This event will be fired after every attack your creature initiates. The returned AttackCompletedEventArgs will contain information about damage dealt, whether the creature is dead, or whether it got away.

Public delegateAttackedEventHandler

Describes the event handler required in order to hook into a creature's Attacked event. The sender will always be your creature, and AttackedEventArgs will be filled with information to help your creature process it's turn.

This event may be fired more than once per turn and will be fired once for each creature that initiates an attack against your creature assuming your creature lives through the battle.

Public delegateBornEventHandler

Describes the event handler required in order to hook into a creature's Born event. The sender will always be your creature, and BornEventArgs will be filled with information to help your creature process it's turn.

This event may be fired once for your creature when it is first born, in which case the BornEventArgs might have some Dna from the parent, or none if the creatures were made by the Terrarium game engine during introduction.

Public delegateDefendCompletedEventHandler

Describes the event handler required in order to hook into a creature's DefendCompleted event. The sender will always be your creature, and DefendCompletedEventArgs will be filled with information to help your creature process it's turn.

This event will be fired after your creature has defended against another creature. This can often be used to defend against the creature additional times in the case they might continue attacking.

Public delegateEatCompletedEventHandler

Describes the event handler required in order to hook into a creature's EatCompleted event. The sender will always be your creature, and EatCompletedEventArgs will be filled with information to help your creature process it's turn.

This event will be fired after your creature has taken a bite of food. Eating can be successful only if the target creature had enough available food matter left for your creature to eat.

Public delegateIdleEventHandler

Describes the event handler required in order to hook into a creature's Idle event. The sender will always be your creature, and IdleEventArgs will be filled with information to help your creature process it's turn.

Public delegateLoadEventHandler

Describes the event handler required in order to hook into a creature's Load event. The sender will always be your creature, and LoadEventArgs will be filled with information to help your creature process it's turn.

Public delegateMoveCompletedEventHandler

Describes the event handler required in order to hook into a creature's MoveCompleted event. The sender will always be your creature, and MoveCompletedEventArgs will be filled with information to help your creature process it's turn.

This event will fire when a move has been completed. This can mean your creature was blocked or made it to its destination. It may be several ticks from the BeginMoving function call to initiate movement until your creature's move is actually complete.

Public delegateReproduceCompletedEventHandler

Describes the event handler required in order to hook into a creature's ReproduceCompleted event. The sender will always be your creature, and ReproduceCompletedEventArgs will be filled with information to help your creature process it's turn.

This event will be fired for your creature immediately after it has given birth to a child creature of your species.

Public delegateTeleportedEventHandler

Describes the event handler required in order to hook into a creature's Teleported event. The sender will always be your creature, and TeleportedEventArgs will be filled with information to help your creature process it's turn.

This event may be fired whenever your creature is teleported internally in the same Terrarium or externally to another peer. This can be used to determine if special world related values should be reset and reinitialized.

Public delegateTraceEventHandler

For system use only.