Class FpcRole

Defines a role that represents an fpc class.

Inheritance

System.Object

TypeCastObject<Role>

Role

FpcRole

HumanRole

Scp0492Role

Scp049Role

Scp096Role

Scp106Role

Scp173Role

Scp3114Role

Scp939Role

Implements

IWrapper<PlayerRoles.PlayerRoleBase>

Inherited Members

Role.Owner

Role.Type

Role.Base

Role.SpawnReason

Role.SpawnFlags

Role.Team

Role.Side

Role.Color

Role.Name

Role.ActiveTime

Role.IsDead

Role.IsAlive

Role.IsValid

Role.RandomSpawnLocation

Role.Equals(Object)

Role.ToString()

Role.GetHashCode()

Role.Set(RoleTypeId, SpawnReason)

Role.Set(RoleTypeId, RoleSpawnFlags)

Role.Set(RoleTypeId, SpawnReason, RoleSpawnFlags)

TypeCastObject<Role>.Cast<TObject>()

TypeCastObject<Role>.Cast<TObject>(TObject)

TypeCastObject<Role>.As<TObject>()

TypeCastObject<Role>.Is<TObject>(TObject)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Exiled.API.Features.Roles

Assembly: Exiled.API.dll

Syntax

public abstract class FpcRole : Role, IWrapper<PlayerRoleBase>

Constructors

FpcRole(FpcStandardRoleBase)

Initializes a new instance of the FpcRole class.

Declaration

protected FpcRole(FpcStandardRoleBase baseRole)

Parameters

Type	Name	Description
PlayerRoles.FirstPersonControl.FpcStandardRoleBase	baseRole	the base PlayerRoles.PlayerRoleBase.

Properties

CanSendInputs

Gets a value indicating whether or not the player can send inputs.

Declaration

public bool CanSendInputs { get; }

Property Value

Type	Description
System.Boolean

CrouchingSpeed

Gets or sets the Role crouching speed.

Declaration

public float CrouchingSpeed { get; set; }

Property Value

Type	Description
System.Single

FirstPersonController

Gets the FirstPersonController.

Declaration

public FpcStandardRoleBase FirstPersonController { get; }

Property Value

Type	Description
PlayerRoles.FirstPersonControl.FpcStandardRoleBase

HorizontalRotation

Gets the Player's horizontal rotation.

Declaration

public float HorizontalRotation { get; }

Property Value

Type	Description
System.Single

IsAfk

Gets a value indicating whether or not the Player is AFK.

Declaration

public bool IsAfk { get; }

Property Value

Type	Description
System.Boolean

IsCrouching

Gets a value indicating whether the Player is crouching or not.

Declaration

public bool IsCrouching { get; }

Property Value

Type	Description
System.Boolean

IsGrounded

Gets a value indicating whether or not the player is on the ground.

Declaration

public bool IsGrounded { get; }

Property Value

Type	Description
System.Boolean

IsHumeShieldedRole

Gets a value indicating whether or not this role is protected by a hume shield.

Declaration

public bool IsHumeShieldedRole { get; }

Property Value

Type	Description
System.Boolean

IsInDarkness

Gets a value indicating whether or not the Player is in darkness.

Declaration

public bool IsInDarkness { get; }

Property Value

Type	Description
System.Boolean

IsInvisible

Gets or sets a value indicating whether or not the player is invisible.

Declaration

public bool IsInvisible { get; set; }

Property Value

Type	Description
System.Boolean

IsInvisibleFor

Gets a list of players who can't see the player.

Declaration

public HashSet<Player> IsInvisibleFor { get; }

Property Value

Type	Description
System.Collections.Generic.HashSet<Player>

IsNoclipEnabled

Gets or sets a value indicating whether or not the player has noclip enabled.

Declaration

public bool IsNoclipEnabled { get; set; }

Property Value

Type	Description
System.Boolean	System.Boolean indicating status.

Remarks

For permitting a player to enter and exit noclip freely, see IsNoclipPermitted.

See Also

IsNoclipPermitted

IsUsingStamina

Gets or sets a value indicating whether or not the player should use stamina system. Resets on death.

Declaration

public bool IsUsingStamina { get; set; }

Property Value

Type	Description
System.Boolean

JumpingSpeed

Gets or sets the Role jumping speed.

Declaration

public float JumpingSpeed { get; set; }

Property Value

Type	Description
System.Single

MovementDetected

Gets or sets a value indicating whether if a movement is detected on a Player.

Declaration

public bool MovementDetected { get; set; }

Property Value

Type	Description
System.Boolean

MovementSpeed

Gets the Player's current movement speed.

Declaration

public virtual float MovementSpeed { get; }

Property Value

Type	Description
System.Single

MoveState

Gets or sets the player's current PlayerRoles.FirstPersonControl.PlayerMovementState.

Declaration

public PlayerMovementState MoveState { get; set; }

Property Value

Type	Description
PlayerRoles.FirstPersonControl.PlayerMovementState

RelativePosition

Gets or sets the player's relative position.

Declaration

public RelativePosition RelativePosition { get; set; }

Property Value

Type	Description
RelativePositioning.RelativePosition

RotationDetected

Gets or sets a value indicating whether if a rotation is detected on the player.

Declaration

public bool RotationDetected { get; set; }

Property Value

Type	Description
System.Boolean

SprintingSpeed

Gets or sets the Role sprinting speed.

Declaration

public float SprintingSpeed { get; set; }

Property Value

Type	Description
System.Single

StaminaRegenMultiplier

Gets or sets the stamina regen multiplier. Resets on death.

Declaration

public float StaminaRegenMultiplier { get; set; }

Property Value

Type	Description
System.Single

StaminaUsageMultiplier

Gets or sets the stamina usage multiplier. Resets on death.

Declaration

public float StaminaUsageMultiplier { get; set; }

Property Value

Type	Description
System.Single

Velocity

Gets or sets the Player velocity.

Declaration

public Vector3 Velocity { get; set; }

Property Value

Type	Description
UnityEngine.Vector3

VerticalRotation

Gets the Player's vertical rotation.

Declaration

public float VerticalRotation { get; }

Property Value

Type	Description
System.Single

WalkingSpeed

Gets or sets the Role walking speed.

Declaration

public float WalkingSpeed { get; set; }

Property Value

Type	Description
System.Single

Methods

Finalize()

Finalizes an instance of the FpcRole class.

Declaration

protected void Finalize()

ResetStamina(Boolean)

Resets the Player's stamina.

Declaration

public void ResetStamina(bool multipliers = false)

Parameters

Type	Name	Description
System.Boolean	multipliers	Resets StaminaUsageMultiplier and StaminaRegenMultiplier.

Implements

IWrapper<T>

Extension Methods

ReflectionExtensions.CopyProperties(Object, Object)