Class FlashGrenade
A wrapper class for InventorySystem.Items.ThrowableProjectiles.FlashbangGrenade.
Implements
Inherited Members
Namespace: Exiled.API.Features.Items
Assembly: Exiled.API.dll
Syntax
public class FlashGrenade : Throwable, IWrapper<ItemBase>, IWrapper<ThrowableItem>
Constructors
| Improve this Doc View SourceFlashGrenade(ThrowableItem)
Initializes a new instance of the FlashGrenade class.
Declaration
public FlashGrenade(ThrowableItem itemBase)
Parameters
Type | Name | Description |
---|---|---|
InventorySystem.Items.ThrowableProjectiles.ThrowableItem | itemBase | The base InventorySystem.Items.ThrowableProjectiles.ThrowableItem class. |
Properties
| Improve this Doc View SourceAdditionalBlindedEffect
Gets or sets the additional duration of the Blinded effect.
Declaration
public float AdditionalBlindedEffect { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
FuseTime
Gets or sets how long the fuse will last.
Declaration
public float FuseTime { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
MinimalDurationEffect
Gets or sets the minimum duration of player can take the effect.
Declaration
public float MinimalDurationEffect { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Projectile
Gets a FlashbangProjectile to change grenade properties.
Declaration
public FlashbangProjectile Projectile { get; }
Property Value
Type | Description |
---|---|
FlashbangProjectile |
SurfaceDistanceIntensifier
Gets or sets the how mush the flash grenade going to be intensified when explode at Surface.
Declaration
public float SurfaceDistanceIntensifier { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Methods
| Improve this Doc View SourceClone()
Clones current FlashGrenade object.
Declaration
public override Item Clone()
Returns
Type | Description |
---|---|
Item | New FlashGrenade object. |
Overrides
| Improve this Doc View SourceSpawnActive(Vector3, Player)
Spawns an active grenade on the map at the specified location.
Declaration
public FlashbangProjectile SpawnActive(Vector3 position, Player owner = null)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.Vector3 | position | The location to spawn the grenade. |
Player | owner | Optional: The Player owner of the grenade. |
Returns
Type | Description |
---|---|
FlashbangProjectile | Spawned grenade. |
ToString()
Returns the FlashGrenade in a human readable format.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | A string containing FlashGrenade-related data. |