Class Projectile

Namespace

Exiled.API.Features.Pickups.Projectiles

Assembly

Exiled.API.dll

A wrapper class for Projectile.

public class Projectile : Pickup, IWrapper<ItemPickupBase>, IWorldSpace, IPosition, IRotation, IWrapper<ThrownProjectile>

Inheritance

object

TypeCastObject<Pickup>

Pickup

Projectile

Implements

IWrapper<ItemPickupBase>

IWorldSpace

IPosition

IRotation

IWrapper<ThrownProjectile>

Derived

TimeGrenadeProjectile

Inherited Members

Pickup.List

Pickup.GameObject

Pickup.Transform

Pickup.Rigidbody

Pickup.Room

Pickup.PhysicsModule

Pickup.Serial

Pickup.Scale

Pickup.Weight

Pickup.PickupTime

Pickup.Type

Pickup.Category

Pickup.IsLocked

Pickup.Info

Pickup.PreviousOwner

Pickup.InUse

Pickup.Position

Pickup.RelativePosition

Pickup.Rotation

Pickup.IsSpawned

Pickup.Get(ItemPickupBase)

Pickup.Get<T>(ItemPickupBase)

Pickup.Get(ushort)

Pickup.Get(GameObject)

Pickup.Get(IEnumerable<ItemPickupBase>)

Pickup.Get(ItemType)

Pickup.Get(IEnumerable<GameObject>)

Pickup.Get<T>(IEnumerable<ItemPickupBase>)

Pickup.Get<T>(ItemType)

Pickup.Get<T>(IEnumerable<GameObject>)

Pickup.Create(ItemType)

Pickup.Create<T>(ItemType)

Pickup.CreateAndSpawn(ItemType, Vector3, Quaternion?, Player)

Pickup.CreateAndSpawn<T>(ItemType, Vector3, Quaternion?, Player)

Pickup.PickupTimeForPlayer(Player)

Pickup.Spawn()

Pickup.Spawn(Vector3, Quaternion?, Player)

Pickup.UnSpawn()

Pickup.Destroy()

Pickup.Clone()

Pickup.InitializeProperties(ItemBase)

TypeCastObject<Pickup>.Cast<TObject>()

TypeCastObject<Pickup>.Cast<TObject>(out TObject)

TypeCastObject<Pickup>.As<TObject>()

TypeCastObject<Pickup>.Is<TObject>(out TObject)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Base

Gets the InventorySystem.Items.ThrowableProjectiles.ThrownProjectile that this class is encapsulating.

public ThrownProjectile Base { get; }

Property Value

ThrownProjectile

ProjectileType

Gets the ProjectileType of the item.

public ProjectileType ProjectileType { get; }

Property Value

ProjectileType

Methods

Activate()

Activates the current Projectile.

public void Activate()

Create(ProjectileType)

Creates and returns a new Projectile with the proper inherited subclass.

Based on the projectiletype, the returned Projectile can be casted into a subclass to gain more control over the object.
The following have their own respective classes:
- FragGrenade can be casted to ExplosionGrenadeProjectile.
- Flashbang can be casted to FlashbangProjectile.
- Scp018 A and B variants can be casted to Scp018Projectile.
- Scp2176 can be casted to Scp2176Projectile.

Projectile that are not listed will cause an Exception.

public static Projectile Create(ProjectileType projectiletype)

Parameters

projectiletype ProjectileType

The ProjectileType of the projectile.

Returns

Projectile

The created Projectile.

CreateAndSpawn(ProjectileType, Vector3, Quaternion?, bool, Player)

Creates and spawns a Projectile.

public static Projectile CreateAndSpawn(ProjectileType type, Vector3 position, Quaternion? rotation = null, bool shouldBeActive = true, Player previousOwner = null)

Parameters

type ProjectileType

The ProjectileType of the projectile.

position Vector3

The position to spawn the Projectile at.

rotation Quaternion?

The rotation to spawn the Projectile.

shouldBeActive bool

Whether the Projectile should be in active state after spawn.

previousOwner Player

An optional previous owner of the item.

Returns

Projectile

The Projectile. See documentation of Create(ProjectileType) for more information on casting.

CreateAndSpawn<T>(ProjectileType, Vector3, Quaternion?, bool, Player)

Creates and spawns a Projectile.

public static T CreateAndSpawn<T>(ProjectileType type, Vector3 position, Quaternion? rotation = null, bool shouldBeActive = true, Player previousOwner = null) where T : Projectile

Parameters

type ProjectileType

The ProjectileType of the projectile.

position Vector3

The position to spawn the Projectile at.

rotation Quaternion?

The rotation to spawn the Projectile.

shouldBeActive bool

Whether the Projectile should be in active state after spawn.

previousOwner Player

An optional previous owner of the item.

Returns

T

The Projectile. See documentation of Create(ProjectileType) for more information on casting.

Type Parameters

T

The specified Projectile type.

Create<T>(ProjectileType)

Creates and returns a new Projectile with the proper inherited subclass.

Based on the projectiletype, the returned Projectile can be casted into a subclass to gain more control over the object.
The following have their own respective classes:
- FragGrenade can be casted to ExplosionGrenadeProjectile.
- Flashbang can be casted to FlashbangProjectile.
- Scp018 A and B variants can be casted to Scp018Projectile.
- Scp2176 can be casted to Scp2176Projectile.

Projectile that are not listed will cause an Exception.

public static T Create<T>(ProjectileType projectiletype) where T : Projectile

Parameters

projectiletype ProjectileType

The ProjectileType of the projectile.

Returns

T

The created Projectile.

Type Parameters

T

The specified Projectile type.

Spawn(Vector3, Quaternion?, bool, Player)

Spawns a Projectile.

public Projectile Spawn(Vector3 position, Quaternion? rotation = null, bool shouldBeActive = true, Player previousOwner = null)

Parameters

position Vector3

The position to spawn the Projectile at.

rotation Quaternion?

The rotation to spawn the Projectile.

shouldBeActive bool

Whether the Projectile should be in active state after spawn.

previousOwner Player

An optional previous owner of the item.

Returns

Projectile

The spawned Projectile.

ToString()

Returns the ProjectilePickup in a human readable format.

public override string ToString()

Returns

string

A string containing ProjectilePickup-related data.