Class Intercom
A set of tools to easily handle the Intercom.
Inheritance
System.Object
Intercom
Inherited Members
System.Object.ToString()
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 static class Intercom
Properties
| Improve this Doc View SourceDisplayText
Gets or sets the text displayed on the intercom screen.
Declaration
public static string DisplayText { get; set; }
Property Value
Type | Description |
---|---|
System.String |
GameObject
Gets the intercom's UnityEngine.GameObject.
Declaration
public static GameObject GameObject { get; }
Property Value
Type | Description |
---|---|
UnityEngine.GameObject |
IntercomDisplay
Gets the instance of PlayerRoles.Voice.IntercomDisplay.
Declaration
public static IntercomDisplay IntercomDisplay { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.Voice.IntercomDisplay |
InUse
Gets a value indicating whether or not the intercom is currently being used.
Declaration
public static bool InUse { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
RemainingCooldown
Gets or sets the remaining cooldown of the intercom.
Declaration
public static double RemainingCooldown { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Speaker
Gets the Player that is using the intercom.
Declaration
public static Player Speaker { get; }
Property Value
Type | Description |
---|---|
Player |
Remarks
Will be null if InUse is false.
SpeechRemainingTime
Gets or sets the remaining speech time of the intercom.
Declaration
public static float SpeechRemainingTime { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
State
Gets or sets the current state of the intercom.
Declaration
public static IntercomState State { get; set; }
Property Value
Type | Description |
---|---|
PlayerRoles.Voice.IntercomState |
Transform
Gets the intercom's UnityEngine.Transform.
Declaration
public static Transform Transform { get; }
Property Value
Type | Description |
---|---|
UnityEngine.Transform |
Methods
| Improve this Doc View SourcePlaySound(Boolean)
Plays the intercom's sound.
Declaration
public static void PlaySound(bool isStarting)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isStarting | Sets a value indicating whether or not the sound is the intercom's start speaking sound. |
Reset()
Reset the intercom's cooldown.
Declaration
public static void Reset()
Timeout()
Times out the intercom.
Declaration
public static void Timeout()