OpenMod Docs OpenMod Docs
OpenMod Docs OpenMod Docs
OpenMod .NET Plugin Framework.

Class RustEntity

Inheritance
System.Object
RustEntity
RustPlayer
Implements
IEntity
IGameObject
IDamageSource
Namespace: OpenMod.Rust.Entities
Assembly: OpenMod.Rust.dll
Syntax
public class RustEntity : object, IEntity, IGameObject, IDamageSource

Constructors

| Improve this Doc View Source

RustEntity(BaseEntity)

Declaration
public RustEntity(BaseEntity entity)
Parameters
Type Name Description
BaseEntity entity

Properties

| Improve this Doc View Source

Asset

Declaration
public virtual IEntityAsset Asset { get; }
Property Value
Type Description
IEntityAsset
| Improve this Doc View Source

DamageSourceName

Declaration
public virtual string DamageSourceName { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Entity

Declaration
public BaseEntity Entity { get; }
Property Value
Type Description
BaseEntity
| Improve this Doc View Source

EntityInstanceId

Declaration
public string EntityInstanceId { get; protected set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

State

Declaration
public IEntityState State { get; }
Property Value
Type Description
IEntityState
| Improve this Doc View Source

Transform

Declaration
public IWorldTransform Transform { get; }
Property Value
Type Description
IWorldTransform

Methods

| Improve this Doc View Source

DoTeleport(Vector3, Quaternion)

Declaration
protected virtual bool DoTeleport(Vector3 destination, Quaternion rotation)
Parameters
Type Name Description
Vector3 destination
Quaternion rotation
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetPositionAsync(Vector3)

Declaration
public virtual Task<bool> SetPositionAsync(Vector3 position)
Parameters
Type Name Description
Vector3 position
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

SetPositionAsync(Vector3, Quaternion)

Declaration
public virtual Task<bool> SetPositionAsync(Vector3 position, Quaternion rotation)
Parameters
Type Name Description
Vector3 position
Quaternion rotation
Returns
Type Description
Task<System.Boolean>

Implements

IEntity
IGameObject
IDamageSource

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)