Class EActor

Actor is the base class for a EObject that can be placed or spawned in-game.

Inheritance
System.Object
TypeCastObject<EObject>
EObject
EActor
EBehaviour
EBehaviour<T>
StaticActor<T>
State
StateController
StaticActor
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Exiled.API.Features.Core
Assembly: Exiled.API.dll
Syntax
public abstract class EActor : EObject, IEntity, IWorldSpace, IPosition, IRotation

Constructors

| Improve this Doc View Source

EActor()

Initializes a new instance of the EActor class.

Declaration
protected EActor()
| Improve this Doc View Source

EActor(GameObject)

Initializes a new instance of the EActor class.

Declaration
protected EActor(GameObject gameObject = null)
Parameters
Type Name Description
UnityEngine.GameObject gameObject

The base UnityEngine.GameObject.

Fields

| Improve this Doc View Source

DefaultFixedTickRate

The default fixed tick rate.

Declaration
public const float DefaultFixedTickRate = 0.016F
Field Value
Type Description
System.Single

Properties

| Improve this Doc View Source

CanEverTick

Gets or sets a value indicating whether the EActor can tick.

Declaration
public virtual bool CanEverTick { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ComponentsInChildren

Declaration
public IReadOnlyCollection<EActor> ComponentsInChildren { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyCollection<EActor>
| Improve this Doc View Source

ComponentsInParent

Gets a EActor[] containing all the components in parent.

Declaration
protected IEnumerable<EActor> ComponentsInParent { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<EActor>
| Improve this Doc View Source

FixedTickRate

Gets or sets the value which determines the size of every tick.

Declaration
public virtual float FixedTickRate { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Position

Gets or sets the UnityEngine.Vector3.

Declaration
public virtual Vector3 Position { get; set; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

Rotation

Gets or sets the UnityEngine.Quaternion.

Declaration
public virtual Quaternion Rotation { get; set; }
Property Value
Type Description
UnityEngine.Quaternion
| Improve this Doc View Source

Scale

Gets or sets the UnityEngine.Vector3.

Declaration
public virtual Vector3 Scale { get; set; }
Property Value
Type Description
UnityEngine.Vector3
| Improve this Doc View Source

Transform

Gets the UnityEngine.Transform.

Declaration
public Transform Transform { get; }
Property Value
Type Description
UnityEngine.Transform

Methods

| Improve this Doc View Source

AddComponent(Type, String)

Declaration
public EActor AddComponent(Type type, string name = "")
Parameters
Type Name Description
System.Type type
System.String name
Returns
Type Description
EActor
| Improve this Doc View Source

AddComponent<T>(String)

Declaration
public T AddComponent<T>(string name = "")

    where T : EActor
Parameters
Type Name Description
System.String name
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

AddComponent<T>(Type, String)

Declaration
public T AddComponent<T>(Type type, string name = "")

    where T : EActor
Parameters
Type Name Description
System.Type type
System.String name
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

AttachTo(EActor, EActor)

Attaches a EActor to the specified EActor.

Declaration
public static void AttachTo(EActor to, EActor from)
Parameters
Type Name Description
EActor to

The actor to be modified.
EActor from

The source actor.
| Improve this Doc View Source

AttachTo(EActor, GameObject)

Attaches a EActor to the specified UnityEngine.GameObject.

Declaration
public static void AttachTo(EActor comp, GameObject gameObject)
Parameters
Type Name Description
EActor comp

EActor.
UnityEngine.GameObject gameObject

UnityEngine.GameObject.
| Improve this Doc View Source

GetComponent(Type)

Declaration
public EActor GetComponent(Type type)
Parameters
Type Name Description
System.Type type
Returns
Type Description
EActor
| Improve this Doc View Source

GetComponent<T>()

Declaration
public T GetComponent<T>()

    where T : EActor
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

GetComponent<T>(Type)

Declaration
public T GetComponent<T>(Type type)

    where T : EActor
Parameters
Type Name Description
System.Type type
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

HasComponent(Type, Boolean)

Declaration
public bool HasComponent(Type type, bool depthInheritance = false)
Parameters
Type Name Description
System.Type type
System.Boolean depthInheritance
Returns
Type Description
System.Boolean
| Improve this Doc View Source

HasComponent<T>(Boolean)

Declaration
public bool HasComponent<T>(bool depthInheritance = false)
Parameters
Type Name Description
System.Boolean depthInheritance
Returns
Type Description
System.Boolean
Type Parameters
Name Description
T
| Improve this Doc View Source

OnBeginDestroy()

Declaration
protected override void OnBeginDestroy()
Overrides
| Improve this Doc View Source

OnBeginPlay()

Fired after the first fixed tick.

Declaration
protected virtual void OnBeginPlay()
| Improve this Doc View Source

OnEndPlay()

Fired before the current EActor instance is destroyed.

Declaration
protected virtual void OnEndPlay()
| Improve this Doc View Source

PostInitialize()

Fired after the EActor instance is created.

Declaration
protected virtual void PostInitialize()
| Improve this Doc View Source

SubscribeEvents()

Subscribes all the events.

Declaration
protected virtual void SubscribeEvents()
| Improve this Doc View Source

Tick()

Fired every tick.

Declaration
protected virtual void Tick()
| Improve this Doc View Source

TryGetComponent(Type, out EActor)

Declaration
public bool TryGetComponent(Type type, out EActor component)
Parameters
Type Name Description
System.Type type
EActor component
Returns
Type Description
System.Boolean
| Improve this Doc View Source

TryGetComponent<T>(out T)

Declaration
public bool TryGetComponent<T>(out T component)

    where T : EActor
Parameters
Type Name Description
T component
Returns
Type Description
System.Boolean
Type Parameters
Name Description
T
| Improve this Doc View Source

TryGetComponent<T>(Type, out T)

Declaration
public bool TryGetComponent<T>(Type type, out T component)

    where T : EActor
Parameters
Type Name Description
System.Type type
T component
Returns
Type Description
System.Boolean
Type Parameters
Name Description
T
| Improve this Doc View Source

UnsubscribeEvents()

Unsubscribes all the events.

Declaration
protected virtual void UnsubscribeEvents()

Implements

Extension Methods