Show / Hide Table of Contents

Class Animal

Inheritance
System.Object
Tickable
Organism
Animal
Implements
ITickable
System.IComparable
INetObject
INetObjectPosition
IPositionAndBounds
INetTrafficCategory
ICanTakeDamage
Inherited Members
Organism.BornTime
Organism.WorldHomePos
Organism.YieldPercent
Organism.GrowthPercent
Organism.ClientBasedGrowthPercent
Organism.Dead
Organism.DeadType
Organism.Position
Organism.Direction
Organism.Alive
Tickable.CompareTo(Object)
Tickable.IsReady()
Tickable.QueueHandle
Namespace: Eco.Simulation.Agents
Assembly: Eco.Simulation.dll
Syntax
public abstract class Animal : Organism, ITickable, IComparable, INetObject, INetObjectPosition, IPositionAndBounds, INetTrafficCategory, ICanTakeDamage

Constructors

Animal(AnimalSpecies, Vector3, Boolean, Boolean, Int32)

Declaration
protected Animal(AnimalSpecies species, Vector3 pos, bool dead, bool sick, int herdID)
Parameters
Type Name Description
AnimalSpecies species
System.Numerics.Vector3 pos
System.Boolean dead
System.Boolean sick
System.Int32 herdID

Fields

AnimalHuntedEvent

Declaration
public static readonly ThreadSafeAction<Animal, INetObject> AnimalHuntedEvent
Field Value
Type Description
ThreadSafeAction<Animal, INetObject>

Behavior

Declaration
public string Behavior
Field Value
Type Description
System.String

ControllingPlayerID

Declaration
public int ControllingPlayerID
Field Value
Type Description
System.Int32

Destroyed

Declaration
public readonly ThreadSafeAction<Animal> Destroyed
Field Value
Type Description
ThreadSafeAction<Animal>

Freeze

Declaration
public bool Freeze
Field Value
Type Description
System.Boolean

HerdID

Declaration
public int HerdID
Field Value
Type Description
System.Int32

Male

Declaration
public bool Male
Field Value
Type Description
System.Boolean

PosUpdatedEvent

Declaration
public static readonly ThreadSafeAction<Animal> PosUpdatedEvent
Field Value
Type Description
ThreadSafeAction<Animal>

Sick

Declaration
public bool Sick
Field Value
Type Description
System.Boolean

Properties

Active

Declaration
public bool Active { get; }
Property Value
Type Description
System.Boolean

AttachedEntities

Declaration
public List<NetEntity> AttachedEntities { get; set; }
Property Value
Type Description
System.Collections.Generic.List<NetEntity>

Bounds

Declaration
public Rect Bounds { get; }
Property Value
Type Description
Rect

GroundPosition

Declaration
public Vector3 GroundPosition { get; }
Property Value
Type Description
System.Numerics.Vector3

Health

Declaration
public float Health { get; set; }
Property Value
Type Description
System.Single

Herd

Declaration
public Herd Herd { get; }
Property Value
Type Description
Herd

ID

Declaration
public int ID { get; }
Property Value
Type Description
System.Int32

KillerSource

Declaration
public DamageSourceType KillerSource { get; set; }
Property Value
Type Description
DamageSourceType

MinimumNextTick

Declaration
public double MinimumNextTick { get; set; }
Property Value
Type Description
System.Double

NetObjectCreationRealtime

Declaration
public double NetObjectCreationRealtime { get; set; }
Property Value
Type Description
System.Double

NetTrafficCategory

Declaration
public string NetTrafficCategory { get; }
Property Value
Type Description
System.String

NextTick

Declaration
public override double NextTick { get; set; }
Property Value
Type Description
System.Double
Overrides
Tickable.NextTick

Species

Declaration
public AnimalSpecies Species { get; }
Property Value
Type Description
AnimalSpecies

TargetNetID

Declaration
public int TargetNetID { get; }
Property Value
Type Description
System.Int32

UpdateChannel

Declaration
public NetworkChannel UpdateChannel { get; }
Property Value
Type Description
NetworkChannel

Methods

AlertNearbyAnimals(Vector3, Single)

Declaration
public static void AlertNearbyAnimals(Vector3 position, float v)
Parameters
Type Name Description
System.Numerics.Vector3 position
System.Single v

Destroy()

Declaration
public override void Destroy()
Overrides
Tickable.Destroy()

Die(DamageSourceType)

Declaration
public void Die(DamageSourceType sourceType)
Parameters
Type Name Description
DamageSourceType sourceType

