Class MyProjectileHitInfo

Describes information projectile about projectile hit. (mods interface) You can change values

Inheritance

System.Object

MyProjectileHitInfo

Namespace: Sandbox.ModAPI

Assembly: Sandbox.Common.dll

Syntax

public class MyProjectileHitInfo : Object

Constructors

MyProjectileHitInfo()

Declaration

public MyProjectileHitInfo()

Fields

AddDecals

When it is false, decals wont be added (default = true)

Declaration

public bool AddDecals

Field Value

Type	Description
System.Boolean

AddHitIndicator

When it is false, player wont see hit indicator

Declaration

public bool AddHitIndicator

Field Value

Type	Description
System.Boolean

AddHitParticles

When it is false, player wont see hit particles (default = true)

Declaration

public bool AddHitParticles

Field Value

Type	Description
System.Boolean

AddSZNotification

When it is false, player wont see safe zone notification (default = true)

Declaration

public bool AddSZNotification

Field Value

Type	Description
System.Boolean

Damage

Damage that would

Declaration

public float Damage

Field Value

Type	Description
System.Single

HitEntity

Entity that was hitted by projectile

Declaration

public IMyEntity HitEntity

Field Value

Type	Description
IMyEntity

HitMaterial

Material that hitted by projectile

Declaration

public MyStringHash HitMaterial

Field Value

Type	Description
MyStringHash

HitNormal

Hit normal

Declaration

public Vector3 HitNormal

Field Value

Type	Description
Vector3

HitPosition

World coordinates of projectile hit

Declaration

public Vector3D HitPosition

Field Value

Type	Description
Vector3D

HitShapeKey

Used in GetSurfaceAndMaterial(IMyEntity, ref LineD, ref Vector3D, UInt32, out MySurfaceImpactEnum, out MyStringHash)

Declaration

public uint HitShapeKey

Field Value

Type	Description
System.UInt32

HitVoxelMaterial

Voxel Material that hit by projectile

Declaration

public MyStringHash HitVoxelMaterial

Field Value

Type	Description
MyStringHash

Impulse

Impulse, that would be applied to HitEntity

Declaration

public Vector3 Impulse

Field Value

Type	Description
Vector3

PlayHitSound

When it is false, player wont hear hit sound (default = true)

Declaration

public bool PlayHitSound

Field Value

Type	Description
System.Boolean

Velocity

Velocity of projectile before hit

Declaration

public Vector3D Velocity

Field Value

Type	Description
Vector3D

Methods

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String