Search Results for

    Show / Hide Table of Contents

    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 Source

    DisplayText

    Gets or sets the text displayed on the intercom screen.

    Declaration
    public static string DisplayText { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    GameObject

    Gets the intercom's UnityEngine.GameObject.

    Declaration
    public static GameObject GameObject { get; }
    Property Value
    Type Description
    UnityEngine.GameObject
    | Improve this Doc View Source

    IntercomDisplay

    Gets the instance of PlayerRoles.Voice.IntercomDisplay.

    Declaration
    public static IntercomDisplay IntercomDisplay { get; }
    Property Value
    Type Description
    PlayerRoles.Voice.IntercomDisplay
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    RemainingCooldown

    Gets or sets the remaining cooldown of the intercom.

    Declaration
    public static double RemainingCooldown { get; set; }
    Property Value
    Type Description
    System.Double
    | Improve this Doc View Source

    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.

    | Improve this Doc View Source

    SpeechRemainingTime

    Gets or sets the remaining speech time of the intercom.

    Declaration
    public static float SpeechRemainingTime { get; set; }
    Property Value
    Type Description
    System.Single
    | Improve this Doc View Source

    State

    Gets or sets the current state of the intercom.

    Declaration
    public static IntercomState State { get; set; }
    Property Value
    Type Description
    PlayerRoles.Voice.IntercomState
    | Improve this Doc View Source

    Transform

    Gets the intercom's UnityEngine.Transform.

    Declaration
    public static Transform Transform { get; }
    Property Value
    Type Description
    UnityEngine.Transform

    Methods

    | Improve this Doc View Source

    PlaySound(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.

    | Improve this Doc View Source

    Reset()

    Reset the intercom's cooldown.

    Declaration
    public static void Reset()
    | Improve this Doc View Source

    Timeout()

    Times out the intercom.

    Declaration
    public static void Timeout()
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX