Table of Contents

Class TickComponent

Namespace
Exiled.API.Features.Core
Assembly
Exiled.API.dll

The component which handles tick related features.

public sealed class TickComponent : EObject
Inheritance
TickComponent
Inherited Members
Extension Methods

Fields

DefaultFixedTickRate

The default fixed tick rate.

public const float DefaultFixedTickRate = 0.016

Field Value

float

Properties

BoundHandles

Gets all the currently bound handles.

public IReadOnlyCollection<CoroutineHandle> BoundHandles { get; }

Property Value

IReadOnlyCollection<CoroutineHandle>

CanEverTick

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

public bool CanEverTick { get; set; }

Property Value

bool

Instructions

Gets a List<T> of Action containing all the delegates to be invoked.

public List<Action> Instructions { get; }

Property Value

List<Action>

TickRate

Gets or sets the current tick rate.

public float TickRate { get; set; }

Property Value

float

Methods

BindHandle(CoroutineHandle)

Binds a MEC.CoroutineHandle.

public void BindHandle(CoroutineHandle handle)

Parameters

handle CoroutineHandle

The MEC.CoroutineHandle to bind.

BindHandle(ref CoroutineHandle, IEnumerator<float>)

Binds a MEC.CoroutineHandle.

public void BindHandle(ref CoroutineHandle handle, IEnumerator<float> coroutine)

Parameters

handle CoroutineHandle

The MEC.CoroutineHandle to bind.

coroutine IEnumerator<float>

The coroutine to handle.

OnBeginDestroy()

Fired before the current EObject instance is destroyed.

protected override void OnBeginDestroy()

UnbindAllHandles()

Unbinds all the currently bound handles.

public void UnbindAllHandles()

UnbindHandle(CoroutineHandle)

Unbinds a MEC.CoroutineHandle.

public void UnbindHandle(CoroutineHandle handle)

Parameters

handle CoroutineHandle

The MEC.CoroutineHandle to unbind.