Table of Contents

Interface IEntity

Namespace
Obsidian.API
Assembly
Obsidian.API.dll
public interface IEntity

Properties

Air

int Air { get; set; }

Property Value

int

BoundingBox

BoundingBox BoundingBox { get; }

Property Value

BoundingBox

Burning

bool Burning { get; }

Property Value

bool

CustomName

ChatMessage? CustomName { get; set; }

Property Value

ChatMessage

CustomNameVisible

bool CustomNameVisible { get; set; }

Property Value

bool

Dimension

EntityDimension Dimension { get; }

Property Value

EntityDimension

EntityId

int EntityId { get; }

Property Value

int

FlyingWithElytra

bool FlyingWithElytra { get; }

Property Value

bool

Glowing

bool Glowing { get; }

Property Value

bool

GoalController

IGoalController? GoalController { get; set; }

Property Value

IGoalController

Health

float Health { get; set; }

Property Value

float

Invisible

bool Invisible { get; }

Property Value

bool

IsFireImmune

bool IsFireImmune { get; }

Property Value

bool

MovementFlags

MovementFlags MovementFlags { get; }

Property Value

MovementFlags

Navigator

INavigator? Navigator { get; set; }

Property Value

INavigator

NoGravity

bool NoGravity { get; }

Property Value

bool

Pitch

Angle Pitch { get; set; }

Property Value

Angle

Pose

Pose Pose { get; set; }

Property Value

Pose

Position

VectorF Position { get; set; }

Property Value

VectorF

Silent

bool Silent { get; }

Property Value

bool

Sneaking

bool Sneaking { get; }

Property Value

bool

Sprinting

bool Sprinting { get; }

Property Value

bool

Summonable

bool Summonable { get; }

Property Value

bool

Swimming

bool Swimming { get; }

Property Value

bool

TranslationKey

string? TranslationKey { get; }

Property Value

string

Type

EntityType Type { get; }

Property Value

EntityType

Uuid

Guid Uuid { get; set; }

Property Value

Guid

World

IWorld World { get; }

Property Value

IWorld

Yaw

Angle Yaw { get; set; }

Property Value

Angle

Methods

DamageAsync(IEntity, float)

ValueTask DamageAsync(IEntity source, float amount = 1)

Parameters

source IEntity
amount float

Returns

ValueTask

GetAttributeValue(string)

float GetAttributeValue(string attributeResourceName)

Parameters

attributeResourceName string

Returns

float

GetEntitiesNear(float)

IEnumerable<IEntity> GetEntitiesNear(float distance)

Parameters

distance float

Returns

IEnumerable<IEntity>

GetLookDirection()

VectorF GetLookDirection()

Returns

VectorF

HasAttribute(string)

bool HasAttribute(string attributeResourceName)

Parameters

attributeResourceName string

Returns

bool

IsInRange(IEntity, float)

bool IsInRange(IEntity entity, float distance)

Parameters

entity IEntity
distance float

Returns

bool

KillAsync(IEntity)

ValueTask KillAsync(IEntity source)

Parameters

source IEntity

Returns

ValueTask

KillAsync(IEntity, ChatMessage)

ValueTask KillAsync(IEntity source, ChatMessage message)

Parameters

source IEntity
message ChatMessage

Returns

ValueTask

RemoveAsync()

ValueTask RemoveAsync()

Returns

ValueTask

SetHeadRotation(Angle)

void SetHeadRotation(Angle headYaw)

Parameters

headYaw Angle

SetRotation(Angle, Angle, MovementFlags)

void SetRotation(Angle yaw, Angle pitch, MovementFlags movementFlags)

Parameters

yaw Angle
pitch Angle
movementFlags MovementFlags

SpawnEntity(Velocity?, int)

Spawns the specified entity to player nearby in the world.

void SpawnEntity(Velocity? velocity = null, int additionalData = 0)

Parameters

velocity Velocity?

The velocity the entity should spawn with

additionalData int

Additional data for the entity. More info here: https://wiki.vg/Object_Data

TeleportAsync(IEntity)

ValueTask TeleportAsync(IEntity to)

Parameters

to IEntity

Returns

ValueTask

TeleportAsync(IWorld)

ValueTask TeleportAsync(IWorld world)

Parameters

world IWorld

Returns

ValueTask

TeleportAsync(VectorF)

ValueTask TeleportAsync(VectorF pos)

Parameters

pos VectorF

Returns

ValueTask

TickAsync()

ValueTask TickAsync()

Returns

ValueTask

TryAddAttribute(string, float)

bool TryAddAttribute(string attributeResourceName, float value)

Parameters

attributeResourceName string
value float

Returns

bool

TryUpdateAttribute(string, float)

bool TryUpdateAttribute(string attributeResourceName, float newValue)

Parameters

attributeResourceName string
newValue float

Returns

bool

Write(INetStreamWriter)

void Write(INetStreamWriter writer)

Parameters

writer INetStreamWriter