Search Results for

    Show / Hide Table of Contents

    Class Player

    Player related events.

    Inheritance
    System.Object
    Player
    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.Events.Handlers
    Assembly: Exiled.Events.dll
    Syntax
    public class Player

    Properties

    | Improve this Doc View Source

    ActivatingGenerator

    Invoked before a Player turns on the generator by switching lever.

    Declaration
    public static Event<ActivatingGeneratorEventArgs> ActivatingGenerator { get; set; }
    Property Value
    Type Description
    Event<ActivatingGeneratorEventArgs>
    | Improve this Doc View Source

    ActivatingWarheadPanel

    Invoked before activating the warhead panel.

    Declaration
    public static Event<ActivatingWarheadPanelEventArgs> ActivatingWarheadPanel { get; set; }
    Property Value
    Type Description
    Event<ActivatingWarheadPanelEventArgs>
    | Improve this Doc View Source

    ActivatingWorkstation

    Invoked before activating a workstation.

    Declaration
    public static Event<ActivatingWorkstationEventArgs> ActivatingWorkstation { get; set; }
    Property Value
    Type Description
    Event<ActivatingWorkstationEventArgs>
    | Improve this Doc View Source

    AimingDownSight

    Invoked before a Player triggers an aim action.

    Declaration
    public static Event<AimingDownSightEventArgs> AimingDownSight { get; set; }
    Property Value
    Type Description
    Event<AimingDownSightEventArgs>
    | Improve this Doc View Source

    Banned

    Invoked after a Player has been banned from the server.

    Declaration
    public static Event<BannedEventArgs> Banned { get; set; }
    Property Value
    Type Description
    Event<BannedEventArgs>
    | Improve this Doc View Source

    Banning

    Invoked before banning a Player from the server.

    Declaration
    public static Event<BanningEventArgs> Banning { get; set; }
    Property Value
    Type Description
    Event<BanningEventArgs>
    | Improve this Doc View Source

    CancelledItemUse

    Invoked after a Player has stopped the use of a Usable.

    Declaration
    public static Event<CancelledItemUseEventArgs> CancelledItemUse { get; set; }
    Property Value
    Type Description
    Event<CancelledItemUseEventArgs>
    | Improve this Doc View Source

    CancellingItemUse

    Invoked before a Player has stopped the use of a Usable.

    Declaration
    public static Event<CancellingItemUseEventArgs> CancellingItemUse { get; set; }
    Property Value
    Type Description
    Event<CancellingItemUseEventArgs>
    | Improve this Doc View Source

    ChangedItem

    Invoked after a Player held Item changes.

    Declaration
    public static Event<ChangedItemEventArgs> ChangedItem { get; set; }
    Property Value
    Type Description
    Event<ChangedItemEventArgs>
    | Improve this Doc View Source

    ChangingGroup

    Invoked before changing a Player group.

    Declaration
    public static Event<ChangingGroupEventArgs> ChangingGroup { get; set; }
    Property Value
    Type Description
    Event<ChangingGroupEventArgs>
    | Improve this Doc View Source

    ChangingItem

    Invoked before a Player held Item changes.

    Declaration
    public static Event<ChangingItemEventArgs> ChangingItem { get; set; }
    Property Value
    Type Description
    Event<ChangingItemEventArgs>
    | Improve this Doc View Source

    ChangingMicroHIDState

    Invoked before a Player MicroHID state is changed.

    Declaration
    public static Event<ChangingMicroHIDStateEventArgs> ChangingMicroHIDState { get; set; }
    Property Value
    Type Description
    Event<ChangingMicroHIDStateEventArgs>
    | Improve this Doc View Source

    ChangingMoveState

    Invoked before a Player changes move state.

    Declaration
    public static Event<ChangingMoveStateEventArgs> ChangingMoveState { get; set; }
    Property Value
    Type Description
    Event<ChangingMoveStateEventArgs>
    | Improve this Doc View Source

    ChangingNickname

    Invoked before a Player's nickname is changed.

    Declaration
    public static Event<ChangingNicknameEventArgs> ChangingNickname { get; set; }
    Property Value
    Type Description
    Event<ChangingNicknameEventArgs>
    | Improve this Doc View Source

    ChangingRadioPreset

    Invoked before a user's radio preset is changed.

    Declaration
    public static Event<ChangingRadioPresetEventArgs> ChangingRadioPreset { get; set; }
    Property Value
    Type Description
    Event<ChangingRadioPresetEventArgs>
    | Improve this Doc View Source

    ChangingRole

    Invoked before changing a Player role.

    Declaration
    public static Event<ChangingRoleEventArgs> ChangingRole { get; set; }
    Property Value
    Type Description
    Event<ChangingRoleEventArgs>
    Remarks

    If IsAllowed is set to false when Escape is true, tickets will still be given to the escapee's team even though they will 'fail' to escape. Use Escaping to block escapes instead.

    | Improve this Doc View Source

    ChangingSpectatedPlayer

    Invoked after a Player changed spectated player.

    Declaration
    public static Event<ChangingSpectatedPlayerEventArgs> ChangingSpectatedPlayer { get; set; }
    Property Value
    Type Description
    Event<ChangingSpectatedPlayerEventArgs>
    | Improve this Doc View Source

    ClosingGenerator

    Invoked before a Player closes a generator.

    Declaration
    public static Event<ClosingGeneratorEventArgs> ClosingGenerator { get; set; }
    Property Value
    Type Description
    Event<ClosingGeneratorEventArgs>
    | Improve this Doc View Source

    DamagingDoor

    Invoked before a Player damage a Door.

    Declaration
    public static Event<DamagingDoorEventArgs> DamagingDoor { get; set; }
    Property Value
    Type Description
    Event<DamagingDoorEventArgs>
    | Improve this Doc View Source

    DamagingShootingTarget

    Invoked before a Player damages a shooting target.

    Declaration
    public static Event<DamagingShootingTargetEventArgs> DamagingShootingTarget { get; set; }
    Property Value
    Type Description
    Event<DamagingShootingTargetEventArgs>
    | Improve this Doc View Source

    DeactivatingWorkstation

    Invoked before deactivating a workstation.

    Declaration
    public static Event<DeactivatingWorkstationEventArgs> DeactivatingWorkstation { get; set; }
    Property Value
    Type Description
    Event<DeactivatingWorkstationEventArgs>
    | Improve this Doc View Source

    Destroying

    Invoked before destroying a Player.

    Declaration
    public static Event<DestroyingEventArgs> Destroying { get; set; }
    Property Value
    Type Description
    Event<DestroyingEventArgs>
    | Improve this Doc View Source

    Died

    Invoked after a Player died.

    Declaration
    public static Event<DiedEventArgs> Died { get; set; }
    Property Value
    Type Description
    Event<DiedEventArgs>
    | Improve this Doc View Source

    DroppedAmmo

    Invoked after dropping ammo.

    Declaration
    public static Event<DroppedAmmoEventArgs> DroppedAmmo { get; set; }
    Property Value
    Type Description
    Event<DroppedAmmoEventArgs>
    | Improve this Doc View Source

    DroppedItem

    Invoked after dropping an Item.

    Declaration
    public static Event<DroppedItemEventArgs> DroppedItem { get; set; }
    Property Value
    Type Description
    Event<DroppedItemEventArgs>
    | Improve this Doc View Source

    DroppingAmmo

    Invoked before dropping ammo.

    Declaration
    public static Event<DroppingAmmoEventArgs> DroppingAmmo { get; set; }
    Property Value
    Type Description
    Event<DroppingAmmoEventArgs>
    | Improve this Doc View Source

    DroppingItem

    Invoked before dropping an Item.

    Declaration
    public static Event<DroppingItemEventArgs> DroppingItem { get; set; }
    Property Value
    Type Description
    Event<DroppingItemEventArgs>
    | Improve this Doc View Source

    DroppingNothing

    Invoked before dropping a null Item.

    Declaration
    public static Event<DroppingNothingEventArgs> DroppingNothing { get; set; }
    Property Value
    Type Description
    Event<DroppingNothingEventArgs>
    | Improve this Doc View Source

    DryfiringWeapon

    Invoked before a Player dryfires a weapon.

    Declaration
    public static Event<DryfiringWeaponEventArgs> DryfiringWeapon { get; set; }
    Property Value
    Type Description
    Event<DryfiringWeaponEventArgs>
    | Improve this Doc View Source

    Dying

    Invoked before a Player dies.

    Declaration
    public static Event<DyingEventArgs> Dying { get; set; }
    Property Value
    Type Description
    Event<DyingEventArgs>
    | Improve this Doc View Source

    EarningAchievement

    Invoked before a Player earns an achievement.

    Declaration
    public static Event<EarningAchievementEventArgs> EarningAchievement { get; set; }
    Property Value
    Type Description
    Event<EarningAchievementEventArgs>
    Remarks

    Will not fire for certain client-side achievements.

    | Improve this Doc View Source

    EnteringEnvironmentalHazard

    Invoked before a Player enters in an environmental hazard.

    Declaration
    public static Event<EnteringEnvironmentalHazardEventArgs> EnteringEnvironmentalHazard { get; set; }
    Property Value
    Type Description
    Event<EnteringEnvironmentalHazardEventArgs>
    | Improve this Doc View Source

    EnteringKillerCollision

    Invoked before a Player enters killer collision.

    Declaration
    public static Event<EnteringKillerCollisionEventArgs> EnteringKillerCollision { get; set; }
    Property Value
    Type Description
    Event<EnteringKillerCollisionEventArgs>
    | Improve this Doc View Source

    EnteringPocketDimension

    Invoked before a Player enters the pocket dimension.

    Declaration
    public static Event<EnteringPocketDimensionEventArgs> EnteringPocketDimension { get; set; }
    Property Value
    Type Description
    Event<EnteringPocketDimensionEventArgs>
    | Improve this Doc View Source

    Escaping

    Invoked before a Player escapes.

    Declaration
    public static Event<EscapingEventArgs> Escaping { get; set; }
    Property Value
    Type Description
    Event<EscapingEventArgs>
    | Improve this Doc View Source

    EscapingPocketDimension

    Invoked before a Player escapes the pocket dimension.

    Declaration
    public static Event<EscapingPocketDimensionEventArgs> EscapingPocketDimension { get; set; }
    Property Value
    Type Description
    Event<EscapingPocketDimensionEventArgs>
    | Improve this Doc View Source

    ExitingEnvironmentalHazard

    Invoked when a Player exists from an environmental hazard.

    Declaration
    public static Event<ExitingEnvironmentalHazardEventArgs> ExitingEnvironmentalHazard { get; set; }
    Property Value
    Type Description
    Event<ExitingEnvironmentalHazardEventArgs>
    | Improve this Doc View Source

    FailingEscapePocketDimension

    Invoked before a Player fails to escape the pocket dimension.

    Declaration
    public static Event<FailingEscapePocketDimensionEventArgs> FailingEscapePocketDimension { get; set; }
    Property Value
    Type Description
    Event<FailingEscapePocketDimensionEventArgs>
    | Improve this Doc View Source

    FlippingCoin

    Invoked before a Player flips a coin.

    Declaration
    public static Event<FlippingCoinEventArgs> FlippingCoin { get; set; }
    Property Value
    Type Description
    Event<FlippingCoinEventArgs>
    | Improve this Doc View Source

    Handcuffing

    Invoked before handcuffing a Player.

    Declaration
    public static Event<HandcuffingEventArgs> Handcuffing { get; set; }
    Property Value
    Type Description
    Event<HandcuffingEventArgs>
    | Improve this Doc View Source

    Hurt

    Invoked after hurting a Player.

    Declaration
    public static Event<HurtEventArgs> Hurt { get; set; }
    Property Value
    Type Description
    Event<HurtEventArgs>
    | Improve this Doc View Source

    Hurting

    Invoked before hurting a Player.

    Declaration
    public static Event<HurtingEventArgs> Hurting { get; set; }
    Property Value
    Type Description
    Event<HurtingEventArgs>
    | Improve this Doc View Source

    Interacted

    Invoked after a Player interacted with something.

    Declaration
    public static Event<InteractedEventArgs> Interacted { get; set; }
    Property Value
    Type Description
    Event<InteractedEventArgs>
    | Improve this Doc View Source

    InteractingDoor

    Invoked before a Player interacts with a door.

    Declaration
    public static Event<InteractingDoorEventArgs> InteractingDoor { get; set; }
    Property Value
    Type Description
    Event<InteractingDoorEventArgs>
    | Improve this Doc View Source

    InteractingElevator

    Invoked before a Player interacts with an elevator.

    Declaration
    public static Event<InteractingElevatorEventArgs> InteractingElevator { get; set; }
    Property Value
    Type Description
    Event<InteractingElevatorEventArgs>
    | Improve this Doc View Source

    InteractingLocker

    Invoked before a Player interacts with a locker.

    Declaration
    public static Event<InteractingLockerEventArgs> InteractingLocker { get; set; }
    Property Value
    Type Description
    Event<InteractingLockerEventArgs>
    | Improve this Doc View Source

    InteractingShootingTarget

    Invoked before a Player interacts with a shooting target.

    Declaration
    public static Event<InteractingShootingTargetEventArgs> InteractingShootingTarget { get; set; }
    Property Value
    Type Description
    Event<InteractingShootingTargetEventArgs>
    | Improve this Doc View Source

    IntercomSpeaking

    Invoked before a Player begins speaking to the intercom.

    Declaration
    public static Event<IntercomSpeakingEventArgs> IntercomSpeaking { get; set; }
    Property Value
    Type Description
    Event<IntercomSpeakingEventArgs>
    | Improve this Doc View Source

    IssuingMute

    Invoked before muting a user.

    Declaration
    public static Event<IssuingMuteEventArgs> IssuingMute { get; set; }
    Property Value
    Type Description
    Event<IssuingMuteEventArgs>
    | Improve this Doc View Source

    ItemAdded

    Invoked after a Player has an item added to their inventory.

    Declaration
    public static Event<ItemAddedEventArgs> ItemAdded { get; set; }
    Property Value
    Type Description
    Event<ItemAddedEventArgs>
    | Improve this Doc View Source

    ItemRemoved

    Invoked after a Player has an item removed from their inventory.

    Declaration
    public static Event<ItemRemovedEventArgs> ItemRemoved { get; set; }
    Property Value
    Type Description
    Event<ItemRemovedEventArgs>
    | Improve this Doc View Source

    Joined

    Invoked after a Player has joined the server.

    Declaration
    public static Event<JoinedEventArgs> Joined { get; set; }
    Property Value
    Type Description
    Event<JoinedEventArgs>
    | Improve this Doc View Source

    Jumping

    Invoked before a Player jumps.

    Declaration
    public static Event<JumpingEventArgs> Jumping { get; set; }
    Property Value
    Type Description
    Event<JumpingEventArgs>
    | Improve this Doc View Source

    Kicked

    Invoked after a Player has been kicked from the server.

    Declaration
    public static Event<KickedEventArgs> Kicked { get; set; }
    Property Value
    Type Description
    Event<KickedEventArgs>
    | Improve this Doc View Source

    Kicking

    Invoked before kicking a Player from the server.

    Declaration
    public static Event<KickingEventArgs> Kicking { get; set; }
    Property Value
    Type Description
    Event<KickingEventArgs>
    | Improve this Doc View Source

    KillingPlayer

    Invoked before KillPlayer is called.

    Declaration
    public static Event<KillingPlayerEventArgs> KillingPlayer { get; set; }
    Property Value
    Type Description
    Event<KillingPlayerEventArgs>
    | Improve this Doc View Source

    Landing

    Invoked after a Player lands.

    Declaration
    public static Event<LandingEventArgs> Landing { get; set; }
    Property Value
    Type Description
    Event<LandingEventArgs>
    | Improve this Doc View Source

    Left

    Invoked after a Player has left the server.

    Declaration
    public static Event<LeftEventArgs> Left { get; set; }
    Property Value
    Type Description
    Event<LeftEventArgs>
    | Improve this Doc View Source

    MakingNoise

    Invoked before a Player makes noise.

    Declaration
    public static Event<MakingNoiseEventArgs> MakingNoise { get; set; }
    Property Value
    Type Description
    Event<MakingNoiseEventArgs>
    | Improve this Doc View Source

    OpeningGenerator

    Invoked before a Player opens a generator.

    Declaration
    public static Event<OpeningGeneratorEventArgs> OpeningGenerator { get; set; }
    Property Value
    Type Description
    Event<OpeningGeneratorEventArgs>
    | Improve this Doc View Source

    PickingUpItem

    Invoked before picking up an Item.

    Declaration
    public static Event<PickingUpItemEventArgs> PickingUpItem { get; set; }
    Property Value
    Type Description
    Event<PickingUpItemEventArgs>
    | Improve this Doc View Source

    PlayerDamageWindow

    Invoked before a Player damage a Window.

    Declaration
    public static Event<DamagingWindowEventArgs> PlayerDamageWindow { get; set; }
    Property Value
    Type Description
    Event<DamagingWindowEventArgs>
    | Improve this Doc View Source

    PreAuthenticating

    Invoked before authenticating a Player.

    Declaration
    public static Event<PreAuthenticatingEventArgs> PreAuthenticating { get; set; }
    Property Value
    Type Description
    Event<PreAuthenticatingEventArgs>
    | Improve this Doc View Source

    ReceivingEffect

    Invoked before a Player receives a status effect.

    Declaration
    public static Event<ReceivingEffectEventArgs> ReceivingEffect { get; set; }
    Property Value
    Type Description
    Event<ReceivingEffectEventArgs>
    | Improve this Doc View Source

    ReloadingWeapon

    Invoked before a Player reloads a weapon.

    Declaration
    public static Event<ReloadingWeaponEventArgs> ReloadingWeapon { get; set; }
    Property Value
    Type Description
    Event<ReloadingWeaponEventArgs>
    | Improve this Doc View Source

    RemovingHandcuffs

    Invoked before freeing a handcuffed Player.

    Declaration
    public static Event<RemovingHandcuffsEventArgs> RemovingHandcuffs { get; set; }
    Property Value
    Type Description
    Event<RemovingHandcuffsEventArgs>
    | Improve this Doc View Source

    ReservedSlot

    Invoked before reserved slot is finalized for a Player.

    Declaration
    public static Event<ReservedSlotsCheckEventArgs> ReservedSlot { get; set; }
    Property Value
    Type Description
    Event<ReservedSlotsCheckEventArgs>
    | Improve this Doc View Source

    RevokingMute

    Invoked before unmuting a user.

    Declaration
    public static Event<RevokingMuteEventArgs> RevokingMute { get; set; }
    Property Value
    Type Description
    Event<RevokingMuteEventArgs>
    | Improve this Doc View Source

    SearchingPickup

    Invoked before a Player searches a Pickup.

    Declaration
    public static Event<SearchingPickupEventArgs> SearchingPickup { get; set; }
    Property Value
    Type Description
    Event<SearchingPickupEventArgs>
    | Improve this Doc View Source

    SendingAdminChatMessage

    Invoked before a Player send a message in AdminChat.

    Declaration
    public static Event<SendingAdminChatMessageEventsArgs> SendingAdminChatMessage { get; set; }
    Property Value
    Type Description
    Event<SendingAdminChatMessageEventsArgs>
    | Improve this Doc View Source

    Shooting

    Invoked before a Player shoots a weapon.

    Declaration
    public static Event<ShootingEventArgs> Shooting { get; set; }
    Property Value
    Type Description
    Event<ShootingEventArgs>
    | Improve this Doc View Source

    Shot

    Invoked after a Player gets shot.

    Declaration
    public static Event<ShotEventArgs> Shot { get; set; }
    Property Value
    Type Description
    Event<ShotEventArgs>
    | Improve this Doc View Source

    Spawned

    Invoked after a Player has spawned.

    Declaration
    public static Event<SpawnedEventArgs> Spawned { get; set; }
    Property Value
    Type Description
    Event<SpawnedEventArgs>
    | Improve this Doc View Source

    SpawnedRagdoll

    Invoked after spawning a Player Ragdoll.

    Declaration
    public static Event<SpawnedRagdollEventArgs> SpawnedRagdoll { get; set; }
    Property Value
    Type Description
    Event<SpawnedRagdollEventArgs>
    | Improve this Doc View Source

    Spawning

    Invoked before spawning a Player.

    Declaration
    public static Event<SpawningEventArgs> Spawning { get; set; }
    Property Value
    Type Description
    Event<SpawningEventArgs>
    | Improve this Doc View Source

    SpawningRagdoll

    Invoked before spawning a Player Ragdoll.

    Declaration
    public static Event<SpawningRagdollEventArgs> SpawningRagdoll { get; set; }
    Property Value
    Type Description
    Event<SpawningRagdollEventArgs>
    | Improve this Doc View Source

    StayingOnEnvironmentalHazard

    Invoked when a Player stays on an environmental hazard.

    Declaration
    public static Event<StayingOnEnvironmentalHazardEventArgs> StayingOnEnvironmentalHazard { get; set; }
    Property Value
    Type Description
    Event<StayingOnEnvironmentalHazardEventArgs>
    | Improve this Doc View Source

    StoppingGenerator

    Invoked before a Player turns off the generator by switching lever.

    Declaration
    public static Event<StoppingGeneratorEventArgs> StoppingGenerator { get; set; }
    Property Value
    Type Description
    Event<StoppingGeneratorEventArgs>
    | Improve this Doc View Source

    ThrowingRequest

    Invoked before receving a throwing request an Throwable.

    Declaration
    public static Event<ThrowingRequestEventArgs> ThrowingRequest { get; set; }
    Property Value
    Type Description
    Event<ThrowingRequestEventArgs>
    | Improve this Doc View Source

    ThrownProjectile

    Invoked afer throwing an Throwable.

    Declaration
    public static Event<ThrownProjectileEventArgs> ThrownProjectile { get; set; }
    Property Value
    Type Description
    Event<ThrownProjectileEventArgs>
    | Improve this Doc View Source

    TogglingFlashlight

    Invoked before a Player toggles the flashlight.

    Declaration
    public static Event<TogglingFlashlightEventArgs> TogglingFlashlight { get; set; }
    Property Value
    Type Description
    Event<TogglingFlashlightEventArgs>
    | Improve this Doc View Source

    TogglingNoClip

    Invoked before a Player toggles the NoClip mode.

    Declaration
    public static Event<TogglingNoClipEventArgs> TogglingNoClip { get; set; }
    Property Value
    Type Description
    Event<TogglingNoClipEventArgs>
    | Improve this Doc View Source

    TogglingOverwatch

    Invoked before a Player toggles overwatch.

    Declaration
    public static Event<TogglingOverwatchEventArgs> TogglingOverwatch { get; set; }
    Property Value
    Type Description
    Event<TogglingOverwatchEventArgs>
    | Improve this Doc View Source

    TogglingRadio

    Invoked before turning the Radio on/off.

    Declaration
    public static Event<TogglingRadioEventArgs> TogglingRadio { get; set; }
    Property Value
    Type Description
    Event<TogglingRadioEventArgs>
    | Improve this Doc View Source

    TogglingWeaponFlashlight

    Invoked before a Player toggles the weapon's flashlight.

    Declaration
    public static Event<TogglingWeaponFlashlightEventArgs> TogglingWeaponFlashlight { get; set; }
    Property Value
    Type Description
    Event<TogglingWeaponFlashlightEventArgs>
    | Improve this Doc View Source

    Transmitting

    Invoked after a Player presses the transmission key.

    Declaration
    public static Event<TransmittingEventArgs> Transmitting { get; set; }
    Property Value
    Type Description
    Event<TransmittingEventArgs>
    | Improve this Doc View Source

    TriggeringTesla

    Invoked before a Player triggers a tesla gate.

    Declaration
    public static Event<TriggeringTeslaEventArgs> TriggeringTesla { get; set; }
    Property Value
    Type Description
    Event<TriggeringTeslaEventArgs>
    | Improve this Doc View Source

    UnloadingWeapon

    Invoked before a Player unloads a weapon.

    Declaration
    public static Event<UnloadingWeaponEventArgs> UnloadingWeapon { get; set; }
    Property Value
    Type Description
    Event<UnloadingWeaponEventArgs>
    | Improve this Doc View Source

    UnlockingGenerator

    Invoked before a Player unlocks a generator.

    Declaration
    public static Event<UnlockingGeneratorEventArgs> UnlockingGenerator { get; set; }
    Property Value
    Type Description
    Event<UnlockingGeneratorEventArgs>
    | Improve this Doc View Source

    UsedItem

    Invoked after a Player uses an Usable.

    Declaration
    public static Event<UsedItemEventArgs> UsedItem { get; set; }
    Property Value
    Type Description
    Event<UsedItemEventArgs>
    Remarks

    Invoked after UsingItem, if a player's class has changed during their health increase, won't fire.

    | Improve this Doc View Source

    UsingItem

    Invoked before using an Item.

    Declaration
    public static Event<UsingItemEventArgs> UsingItem { get; set; }
    Property Value
    Type Description
    Event<UsingItemEventArgs>
    | Improve this Doc View Source

    UsingItemCompleted

    Invoked after a Player uses an Usable.

    Declaration
    public static Event<UsingItemCompletedEventArgs> UsingItemCompleted { get; set; }
    Property Value
    Type Description
    Event<UsingItemCompletedEventArgs>
    | Improve this Doc View Source

    UsingMicroHIDEnergy

    Invoked before a Player MicroHID energy is changed.

    Declaration
    public static Event<UsingMicroHIDEnergyEventArgs> UsingMicroHIDEnergy { get; set; }
    Property Value
    Type Description
    Event<UsingMicroHIDEnergyEventArgs>
    | Improve this Doc View Source

    UsingRadioBattery

    Invoked before a user's radio battery charge is changed.

    Declaration
    public static Event<UsingRadioBatteryEventArgs> UsingRadioBattery { get; set; }
    Property Value
    Type Description
    Event<UsingRadioBatteryEventArgs>
    | Improve this Doc View Source

    Verified

    Invoked after a Player has been verified.

    Declaration
    public static Event<VerifiedEventArgs> Verified { get; set; }
    Property Value
    Type Description
    Event<VerifiedEventArgs>
    | Improve this Doc View Source

    VoiceChatting

    Invoked after a Player presses the voicechat key.

    Declaration
    public static Event<VoiceChattingEventArgs> VoiceChatting { get; set; }
    Property Value
    Type Description
    Event<VoiceChattingEventArgs>

    Methods

    | Improve this Doc View Source

    OnActivatingGenerator(ActivatingGeneratorEventArgs)

    Called before a Player turns on the generator by switching lever.

    Declaration
    public static void OnActivatingGenerator(ActivatingGeneratorEventArgs ev)
    Parameters
    Type Name Description
    ActivatingGeneratorEventArgs ev

    The ActivatingGeneratorEventArgs instance.

    | Improve this Doc View Source

    OnActivatingWarheadPanel(ActivatingWarheadPanelEventArgs)

    Called before activating the warhead panel.

    Declaration
    public static void OnActivatingWarheadPanel(ActivatingWarheadPanelEventArgs ev)
    Parameters
    Type Name Description
    ActivatingWarheadPanelEventArgs ev

    The ActivatingWarheadPanelEventArgs instance.

    | Improve this Doc View Source

    OnActivatingWorkstation(ActivatingWorkstationEventArgs)

    Called before activating a workstation.

    Declaration
    public static void OnActivatingWorkstation(ActivatingWorkstationEventArgs ev)
    Parameters
    Type Name Description
    ActivatingWorkstationEventArgs ev

    The ActivatingWorkstation instance.

    | Improve this Doc View Source

    OnAimingDownSight(AimingDownSightEventArgs)

    Called before a Player triggers an aim action.

    Declaration
    public static void OnAimingDownSight(AimingDownSightEventArgs ev)
    Parameters
    Type Name Description
    AimingDownSightEventArgs ev

    The AimingDownSightEventArgs instance.

    | Improve this Doc View Source

    OnBanned(BannedEventArgs)

    Called after a player has been banned from the server.

    Declaration
    public static void OnBanned(BannedEventArgs ev)
    Parameters
    Type Name Description
    BannedEventArgs ev

    The BannedEventArgs instance.

    | Improve this Doc View Source

    OnBanning(BanningEventArgs)

    Called before banning a Player from the server.

    Declaration
    public static void OnBanning(BanningEventArgs ev)
    Parameters
    Type Name Description
    BanningEventArgs ev

    The BanningEventArgs instance.

    | Improve this Doc View Source

    OnCancelledItemUse(CancelledItemUseEventArgs)

    Called after a Player has stopped the use of a Usable item.

    Declaration
    public static void OnCancelledItemUse(CancelledItemUseEventArgs ev)
    Parameters
    Type Name Description
    CancelledItemUseEventArgs ev

    The CancelledItemUseEventArgs instance.

    | Improve this Doc View Source

    OnCancellingItemUse(CancellingItemUseEventArgs)

    Called before a Player has stopped the use of a Usable item.

    Declaration
    public static void OnCancellingItemUse(CancellingItemUseEventArgs ev)
    Parameters
    Type Name Description
    CancellingItemUseEventArgs ev

    The CancellingItemUseEventArgs instance.

    | Improve this Doc View Source

    OnChangedItem(ChangedItemEventArgs)

    Called after a Player held item changes.

    Declaration
    public static void OnChangedItem(ChangedItemEventArgs ev)
    Parameters
    Type Name Description
    ChangedItemEventArgs ev

    The ChangedItemEventArgs instance.

    | Improve this Doc View Source

    OnChangingGroup(ChangingGroupEventArgs)

    Called before changing a Player group.

    Declaration
    public static void OnChangingGroup(ChangingGroupEventArgs ev)
    Parameters
    Type Name Description
    ChangingGroupEventArgs ev

    The ChangingGroupEventArgs instance.

    | Improve this Doc View Source

    OnChangingItem(ChangingItemEventArgs)

    Called before a Player held item changes.

    Declaration
    public static void OnChangingItem(ChangingItemEventArgs ev)
    Parameters
    Type Name Description
    ChangingItemEventArgs ev

    The ChangingItemEventArgs instance.

    | Improve this Doc View Source

    OnChangingMicroHIDState(ChangingMicroHIDStateEventArgs)

    Called before a Player MicroHID state is changed.

    Declaration
    public static void OnChangingMicroHIDState(ChangingMicroHIDStateEventArgs ev)
    Parameters
    Type Name Description
    ChangingMicroHIDStateEventArgs ev

    The ChangingMicroHIDStateEventArgs instance.

    | Improve this Doc View Source

    OnChangingMoveState(ChangingMoveStateEventArgs)

    Called before a Player changes move state.

    Declaration
    public static void OnChangingMoveState(ChangingMoveStateEventArgs ev)
    Parameters
    Type Name Description
    ChangingMoveStateEventArgs ev

    The ChangingMoveStateEventArgs instance.

    | Improve this Doc View Source

    OnChangingNickname(ChangingNicknameEventArgs)

    Called before a Player's custom display name is changed.

    Declaration
    public static void OnChangingNickname(ChangingNicknameEventArgs ev)
    Parameters
    Type Name Description
    ChangingNicknameEventArgs ev

    The ChangingNicknameEventArgs instance.

    | Improve this Doc View Source

    OnChangingRadioPreset(ChangingRadioPresetEventArgs)

    Called before a user's radio preset is changed.

    Declaration
    public static void OnChangingRadioPreset(ChangingRadioPresetEventArgs ev)
    Parameters
    Type Name Description
    ChangingRadioPresetEventArgs ev

    The ChangingRadioPresetEventArgs instance.

    | Improve this Doc View Source

    OnChangingRole(ChangingRoleEventArgs)

    Called before changing a Player role.

    Declaration
    public static void OnChangingRole(ChangingRoleEventArgs ev)
    Parameters
    Type Name Description
    ChangingRoleEventArgs ev

    The ChangingRoleEventArgs instance.

    Remarks

    If IsAllowed is set to false when Escape is true, tickets will still be given to the escapee's team even though they will 'fail' to escape. Use Escaping to block escapes instead.

    | Improve this Doc View Source

    OnChangingSpectatedPlayer(ChangingSpectatedPlayerEventArgs)

    Called after a Player changes spectated player.

    Declaration
    public static void OnChangingSpectatedPlayer(ChangingSpectatedPlayerEventArgs ev)
    Parameters
    Type Name Description
    ChangingSpectatedPlayerEventArgs ev

    The ChangingSpectatedPlayerEventArgs instance.

    | Improve this Doc View Source

    OnClosingGenerator(ClosingGeneratorEventArgs)

    Called before a Player closes a generator.

    Declaration
    public static void OnClosingGenerator(ClosingGeneratorEventArgs ev)
    Parameters
    Type Name Description
    ClosingGeneratorEventArgs ev

    The ClosingGeneratorEventArgs instance.

    | Improve this Doc View Source

    OnDamagingDoor(DamagingDoorEventArgs)

    Called before a Player damage a window.

    Declaration
    public static void OnDamagingDoor(DamagingDoorEventArgs ev)
    Parameters
    Type Name Description
    DamagingDoorEventArgs ev

    The DamagingDoorEventArgs instance.

    | Improve this Doc View Source

    OnDamagingShootingTarget(DamagingShootingTargetEventArgs)

    Called before a Player damages a shooting target.

    Declaration
    public static void OnDamagingShootingTarget(DamagingShootingTargetEventArgs ev)
    Parameters
    Type Name Description
    DamagingShootingTargetEventArgs ev

    The DamagingShootingTargetEventArgs instance.

    | Improve this Doc View Source

    OnDeactivatingWorkstation(DeactivatingWorkstationEventArgs)

    Called before deactivating a workstation.

    Declaration
    public static void OnDeactivatingWorkstation(DeactivatingWorkstationEventArgs ev)
    Parameters
    Type Name Description
    DeactivatingWorkstationEventArgs ev

    The DeactivatingWorkstationEventArgs instance.

    | Improve this Doc View Source

    OnDestroying(DestroyingEventArgs)

    Called before destroying a Player.

    Declaration
    public static void OnDestroying(DestroyingEventArgs ev)
    Parameters
    Type Name Description
    DestroyingEventArgs ev

    The DestroyingEventArgs instance.

    | Improve this Doc View Source

    OnDied(DiedEventArgs)

    Called after a Player died.

    Declaration
    public static void OnDied(DiedEventArgs ev)
    Parameters
    Type Name Description
    DiedEventArgs ev

    The DiedEventArgs instance.

    | Improve this Doc View Source

    OnDroppedAmmo(DroppedAmmoEventArgs)

    Called after dropping ammo.

    Declaration
    public static void OnDroppedAmmo(DroppedAmmoEventArgs ev)
    Parameters
    Type Name Description
    DroppedAmmoEventArgs ev

    The DroppedAmmoEventArgs instance.

    | Improve this Doc View Source

    OnDroppedItem(DroppedItemEventArgs)

    Called after dropping an item.

    Declaration
    public static void OnDroppedItem(DroppedItemEventArgs ev)
    Parameters
    Type Name Description
    DroppedItemEventArgs ev

    The DroppedItemEventArgs instance.

    | Improve this Doc View Source

    OnDroppingAmmo(DroppingAmmoEventArgs)

    Called before dropping ammo.

    Declaration
    public static void OnDroppingAmmo(DroppingAmmoEventArgs ev)
    Parameters
    Type Name Description
    DroppingAmmoEventArgs ev

    The DroppingAmmoEventArgs instance.

    | Improve this Doc View Source

    OnDroppingItem(DroppingItemEventArgs)

    Called before dropping an item.

    Declaration
    public static void OnDroppingItem(DroppingItemEventArgs ev)
    Parameters
    Type Name Description
    DroppingItemEventArgs ev

    The DroppingItemEventArgs instance.

    | Improve this Doc View Source

    OnDroppingNothing(DroppingNothingEventArgs)

    Called before dropping a null item.

    Declaration
    public static void OnDroppingNothing(DroppingNothingEventArgs ev)
    Parameters
    Type Name Description
    DroppingNothingEventArgs ev

    The DroppingNothingEventArgs instance.

    | Improve this Doc View Source

    OnDryfiringWeapon(DryfiringWeaponEventArgs)

    Called before a Player dryfires a weapon.

    Declaration
    public static void OnDryfiringWeapon(DryfiringWeaponEventArgs ev)
    Parameters
    Type Name Description
    DryfiringWeaponEventArgs ev

    The DryfiringWeaponEventArgs instance.

    | Improve this Doc View Source

    OnDying(DyingEventArgs)

    Called before a Player dies.

    Declaration
    public static void OnDying(DyingEventArgs ev)
    Parameters
    Type Name Description
    DyingEventArgs ev

    The DyingEventArgs instance.

    | Improve this Doc View Source

    OnEarningAchievement(EarningAchievementEventArgs)

    Called before a Player earns an achievement.

    Declaration
    public static void OnEarningAchievement(EarningAchievementEventArgs ev)
    Parameters
    Type Name Description
    EarningAchievementEventArgs ev

    The EarningAchievementEventArgs instance.

    | Improve this Doc View Source

    OnEnteringEnvironmentalHazard(EnteringEnvironmentalHazardEventArgs)

    Called before a Player enters in an environmental hazard.

    Declaration
    public static void OnEnteringEnvironmentalHazard(EnteringEnvironmentalHazardEventArgs ev)
    Parameters
    Type Name Description
    EnteringEnvironmentalHazardEventArgs ev

    The EnteringEnvironmentalHazardEventArgs instance.

    | Improve this Doc View Source

    OnEnteringKillerCollision(EnteringKillerCollisionEventArgs)

    Called before a Player enters killer collision.

    Declaration
    public static void OnEnteringKillerCollision(EnteringKillerCollisionEventArgs ev)
    Parameters
    Type Name Description
    EnteringKillerCollisionEventArgs ev

    The EnteringKillerCollisionEventArgs instance.

    | Improve this Doc View Source

    OnEnteringPocketDimension(EnteringPocketDimensionEventArgs)

    Called before a Player enters the pocket dimension.

    Declaration
    public static void OnEnteringPocketDimension(EnteringPocketDimensionEventArgs ev)
    Parameters
    Type Name Description
    EnteringPocketDimensionEventArgs ev

    The EnteringPocketDimensionEventArgs instance.

    | Improve this Doc View Source

    OnEscaping(EscapingEventArgs)

    Called before a Player escapes.

    Declaration
    public static void OnEscaping(EscapingEventArgs ev)
    Parameters
    Type Name Description
    EscapingEventArgs ev

    The EscapingEventArgs instance.

    | Improve this Doc View Source

    OnEscapingPocketDimension(EscapingPocketDimensionEventArgs)

    Called before a Player escapes the pocket dimension.

    Declaration
    public static void OnEscapingPocketDimension(EscapingPocketDimensionEventArgs ev)
    Parameters
    Type Name Description
    EscapingPocketDimensionEventArgs ev

    The EscapingPocketDimensionEventArgs instance.

    | Improve this Doc View Source

    OnExitingEnvironmentalHazard(ExitingEnvironmentalHazardEventArgs)

    Called before a Player exits from an environmental hazard.

    Declaration
    public static void OnExitingEnvironmentalHazard(ExitingEnvironmentalHazardEventArgs ev)
    Parameters
    Type Name Description
    ExitingEnvironmentalHazardEventArgs ev

    The ExitingEnvironmentalHazardEventArgs instance.

    | Improve this Doc View Source

    OnFailingEscapePocketDimension(FailingEscapePocketDimensionEventArgs)

    Called before a Player fails to escape the pocket dimension.

    Declaration
    public static void OnFailingEscapePocketDimension(FailingEscapePocketDimensionEventArgs ev)
    Parameters
    Type Name Description
    FailingEscapePocketDimensionEventArgs ev

    The FailingEscapePocketDimensionEventArgs instance.

    | Improve this Doc View Source

    OnFlippingCoin(FlippingCoinEventArgs)

    Called before a Player flips a coin.

    Declaration
    public static void OnFlippingCoin(FlippingCoinEventArgs ev)
    Parameters
    Type Name Description
    FlippingCoinEventArgs ev

    The FlippingCoinEventArgs instance.

    | Improve this Doc View Source

    OnHandcuffing(HandcuffingEventArgs)

    Called before handcuffing a Player.

    Declaration
    public static void OnHandcuffing(HandcuffingEventArgs ev)
    Parameters
    Type Name Description
    HandcuffingEventArgs ev

    The HandcuffingEventArgs instance.

    | Improve this Doc View Source

    OnHurt(HurtEventArgs)

    Called ater a Player being hurt.

    Declaration
    public static void OnHurt(HurtEventArgs ev)
    Parameters
    Type Name Description
    HurtEventArgs ev

    The HurtingEventArgs instance.

    | Improve this Doc View Source

    OnHurting(HurtingEventArgs)

    Called before hurting a player.

    Declaration
    public static void OnHurting(HurtingEventArgs ev)
    Parameters
    Type Name Description
    HurtingEventArgs ev

    The HurtingEventArgs instance.

    | Improve this Doc View Source

    OnInteracted(InteractedEventArgs)

    Called after a Player interacted with something.

    Declaration
    public static void OnInteracted(InteractedEventArgs ev)
    Parameters
    Type Name Description
    InteractedEventArgs ev

    The InteractedEventArgs instance.

    | Improve this Doc View Source

    OnInteractingDoor(InteractingDoorEventArgs)

    Called before a Player interacts with a door.

    Declaration
    public static void OnInteractingDoor(InteractingDoorEventArgs ev)
    Parameters
    Type Name Description
    InteractingDoorEventArgs ev

    The InteractingDoorEventArgs instance.

    | Improve this Doc View Source

    OnInteractingElevator(InteractingElevatorEventArgs)

    Called before a Player interacts with an elevator.

    Declaration
    public static void OnInteractingElevator(InteractingElevatorEventArgs ev)
    Parameters
    Type Name Description
    InteractingElevatorEventArgs ev

    The InteractingElevatorEventArgs instance.

    | Improve this Doc View Source

    OnInteractingLocker(InteractingLockerEventArgs)

    Called before a Player interacts with a locker.

    Declaration
    public static void OnInteractingLocker(InteractingLockerEventArgs ev)
    Parameters
    Type Name Description
    InteractingLockerEventArgs ev

    The InteractingLockerEventArgs instance.

    | Improve this Doc View Source

    OnInteractingShootingTarget(InteractingShootingTargetEventArgs)

    Called before a Player interacts with a shooting target.

    Declaration
    public static void OnInteractingShootingTarget(InteractingShootingTargetEventArgs ev)
    Parameters
    Type Name Description
    InteractingShootingTargetEventArgs ev

    The InteractingShootingTargetEventArgs instance.

    | Improve this Doc View Source

    OnIntercomSpeaking(IntercomSpeakingEventArgs)

    Called before a Player begins speaking to the intercom.

    Declaration
    public static void OnIntercomSpeaking(IntercomSpeakingEventArgs ev)
    Parameters
    Type Name Description
    IntercomSpeakingEventArgs ev

    The IntercomSpeakingEventArgs instance.

    | Improve this Doc View Source

    OnIssuingMute(IssuingMuteEventArgs)

    Called before muting a user.

    Declaration
    public static void OnIssuingMute(IssuingMuteEventArgs ev)
    Parameters
    Type Name Description
    IssuingMuteEventArgs ev

    The IssuingMuteEventArgs instance.

    | Improve this Doc View Source

    OnItemAdded(ReferenceHub, ItemBase, ItemPickupBase)

    Called after a Player has an item added to their inventory.

    Declaration
    public static void OnItemAdded(ReferenceHub referenceHub, ItemBase itemBase, ItemPickupBase pickupBase)
    Parameters
    Type Name Description
    ReferenceHub referenceHub

    The ReferenceHub the item was added to.

    InventorySystem.Items.ItemBase itemBase

    The added InventorySystem.Items.ItemBase.

    InventorySystem.Items.Pickups.ItemPickupBase pickupBase

    The InventorySystem.Items.Pickups.ItemPickupBase the InventorySystem.Items.ItemBase originated from, or null if the item was not picked up.

    | Improve this Doc View Source

    OnItemRemoved(ReferenceHub, ItemBase, ItemPickupBase)

    Called after a Player has an item removed from their inventory.

    Declaration
    public static void OnItemRemoved(ReferenceHub referenceHub, ItemBase itemBase, ItemPickupBase pickupBase)
    Parameters
    Type Name Description
    ReferenceHub referenceHub

    The ReferenceHub the item was removed from.

    InventorySystem.Items.ItemBase itemBase

    The removed InventorySystem.Items.ItemBase.

    InventorySystem.Items.Pickups.ItemPickupBase pickupBase

    The InventorySystem.Items.Pickups.ItemPickupBase the InventorySystem.Items.ItemBase originated from, or null if the item was not picked up.

    | Improve this Doc View Source

    OnJoined(JoinedEventArgs)

    Called after a Player has joined the server.

    Declaration
    public static void OnJoined(JoinedEventArgs ev)
    Parameters
    Type Name Description
    JoinedEventArgs ev

    The JoinedEventArgs instance.

    | Improve this Doc View Source

    OnJumping(JumpingEventArgs)

    Called before a Player jumps.

    Declaration
    public static void OnJumping(JumpingEventArgs ev)
    Parameters
    Type Name Description
    JumpingEventArgs ev

    The JumpingEventArgs instance.

    | Improve this Doc View Source

    OnKicked(KickedEventArgs)

    Called after a Player has been kicked from the server.

    Declaration
    public static void OnKicked(KickedEventArgs ev)
    Parameters
    Type Name Description
    KickedEventArgs ev

    The KickedEventArgs instance.

    | Improve this Doc View Source

    OnKicking(KickingEventArgs)

    Called before kicking a Player from the server.

    Declaration
    public static void OnKicking(KickingEventArgs ev)
    Parameters
    Type Name Description
    KickingEventArgs ev

    The KickingEventArgs instance.

    | Improve this Doc View Source

    OnKillPlayer(KillingPlayerEventArgs)

    Called before KillPlayer is called.

    Declaration
    public static void OnKillPlayer(KillingPlayerEventArgs ev)
    Parameters
    Type Name Description
    KillingPlayerEventArgs ev

    The KillingPlayerEventArgs event handler.

    | Improve this Doc View Source

    OnLanding(LandingEventArgs)

    Called after a Player lands.

    Declaration
    public static void OnLanding(LandingEventArgs ev)
    Parameters
    Type Name Description
    LandingEventArgs ev

    The LandingEventArgs instance.

    | Improve this Doc View Source

    OnLeft(LeftEventArgs)

    Called after a Player has left the server.

    Declaration
    public static void OnLeft(LeftEventArgs ev)
    Parameters
    Type Name Description
    LeftEventArgs ev

    The LeftEventArgs instance.

    | Improve this Doc View Source

    OnMakingNoise(MakingNoiseEventArgs)

    Called before a Player makes noise.

    Declaration
    public static void OnMakingNoise(MakingNoiseEventArgs ev)
    Parameters
    Type Name Description
    MakingNoiseEventArgs ev

    The MakingNoiseEventArgs instance.

    | Improve this Doc View Source

    OnOpeningGenerator(OpeningGeneratorEventArgs)

    Called before a Player opens a generator.

    Declaration
    public static void OnOpeningGenerator(OpeningGeneratorEventArgs ev)
    Parameters
    Type Name Description
    OpeningGeneratorEventArgs ev

    The OpeningGeneratorEventArgs instance.

    | Improve this Doc View Source

    OnPickingUpItem(PickingUpItemEventArgs)

    Called before a Player picks up an item.

    Declaration
    public static void OnPickingUpItem(PickingUpItemEventArgs ev)
    Parameters
    Type Name Description
    PickingUpItemEventArgs ev

    The PickingUpItemEventArgs instance.

    | Improve this Doc View Source

    OnPlayerDamageWindow(DamagingWindowEventArgs)

    Called before a Player damage a window.

    Declaration
    public static void OnPlayerDamageWindow(DamagingWindowEventArgs ev)
    Parameters
    Type Name Description
    DamagingWindowEventArgs ev

    The DamagingWindowEventArgs instance.

    | Improve this Doc View Source

    OnPreAuthenticating(String, String, Int64, CentralAuthPreauthFlags, String, Byte[], ConnectionRequest, Int32)

    Called before pre-authenticating a Player.

    Declaration
    [PluginEvent(ServerEventType.PlayerPreauth)]
    public PreauthCancellationData OnPreAuthenticating(string userId, string ipAddress, long expiration, CentralAuthPreauthFlags flags, string country, byte[] signature, ConnectionRequest request, int readerStartPosition)
    Parameters
    Type Name Description
    System.String userId
    System.String ipAddress
    System.Int64 expiration
    CentralAuthPreauthFlags flags
    System.String country
    System.Byte[] signature
    LiteNetLib.ConnectionRequest request
    System.Int32 readerStartPosition
    Returns
    Type Description
    PluginAPI.Events.PreauthCancellationData

    Returns the PluginAPI.Events.PreauthCancellationData instance.

    | Improve this Doc View Source

    OnReceivingEffect(ReceivingEffectEventArgs)

    Called before a Player receives a status effect.

    Declaration
    public static void OnReceivingEffect(ReceivingEffectEventArgs ev)
    Parameters
    Type Name Description
    ReceivingEffectEventArgs ev

    The ReceivingEffectEventArgs instance.

    | Improve this Doc View Source

    OnReloadingWeapon(ReloadingWeaponEventArgs)

    Called before a Player reloads a weapon.

    Declaration
    public static void OnReloadingWeapon(ReloadingWeaponEventArgs ev)
    Parameters
    Type Name Description
    ReloadingWeaponEventArgs ev

    The ReloadingWeaponEventArgs instance.

    | Improve this Doc View Source

    OnRemovingHandcuffs(RemovingHandcuffsEventArgs)

    Called before freeing a handcuffed Player.

    Declaration
    public static void OnRemovingHandcuffs(RemovingHandcuffsEventArgs ev)
    Parameters
    Type Name Description
    RemovingHandcuffsEventArgs ev

    The RemovingHandcuffsEventArgs instance.

    | Improve this Doc View Source

    OnReservedSlot(ReservedSlotsCheckEventArgs)

    Called before reserved slot is resolved for a Player.

    Declaration
    public static void OnReservedSlot(ReservedSlotsCheckEventArgs ev)
    Parameters
    Type Name Description
    ReservedSlotsCheckEventArgs ev

    The ReservedSlotsCheckEventArgs instance.

    | Improve this Doc View Source

    OnRevokingMute(RevokingMuteEventArgs)

    Called before unmuting a user.

    Declaration
    public static void OnRevokingMute(RevokingMuteEventArgs ev)
    Parameters
    Type Name Description
    RevokingMuteEventArgs ev

    The RevokingMuteEventArgs instance.

    | Improve this Doc View Source

    OnSearchPickupRequest(SearchingPickupEventArgs)

    Called before a Player searches a Pickup.

    Declaration
    public static void OnSearchPickupRequest(SearchingPickupEventArgs ev)
    Parameters
    Type Name Description
    SearchingPickupEventArgs ev

    The SearchingPickupEventArgs instance.

    | Improve this Doc View Source

    OnSendingAdminChatMessage(SendingAdminChatMessageEventsArgs)

    Called before a Player searches a Pickup.

    Declaration
    public static void OnSendingAdminChatMessage(SendingAdminChatMessageEventsArgs ev)
    Parameters
    Type Name Description
    SendingAdminChatMessageEventsArgs ev

    The SendingAdminChatMessageEventsArgs instance.

    | Improve this Doc View Source

    OnShooting(ShootingEventArgs)

    Called before a Player shoots a weapon.

    Declaration
    public static void OnShooting(ShootingEventArgs ev)
    Parameters
    Type Name Description
    ShootingEventArgs ev

    The ShootingEventArgs instance.

    | Improve this Doc View Source

    OnShot(ShotEventArgs)

    Called after a Player shoots a weapon.

    Declaration
    public static void OnShot(ShotEventArgs ev)
    Parameters
    Type Name Description
    ShotEventArgs ev

    The ShotEventArgs instance.

    | Improve this Doc View Source

    OnSpawned(SpawnedEventArgs)

    Called after a Player has spawned.

    Declaration
    public static void OnSpawned(SpawnedEventArgs ev)
    Parameters
    Type Name Description
    SpawnedEventArgs ev

    The SpawnedEventArgs instance.

    | Improve this Doc View Source

    OnSpawnedRagdoll(SpawnedRagdollEventArgs)

    Called after spawning a Player ragdoll.

    Declaration
    public static void OnSpawnedRagdoll(SpawnedRagdollEventArgs ev)
    Parameters
    Type Name Description
    SpawnedRagdollEventArgs ev

    The SpawnedRagdollEventArgs instance.

    | Improve this Doc View Source

    OnSpawning(SpawningEventArgs)

    Called before spawning a Player.

    Declaration
    public static void OnSpawning(SpawningEventArgs ev)
    Parameters
    Type Name Description
    SpawningEventArgs ev

    The SpawningEventArgs instance.

    | Improve this Doc View Source

    OnSpawningRagdoll(SpawningRagdollEventArgs)

    Called before spawning a Player ragdoll.

    Declaration
    public static void OnSpawningRagdoll(SpawningRagdollEventArgs ev)
    Parameters
    Type Name Description
    SpawningRagdollEventArgs ev

    The SpawningRagdollEventArgs instance.

    | Improve this Doc View Source

    OnStayingOnEnvironmentalHazard(StayingOnEnvironmentalHazardEventArgs)

    Called when a Player stays on an environmental hazard.

    Declaration
    public static void OnStayingOnEnvironmentalHazard(StayingOnEnvironmentalHazardEventArgs ev)
    Parameters
    Type Name Description
    StayingOnEnvironmentalHazardEventArgs ev

    The StayingOnEnvironmentalHazardEventArgs instance.

    | Improve this Doc View Source

    OnStoppingGenerator(StoppingGeneratorEventArgs)

    Called before a Player turns off the generator by switching lever.

    Declaration
    public static void OnStoppingGenerator(StoppingGeneratorEventArgs ev)
    Parameters
    Type Name Description
    StoppingGeneratorEventArgs ev

    The StoppingGeneratorEventArgs instance.

    | Improve this Doc View Source

    OnThrowingProjectile(ThrownProjectileEventArgs)

    Called before throwing a grenade.

    Declaration
    public static void OnThrowingProjectile(ThrownProjectileEventArgs ev)
    Parameters
    Type Name Description
    ThrownProjectileEventArgs ev

    The ThrownProjectileEventArgs instance.

    | Improve this Doc View Source

    OnThrowingRequest(ThrowingRequestEventArgs)

    Called before receving a throwing request.

    Declaration
    public static void OnThrowingRequest(ThrowingRequestEventArgs ev)
    Parameters
    Type Name Description
    ThrowingRequestEventArgs ev

    The ThrowingRequestEventArgs instance.

    | Improve this Doc View Source

    OnTogglingFlashlight(TogglingFlashlightEventArgs)

    Called before a Player toggles the flashlight.

    Declaration
    public static void OnTogglingFlashlight(TogglingFlashlightEventArgs ev)
    Parameters
    Type Name Description
    TogglingFlashlightEventArgs ev

    The TogglingFlashlightEventArgs instance.

    | Improve this Doc View Source

    OnTogglingNoClip(TogglingNoClipEventArgs)

    Called before a Player toggles the NoClip mode.

    Declaration
    public static void OnTogglingNoClip(TogglingNoClipEventArgs ev)
    Parameters
    Type Name Description
    TogglingNoClipEventArgs ev

    The TogglingNoClipEventArgs instance.

    | Improve this Doc View Source

    OnTogglingOverwatch(TogglingOverwatchEventArgs)

    Called before a Player toggles overwatch.

    Declaration
    public static void OnTogglingOverwatch(TogglingOverwatchEventArgs ev)
    Parameters
    Type Name Description
    TogglingOverwatchEventArgs ev

    The TogglingOverwatchEventArgs instance.

    | Improve this Doc View Source

    OnTogglingRadio(TogglingRadioEventArgs)

    Called before turning the radio on/off.

    Declaration
    public static void OnTogglingRadio(TogglingRadioEventArgs ev)
    Parameters
    Type Name Description
    TogglingRadioEventArgs ev

    The TogglingRadioEventArgs instance.

    | Improve this Doc View Source

    OnTogglingWeaponFlashlight(TogglingWeaponFlashlightEventArgs)

    Called before a Player toggles the weapon's flashlight.

    Declaration
    public static void OnTogglingWeaponFlashlight(TogglingWeaponFlashlightEventArgs ev)
    Parameters
    Type Name Description
    TogglingWeaponFlashlightEventArgs ev

    The TogglingWeaponFlashlightEventArgs instance.

    | Improve this Doc View Source

    OnTransmitting(TransmittingEventArgs)

    Called after a Player presses the transmission key.

    Declaration
    public static void OnTransmitting(TransmittingEventArgs ev)
    Parameters
    Type Name Description
    TransmittingEventArgs ev

    The TransmittingEventArgs instance.

    | Improve this Doc View Source

    OnTriggeringTesla(TriggeringTeslaEventArgs)

    Called before a Player triggers a tesla.

    Declaration
    public static void OnTriggeringTesla(TriggeringTeslaEventArgs ev)
    Parameters
    Type Name Description
    TriggeringTeslaEventArgs ev

    The TriggeringTeslaEventArgs instance.

    | Improve this Doc View Source

    OnUnloadingWeapon(UnloadingWeaponEventArgs)

    Called before a Player unloads a weapon.

    Declaration
    public static void OnUnloadingWeapon(UnloadingWeaponEventArgs ev)
    Parameters
    Type Name Description
    UnloadingWeaponEventArgs ev

    The UnloadingWeaponEventArgs instance.

    | Improve this Doc View Source

    OnUnlockingGenerator(UnlockingGeneratorEventArgs)

    Called before a Player unlocks a generator.

    Declaration
    public static void OnUnlockingGenerator(UnlockingGeneratorEventArgs ev)
    Parameters
    Type Name Description
    UnlockingGeneratorEventArgs ev

    The UnlockingGeneratorEventArgs instance.

    | Improve this Doc View Source

    OnUsedItem(UsedItemEventArgs)

    Called after a Player used a Usable item.

    Declaration
    public static void OnUsedItem(UsedItemEventArgs ev)
    Parameters
    Type Name Description
    UsedItemEventArgs ev

    The UsedItemEventArgs instance.

    | Improve this Doc View Source

    OnUsingItem(UsingItemEventArgs)

    Called before using a usable item.

    Declaration
    public static void OnUsingItem(UsingItemEventArgs ev)
    Parameters
    Type Name Description
    UsingItemEventArgs ev

    The UsingItemEventArgs instance.

    | Improve this Doc View Source

    OnUsingItemCompleted(UsingItemCompletedEventArgs)

    Called before completed using of a usable item.

    Declaration
    public static void OnUsingItemCompleted(UsingItemCompletedEventArgs ev)
    Parameters
    Type Name Description
    UsingItemCompletedEventArgs ev

    The UsingItemEventArgs instance.

    | Improve this Doc View Source

    OnUsingMicroHIDEnergy(UsingMicroHIDEnergyEventArgs)

    Called before a Player MicroHID energy is changed.

    Declaration
    public static void OnUsingMicroHIDEnergy(UsingMicroHIDEnergyEventArgs ev)
    Parameters
    Type Name Description
    UsingMicroHIDEnergyEventArgs ev

    The UsingMicroHIDEnergyEventArgs instance.

    | Improve this Doc View Source

    OnUsingRadioBattery(UsingRadioBatteryEventArgs)

    Called before a user's radio battery charge is changed.

    Declaration
    public static void OnUsingRadioBattery(UsingRadioBatteryEventArgs ev)
    Parameters
    Type Name Description
    UsingRadioBatteryEventArgs ev

    The UsingRadioBatteryEventArgs instance.

    | Improve this Doc View Source

    OnVerified(VerifiedEventArgs)

    Called after a Player has been verified.

    Declaration
    public static void OnVerified(VerifiedEventArgs ev)
    Parameters
    Type Name Description
    VerifiedEventArgs ev

    The VerifiedEventArgs instance.

    | Improve this Doc View Source

    OnVoiceChatting(VoiceChattingEventArgs)

    Invoked after a Player presses the voicechat key.

    Declaration
    public static void OnVoiceChatting(VoiceChattingEventArgs ev)
    Parameters
    Type Name Description
    VoiceChattingEventArgs ev

    The VoiceChattingEventArgs instance.

    Extension Methods

    ReflectionExtensions.CopyProperties(Object, Object)
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX