Class StaticActor

This is a generic Singleton implementation for components.
Create a derived class of the script you want to "Singletonize"

Inheritance
System.Object
TypeCastObject<EObject>
EObject
EActor
StaticActor
DynamicEventManager
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 StaticActor : EActor, IEntity, IWorldSpace, IPosition, IRotation
Remarks

Do not redefine PostInitialize() OnBeginPlay() or OnEndPlay() in derived classes.
Instead, use langword_csharp_protected virtual methods:

PostInitialize_Static()

BeginPlay_Static()

EndPlay_Static()

To perform the initialization and cleanup: those methods are guaranteed to only be called once in the entire lifetime of the component.

Properties

| Improve this Doc View Source

IsDestroyed

Gets a value indicating whether the OnEndPlay() method has already been called by Unity.

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

IsInitialized

Gets a value indicating whether the PostInitialize() method has already been called by Unity.

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

IsStarted

Gets a value indicating whether the OnBeginPlay() method has already been called by Unity.

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

Methods

| Improve this Doc View Source

BeginPlay_Static()

Fired on OnBeginPlay().

Declaration
protected virtual void BeginPlay_Static()
Remarks

This method will only be called once even if multiple instances of the StaticActor component exist in the scene.
You can override this method in derived classes to customize the initialization of the component.

| Improve this Doc View Source

CreateNewInstance(Type)

Creates a new instance of the StaticActor.

Declaration
public static StaticActor CreateNewInstance(Type type)
Parameters
Type Name Description
System.Type type

The type of the StaticActor.
Returns
Type Description
StaticActor

The created StaticActor instance, or null if not found.
| Improve this Doc View Source

EndPlay_Static()

Fired on OnEndPlay().

Declaration
protected virtual void EndPlay_Static()
Remarks

This method will only be called once even if multiple instances of the StaticActor component exist in the scene.
You can override this method in derived classes to customize the initialization of the component.

| Improve this Doc View Source

Flush()

Flushes the current actor.

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

Get(Type)

Gets a StaticActor given the specified type.

Declaration
public static StaticActor Get(Type type)
Parameters
Type Name Description
System.Type type

The the type of the StaticActor to look for.
Returns
Type Description
StaticActor

The corresponding StaticActor.
| Improve this Doc View Source

Get<T>()

Gets a StaticActor given the specified type T.

Declaration
public static T Get<T>()

    where T : StaticActor
Returns
Type Description
T

The corresponding StaticActor, or null if not found.
Type Parameters
Name Description
T

The type of the StaticActor to look for.
| Improve this Doc View Source

Get<T>(Type)

Gets a StaticActor given the specified type.

Declaration
public static T Get<T>(Type type)

    where T : StaticActor
Parameters
Type Name Description
System.Type type

The the type of the StaticActor to look for.
Returns
Type Description
T

The corresponding StaticActor of type T, or null if not found.
Type Parameters
Name Description
T

The type to cast the StaticActor to.
| Improve this Doc View Source

NotifyInstanceRepeated()

If a duplicated instance of a StaticActor component is loaded into the scene this method will be called instead of PostInitialize_Static().
That way you can customize what to do with repeated instances.

Declaration
protected virtual void NotifyInstanceRepeated()
Remarks

The default approach is delete the duplicated component.

| Improve this Doc View Source

OnBeginPlay()

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

OnEndPlay()

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

PostInitialize()

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

PostInitialize_Static()

Fired on PostInitialize().

Declaration
protected virtual void PostInitialize_Static()
Remarks

This method will only be called once even if multiple instances of the StaticActor component exist in the scene.
You can override this method in derived classes to customize the initialization of the component.

Implements

Extension Methods