EatCompletedEventArgs Class

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

Inheritance Hierarchy

SystemObject
  SystemEventArgs
    Terrarium.Sdk.Classes.Creature.EventsOrganismEventArgs
      Terrarium.Sdk.Classes.Creature.EventsActionResponseEventArgs
        Terrarium.Sdk.Classes.Creature.EventsEatCompletedEventArgs

Namespace: Terrarium.Sdk.Classes.Creature.Events
Assembly: Terrarium.Sdk (in Terrarium.Sdk.dll) Version: 1.1.0.0 (1.1.0.0)

Syntax

C++

Copy

[SerializableAttribute]
public class EatCompletedEventArgs : ActionResponseEventArgs

<SerializableAttribute>
Public Class EatCompletedEventArgs
	Inherits ActionResponseEventArgs

[SerializableAttribute]
public ref class EatCompletedEventArgs : public ActionResponseEventArgs

[<SerializableAttribute>]
type EatCompletedEventArgs =  
    class
        inherit ActionResponseEventArgs
    end

The EatCompletedEventArgs type exposes the following members.

Constructors

	Name	Description
	EatCompletedEventArgs	Initializes a new instance of the EatCompletedEventArgs class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Provides a string representation of this class for debugging purposes. (Overrides ActionResponseEventArgsToString.)

Top

Properties

	Name	Description
	Action	Retrieves the Acton that was completed. (Inherited from ActionResponseEventArgs.)
	ActionID	Retrives the ID of the action. (Inherited from ActionResponseEventArgs.)
	EatAction	Provides information about the original EatAction and the parameters passed into the BeginEating method. This can be used to retrieve the state of the creature you tried to eat.
	Successful	Provides information about whether or not an eat action was successful. Often times if multiple creatures are eating the state target, the target will run out of food value before all creatures get to eat. In this case the eat won't be successful and the creature won't gain any energy.

Top

Reference

Terrarium.Sdk.Classes.Creature.Events Namespace