Superfighters Deluxe
IProjectile Class Referenceabstract

Access to certain information and functions about a projectile. More...

Inheritance diagram for IProjectile:
abstract ProjectileItem ProjectileItem [get]
 Gets the projectile item ID of this projectile. More...
 
abstract int InstanceID [get]
 Gets the instance ID of this projectile. More...
 
abstract int OwnerPlayerID [get]
 Gets the projectile's current owner player uniqueID. This is reset when the projectile bounces or is deflected. More...
 
abstract int InitialOwnerPlayerID [get]
 Gets the projectile's initial owner player uniqueID. More...
 
abstract Vector2 Position [get, set]
 Gets or Sets the current position of the projectile. Note: Updating the position will disable tunneling checks in the ProjectileCreated event. More...
 
abstract Vector2 Direction [get, set]
 Gets or Sets the current direction of the projectile. More...
 
abstract Vector2 Velocity [get, set]
 Gets or Sets the current velocity that the projectile covers each second. Note: Sync over server-client assumes the velocity stays intact and changing this each update can make it look janky on clients. Note: You can not set a velocity greater than the max speed of the projectile and not set a velocity less than 100 in magnitude. More...
 
abstract float TotalDistanceTraveled [get]
 Gets the total distance the projectile has traveled. More...
 
abstract ProjectileProperties GetProperties ()
 Gets different properties for the projectile. More...
 
abstract int BounceCount [get, set]
 Gets number of reflections/bounces this projectile has performed. More...
 
abstract int PowerupTotalBounces [get]
 Gets the amount of maximum bounces before bounce powerup is considered done. More...
 
abstract bool PowerupBounceActive [get, set]
 Gets or Sets if the projectile has the bounce powerup attribute active. More...
 
abstract bool PowerupFireActive [get, set]
 Gets or Sets if the projectile has the fire powerup attribute active. More...
 
abstract float DamageDealtModifier [get, set]
 Gets or Sets damage modifier for the projectile. Defaults to 1 and is set from player modifiers when shot from a player. More...
 
abstract float CritChanceDealtModifier [get, set]
 Gets or Sets crit chance modifier for the projectile. Defaults to 1 and is set from player modifiers when shot from a player. More...
 
abstract void FlagForRemoval ()
 Flags the projectile to be removed the next update cycle. More...
 
abstract bool IsRemoved [get]
 Gets is this projectile is removed from the game and no longer active. More...
 

Detailed Description

Access to certain information and functions about a projectile.

Member Function Documentation

◆ FlagForRemoval()

abstract void FlagForRemoval ( )
pure virtual

Flags the projectile to be removed the next update cycle.

◆ GetProperties()

abstract ProjectileProperties GetProperties ( )
pure virtual

Gets different properties for the projectile.

Property Documentation

◆ BounceCount

abstract int BounceCount
getset

Gets number of reflections/bounces this projectile has performed.

◆ CritChanceDealtModifier

abstract float CritChanceDealtModifier
getset

Gets or Sets crit chance modifier for the projectile. Defaults to 1 and is set from player modifiers when shot from a player.

◆ DamageDealtModifier

abstract float DamageDealtModifier
getset

Gets or Sets damage modifier for the projectile. Defaults to 1 and is set from player modifiers when shot from a player.

◆ Direction

abstract Vector2 Direction
getset

Gets or Sets the current direction of the projectile.

◆ InitialOwnerPlayerID

abstract int InitialOwnerPlayerID
get

Gets the projectile's initial owner player uniqueID.

◆ InstanceID

abstract int InstanceID
get

Gets the instance ID of this projectile.

◆ IsRemoved

abstract bool IsRemoved
get

Gets is this projectile is removed from the game and no longer active.

◆ OwnerPlayerID

abstract int OwnerPlayerID
get

Gets the projectile's current owner player uniqueID. This is reset when the projectile bounces or is deflected.

◆ Position

abstract Vector2 Position
getset

Gets or Sets the current position of the projectile. Note: Updating the position will disable tunneling checks in the ProjectileCreated event.

◆ PowerupBounceActive

abstract bool PowerupBounceActive
getset

Gets or Sets if the projectile has the bounce powerup attribute active.

◆ PowerupFireActive

abstract bool PowerupFireActive
getset

Gets or Sets if the projectile has the fire powerup attribute active.

◆ PowerupTotalBounces

abstract int PowerupTotalBounces
get

Gets the amount of maximum bounces before bounce powerup is considered done.

◆ ProjectileItem

Gets the projectile item ID of this projectile.

◆ TotalDistanceTraveled

abstract float TotalDistanceTraveled
get

Gets the total distance the projectile has traveled.

◆ Velocity

abstract Vector2 Velocity
getset

Gets or Sets the current velocity that the projectile covers each second. Note: Sync over server-client assumes the velocity stays intact and changing this each update can make it look janky on clients. Note: You can not set a velocity greater than the max speed of the projectile and not set a velocity less than 100 in magnitude.