Class TantrumHazard

Namespace

Exiled.API.Features.Hazards

Assembly

Exiled.API.dll

A wrapper for Hazards.TantrumEnvironmentalHazard.

public class TantrumHazard : TemporaryHazard, IWrapper<EnvironmentalHazard>

Inheritance

object

TypeCastObject<Hazard>

Hazard

TemporaryHazard

TantrumHazard

Implements

IWrapper<EnvironmentalHazard>

Inherited Members

TemporaryHazard.IsDestroyed

TemporaryHazard.TotalDuration

TemporaryHazard.Duration

TemporaryHazard.Destroy()

Hazard.List

Hazard.AffectedPlayers

Hazard.MaxDistance

Hazard.MaxHeightDistance

Hazard.IsActive

Hazard.PositionOffset

Hazard.Room

Hazard.Position

Hazard.Get(EnvironmentalHazard)

Hazard.Get<T>(EnvironmentalHazard)

Hazard.Get(Room)

Hazard.Get(GameObject)

Hazard.Get(Func<Hazard, bool>)

Hazard.Get(HazardType)

Hazard.IsInArea(Player)

TypeCastObject<Hazard>.Cast<TObject>()

TypeCastObject<Hazard>.Cast<TObject>(out TObject)

TypeCastObject<Hazard>.As<TObject>()

TypeCastObject<Hazard>.Is<TObject>(out TObject)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Constructors

TantrumHazard(TantrumEnvironmentalHazard)

Initializes a new instance of the TantrumHazard class.

public TantrumHazard(TantrumEnvironmentalHazard hazard)

Parameters

hazard TantrumEnvironmentalHazard

The Hazards.TantrumEnvironmentalHazard instance.

Properties

Base

Gets the Hazards.TantrumEnvironmentalHazard.

public TantrumEnvironmentalHazard Base { get; }

Property Value

TantrumEnvironmentalHazard

CorrectPosition

Gets or sets the correct position of tantrum hazard.

public Transform CorrectPosition { get; set; }

Property Value

Transform

PlaySizzle

Gets or sets a value indicating whether sizzle should be played.

public bool PlaySizzle { get; set; }

Property Value

bool

SynchronisedPosition

Gets or sets the synced position.

public RelativePosition SynchronisedPosition { get; set; }

Property Value

RelativePosition

TantrumPrefab

Gets the tantrum prefab.

public static TantrumEnvironmentalHazard TantrumPrefab { get; }

Property Value

TantrumEnvironmentalHazard

Type

Gets the HazardType associated with the current Hazard.

public override HazardType Type { get; }

Property Value

HazardType

Methods

PlaceTantrum(Vector3, bool)

Places a Tantrum (SCP-173's ability) in the indicated position.

public static TantrumHazard PlaceTantrum(Vector3 position, bool isActive = true)

Parameters

position Vector3

The position where you want to spawn the Tantrum.

isActive bool

Whether the tantrum will apply the Stained effect.

Returns

TantrumHazard

The TantrumHazard instance.

Remarks

If isActive is true, the tantrum is moved slightly up from its original position. Otherwise, the collision will not be detected and the slowness will not work.