Click or drag to resize
MoveCompletedEventArgs Class

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.

Inheritance Hierarchy

Namespace: Terrarium.Sdk.Classes.Creature.Events
Assembly: Terrarium.Sdk (in Terrarium.Sdk.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax
[SerializableAttribute]
public class MoveCompletedEventArgs : ActionResponseEventArgs

The MoveCompletedEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodMoveCompletedEventArgs
Initializes a new instance of the MoveCompletedEventArgs class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString

Provides a string representation of this class for debugging purposes. Presents the reason for stopping in string form.

(Overrides ActionResponseEventArgsToString.)
Top
Properties
  NameDescription
Public propertyAction
Retrieves the Acton that was completed.
(Inherited from ActionResponseEventArgs.)
Public propertyActionID
Retrives the ID of the action.
(Inherited from ActionResponseEventArgs.)
Public propertyBlockingOrganism

Provides the OrganismState of the blocking creature if one exists. This can be useful when writing event based movement algorithms and to find camouflaged creatures.

Public propertyMoveToAction

Provides the original MoveToAction created as a result of the BeginMoving function. This can be used to get the MovementVector which can be reused if the creature has not yet reached its destination.

Public propertyReason

Provides the reason for a creature being stopped. This can either be that the creature reached it's destination or was somehow blocked by another creature.

Top
See Also