Class Warhead
A set of tools to easily work with the alpha warhead.
Inheritance
Inherited Members
Namespace: Exiled.API.Features
Assembly: Exiled.API.dll
Syntax
public static class Warhead
Properties
| Improve this Doc View SourceAutoDetonate
Gets or sets a value indicating whether or not automatic detonation is enabled.
Declaration
public static bool AutoDetonate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
BlastDoors
Gets all of the warhead blast doors.
Declaration
public static IReadOnlyCollection<BlastDoor> BlastDoors { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyCollection<BlastDoor> |
CanBeStarted
Gets a value indicating whether or not the warhead can be started.
Declaration
public static bool CanBeStarted { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Controller
Gets the cached AlphaWarheadController component.
Declaration
public static AlphaWarheadController Controller { get; }
Property Value
Type | Description |
---|---|
AlphaWarheadController |
DetonationTimer
Gets or sets the warhead detonation timer.
Declaration
public static float DetonationTimer { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
IsDetonated
Gets a value indicating whether or not the warhead has already been detonated.
Declaration
public static bool IsDetonated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsInProgress
Gets a value indicating whether or not the warhead detonation is in progress.
Declaration
public static bool IsInProgress { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsKeycardActivated
Gets or sets a value indicating whether or not the warhead's outside panel has been opened.
Declaration
public static bool IsKeycardActivated { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsLocked
Gets or sets a value indicating whether or not the warhead can be disabled.
Declaration
public static bool IsLocked { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Kills
Gets or sets the amount of kills caused by the warhead (shown on the summary screen).
Declaration
public static int Kills { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Lever
Gets the UnityEngine.GameObject of the warhead lever.
Declaration
public static GameObject Lever { get; }
Property Value
Type | Description |
---|---|
UnityEngine.GameObject |
LeverStatus
Gets or sets a value indicating whether or not the warhead lever is enabled.
Declaration
public static bool LeverStatus { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
OpenDoors
Gets or sets a value indicating whether or not doors will be opened when the warhead activates.
Declaration
public static bool OpenDoors { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
OutsitePanel
Gets the cached AlphaWarheadOutsitePanel component.
Declaration
public static AlphaWarheadOutsitePanel OutsitePanel { get; }
Property Value
Type | Description |
---|---|
AlphaWarheadOutsitePanel |
RealDetonationTimer
Gets the warhead real detonation timer.
Declaration
public static float RealDetonationTimer { get; }
Property Value
Type | Description |
---|---|
System.Single |
SitePanel
Gets the cached AlphaWarheadNukesitePanel component.
Declaration
public static AlphaWarheadNukesitePanel SitePanel { get; }
Property Value
Type | Description |
---|---|
AlphaWarheadNukesitePanel |
Status
Gets or sets the warhead status.
Declaration
public static WarheadStatus Status { get; set; }
Property Value
Type | Description |
---|---|
WarheadStatus |
Methods
| Improve this Doc View SourceCanBeDetonated(Vector3, Boolean)
Gets whether or not the provided position will be detonated by the alpha warhead.
Declaration
public static bool CanBeDetonated(Vector3 pos, bool includeOnlyLifts = false)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.Vector3 | pos | The position to check. |
System.Boolean | includeOnlyLifts | If true, only lifts will be checked. |
Returns
Type | Description |
---|---|
System.Boolean | Whether or not the given position is prone to being detonated. |
CloseBlastDoors()
Closes the surface blast doors.
Declaration
public static void CloseBlastDoors()
Detonate()
Detonates the warhead.
Declaration
public static void Detonate()
Shake()
Shake all players, like if the warhead has been detonated.
Declaration
public static void Shake()
Start()
Starts the warhead countdown.
Declaration
public static void Start()
Stop()
Stops the warhead.
Declaration
public static void Stop()
TriggerDoors(Boolean)
Opens or closes all doors on the map, based on the provided open
.
Declaration
public static void TriggerDoors(bool open)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | open | Whether to open or close all doors on the map. |