DoServerUpdateAnimalData(String, Vector3, Vector3, Boolean, Boolean)

Declaration
public void DoServerUpdateAnimalData(string behavior, Vector3 animalpos, Vector3 animaldir, bool doTeleport, bool notifyOthers)
Parameters
Type Name Description
System.String behavior
System.Numerics.Vector3 animalpos
System.Numerics.Vector3 animaldir
System.Boolean doTeleport
System.Boolean notifyOthers

EatFromHand(IWorldObserver)

Declaration
public void EatFromHand(IWorldObserver observer)
Parameters
Type Name Description
IWorldObserver observer

GetPathTo(String, Int32, Vector3, Vector3, Vector3, PathfindFlags)

Declaration
public void GetPathTo(string behavior, int targetNetID, Vector3 animalpos, Vector3 animalDir, Vector3 targetPos, PathfindFlags flags)
Parameters
Type Name Description
System.String behavior
System.Int32 targetNetID
System.Numerics.Vector3 animalpos
System.Numerics.Vector3 animalDir
System.Numerics.Vector3 targetPos
PathfindFlags flags

IsNotRelevant(INetObjectViewer)

Declaration
public bool IsNotRelevant(INetObjectViewer viewer)
Parameters
Type Name Description
INetObjectViewer viewer
Returns
Type Description
System.Boolean

IsRelevant(INetObjectViewer)

Declaration
public bool IsRelevant(INetObjectViewer viewer)
Parameters
Type Name Description
INetObjectViewer viewer
Returns
Type Description
System.Boolean

IsUpdated(INetObjectViewer)

Declaration
public bool IsUpdated(INetObjectViewer viewer)
Parameters
Type Name Description
INetObjectViewer viewer
Returns
Type Description
System.Boolean

Kill(DamageSourceType)

Declaration
public void Kill(DamageSourceType sourceType)
Parameters
Type Name Description
DamageSourceType sourceType

KillAndDestroy(DamageSourceType)

Declaration
public void KillAndDestroy(DamageSourceType sourceType)
Parameters
Type Name Description
DamageSourceType sourceType

ReceiveInitialState(BSONObject)

Declaration
public void ReceiveInitialState(BSONObject bsonObj)
Parameters
Type Name Description
BSONObject bsonObj

ReceiveUpdate(BSONObject)

Declaration
public virtual void ReceiveUpdate(BSONObject bsonObj)
Parameters
Type Name Description
BSONObject bsonObj

RequestPathAndUpdateState(String, Vector3, Vector3, Vector3, PathfindFlags, Single, Single, AnimalSpecies)

Declaration
public void RequestPathAndUpdateState(string behavior, Vector3 animalpos, Vector3 animaldir, Vector3 desiredDirOfPath, PathfindFlags flags, float desiredDistanceMin, float desiredDistanceMax, AnimalSpecies species)
Parameters
Type Name Description
System.String behavior
System.Numerics.Vector3 animalpos
System.Numerics.Vector3 animaldir
System.Numerics.Vector3 desiredDirOfPath
PathfindFlags flags
System.Single desiredDistanceMin
System.Single desiredDistanceMax
AnimalSpecies species

SendInitialState(BSONObject, INetObjectViewer)

Declaration
public void SendInitialState(BSONObject obj, INetObjectViewer viewer)
Parameters
Type Name Description
BSONObject obj
INetObjectViewer viewer

SendUpdate(BSONObject, INetObjectViewer)

Declaration
public void SendUpdate(BSONObject obj, INetObjectViewer viewer)
Parameters
Type Name Description
BSONObject obj
INetObjectViewer viewer

SetControllingPlayer(Int32)

Declaration
public void SetControllingPlayer(int id)
Parameters
Type Name Description
System.Int32 id

Tick()

Declaration
public override void Tick()
Overrides
Tickable.Tick()

TryDamage(INetObject, Single, DamageSourceType)

Declaration
public bool TryDamage(INetObject source, float amount, DamageSourceType sourceType)
Parameters
Type Name Description
INetObject source
System.Single amount
DamageSourceType sourceType
Returns
Type Description
System.Boolean

TryDamageByAnimal(Single)

When an animal damages another.

Declaration
public void TryDamageByAnimal(float amount)
Parameters
Type Name Description
System.Single amount

Implements

ITickable
System.IComparable
INetObject
INetObjectPosition
IPositionAndBounds
INetTrafficCategory
ICanTakeDamage
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