Class Generator

Wrapper class for MapGeneration.Distributors.Scp079Generator.

Inheritance

System.Object

Generator

Implements

IWrapper<MapGeneration.Distributors.Scp079Generator>

IWorldSpace

IPosition

IRotation

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Exiled.API.Features

Assembly: Exiled.API.dll

Syntax

public class Generator : IWrapper<Scp079Generator>, IWorldSpace, IPosition, IRotation

Properties

| Improve this Doc View Source

ActivationTime

Gets or sets the generator's activation time.

Declaration

public float ActivationTime { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Base

Gets the base MapGeneration.Distributors.Scp079Generator.

Declaration

public Scp079Generator Base { get; }

Property Value

Type	Description
MapGeneration.Distributors.Scp079Generator

| Improve this Doc View Source

CurrentTime

Gets or sets the generator's current time.

Declaration

public short CurrentTime { get; set; }

Property Value

Type	Description
System.Int16

| Improve this Doc View Source

DeactivationTime

Gets or sets the generator's deactivation time.

Declaration

public float DeactivationTime { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

DeniedUnlockCooldown

Gets or sets the interaction cooldown to wait after failing the generator's unlock interaction.

Declaration

public float DeniedUnlockCooldown { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

DropdownSpeed

Gets the generator's dropdown speed.

Declaration

public float DropdownSpeed { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

GameObject

Gets the UnityEngine.GameObject of the generator.

Declaration

public GameObject GameObject { get; }

Property Value

Type	Description
UnityEngine.GameObject

| Improve this Doc View Source

InteractionCooldown

Gets or sets current interaction cooldown.

Declaration

public float InteractionCooldown { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

IsActivating

Gets or sets a value indicating whether the generator is activating.

Declaration

public bool IsActivating { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsEngaged

Gets or sets a value indicating whether the generator is engaged.

Declaration

public bool IsEngaged { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsOpen

Gets or sets a value indicating whether the generator is open.

Declaration

public bool IsOpen { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsReady

Gets a value indicating whether the generator is ready to be activated.

Declaration

public bool IsReady { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsUnlocked

Gets or sets a value indicating whether the generator is unlocked.

Declaration

public bool IsUnlocked { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

KeycardPermissions

Gets or sets the required permissions to interact with the generator.

Declaration

public KeycardPermissions KeycardPermissions { get; set; }

Property Value

Type	Description
KeycardPermissions

| Improve this Doc View Source

LastActivator

Gets or sets the last activator for the generator.

Declaration

public Player LastActivator { get; set; }

Property Value

Type	Description
Player

| Improve this Doc View Source

LeverDelay

Gets or sets the generator's lever delay.

Declaration

public float LeverDelay { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

List

Gets a System.Collections.Generic.IEnumerable<T> of Generator which contains all the Generator instances.

Declaration

public static IReadOnlyCollection<Generator> List { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<Generator>

| Improve this Doc View Source

Position

Gets the generator position.

Declaration

public Vector3 Position { get; }

Property Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

Room

Gets the generator's Room.

Declaration

public Room Room { get; }

Property Value

Type	Description
Room

| Improve this Doc View Source

Rotation

Gets the generator rotation.

Declaration

public Quaternion Rotation { get; }

Property Value

Type	Description
UnityEngine.Quaternion

| Improve this Doc View Source

State

Gets or sets the generator' state.

Declaration

public GeneratorState State { get; set; }

Property Value

Type	Description
GeneratorState

| Improve this Doc View Source

TogglePanelCooldown

Gets or sets the cooldown to wait before toggling the generator's panel.

Declaration

public float TogglePanelCooldown { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Transform

Gets the UnityEngine.Transform of the generator.

Declaration

public Transform Transform { get; }

Property Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

UnlockCooldown

Gets or sets the interaction cooldown to wait after unlocking the generator.

Declaration

public float UnlockCooldown { get; set; }

Property Value

Type	Description
System.Single

Methods

| Improve this Doc View Source

DenyUnlock()

Denies the unlock.

Declaration

public void DenyUnlock()

| Improve this Doc View Source

DenyUnlockAndResetCooldown()

Denies the unlock and resets the interaction cooldown.

Declaration

public void DenyUnlockAndResetCooldown()

| Improve this Doc View Source

Get(GeneratorState)

Gets a System.Collections.Generic.IEnumerable<T> of Generator given the specified GeneratorState.

Declaration

public static IEnumerable<Generator> Get(GeneratorState state)

Parameters

Type	Name	Description
GeneratorState	state	The GeneratorState to search for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Generator>	The Generator with the given GeneratorState or null if not found.

| Improve this Doc View Source

Get(Scp079Generator)

Gets the Generator belonging to the MapGeneration.Distributors.Scp079Generator, if any.

Declaration

public static Generator Get(Scp079Generator scp079Generator)

Parameters

Type	Name	Description
MapGeneration.Distributors.Scp079Generator	scp079Generator	The MapGeneration.Distributors.Scp079Generator instance.

Returns

Type	Description
Generator	A Generator or null if not found.

| Improve this Doc View Source

Get(Func<Generator, Boolean>)

Gets a System.Collections.Generic.IEnumerable<T> of Generator filtered based on a predicate.

Declaration

public static IEnumerable<Generator> Get(Func<Generator, bool> predicate)

Parameters

Type	Name	Description
System.Func<Generator, System.Boolean>	predicate	The condition to satify.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Generator>	A System.Collections.Generic.IEnumerable<T> of Generator which contains elements that satify the condition.

| Improve this Doc View Source

SetPermissionFlag(KeycardPermissions, Boolean)

Sets the specified KeycardPermissions flag.

Declaration

public void SetPermissionFlag(KeycardPermissions flag, bool isEnabled)

Parameters

Type	Name	Description
KeycardPermissions	flag	The flag to set.
System.Boolean	isEnabled	A value indicating whether the flag is enabled.

| Improve this Doc View Source

ToString()

Returns the Generator in a human-readable format.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string containing Generator-related data.

Overrides

System.Object.ToString()

| Improve this Doc View Source

TryGet(GeneratorState, out IEnumerable<Generator>)

Try-get a System.Collections.Generic.IEnumerable<T> of Generator given the specified GeneratorState.

Declaration

public static bool TryGet(GeneratorState state, out IEnumerable<Generator> generators)

Parameters

Type	Name	Description
GeneratorState	state	The GeneratorState to search for.
System.Collections.Generic.IEnumerable<Generator>	generators	A System.Collections.Generic.IEnumerable<T> of Generator matching the GeneratorState.

Returns

Type	Description
System.Boolean	Whether or not at least one generator was found.

| Improve this Doc View Source

TryGet(Scp079Generator, out Generator)

Try-get a Generator belonging to the MapGeneration.Distributors.Scp079Generator, if any.

Declaration

public static bool TryGet(Scp079Generator scp079Generator, out Generator generator)

Parameters

Type	Name	Description
MapGeneration.Distributors.Scp079Generator	scp079Generator	The MapGeneration.Distributors.Scp079Generator instance.
Generator	generator	A Generator or null if not found.

Returns

Type	Description
System.Boolean	Whether or not a generator was found.

| Improve this Doc View Source

TryGet(Func<Generator, Boolean>, out IEnumerable<Generator>)

Try-get a System.Collections.Generic.IEnumerable<T> of Generator filtered based on a predicate.

Declaration

public static bool TryGet(Func<Generator, bool> predicate, out IEnumerable<Generator> generators)

Parameters

Type	Name	Description
System.Func<Generator, System.Boolean>	predicate	The condition to satify.
System.Collections.Generic.IEnumerable<Generator>	generators	A System.Collections.Generic.IEnumerable<T> of Generator which contains elements that satify the condition.

Returns

Type	Description
System.Boolean	Whether or not at least one generator was found.

Implements

IWrapper<T>

IWorldSpace

IPosition

IRotation

Extension Methods

ReflectionExtensions.CopyProperties(Object, Object)