ProjectileMoveComponent Interface Reference

Inheritance diagram for ProjectileMoveComponent:

Public Member Functions
proto external void	EnableSimulation (IEntity owner)
proto external void	Launch (vector direction, vector parentVelocity, float initSpeedCoef, IEntity projectileEntity, IEntity gunner, IEntity parentEntity, IEntity lockedTarget, IEntity weaponComponent)
proto external vector	GetProjectileSimulationResult (vector initPosition, float initSpeed, float initElevationAngle, float initAzimuth=0, vector windSpeed=vector.Zero, float targetHeight=0, bool mustFallDown=true, float maxSimulationTime=-1, float maxHorizontalDistance=-1)
	Predicts the projectile simulation result (there's no interaction with the world).
proto external vector	GetVelocity ()
proto external float	GetRewindDuration ()
	Queries the rewind duration (equal to the RTT of the remote shooter's connection at the time of the shot) from the projectile for lag compensation.
proto external void	SetRewindDuration (float duration)
	Sets the rewind duration (equal to the RTT of the remote shooter's connection) of the projectile for lag compensation.
proto external float	GetBulletSpeedCoef ()
	Gets the bullet speed coef of this bullet.
proto external void	SetBulletCoef (float coef)
	Sets the bullet speed coef of this bullet.
Public Member Functions inherited from BaseProjectileComponent
proto external Instigator	GetInstigator ()
proto external void	SetInstigator (notnull Instigator instigator)
proto external IEntity	GetParentProjectile ()
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Additional Inherited Members
Protected Member Functions inherited from GameComponent
void	OnDelete (IEntity owner)
	Called when Entity is being to be destroyed (deleted) or component to be deleted.

Member Function Documentation

EnableSimulation()

proto external void ProjectileMoveComponent.EnableSimulation

(

IEntity

owner

)

GetBulletSpeedCoef()

proto external float ProjectileMoveComponent.GetBulletSpeedCoef

(

)

Gets the bullet speed coef of this bullet.

Init speed gets created with muzzle bullet speed coef and this bullet speed coef. (Used for i.e. mortar charge rings)

Returns

Bullet speed coef.

Warning

Value does not return total speed coef but just the value set on the bullet. For total: multiply bullet speed coef from muzzle with this value.

GetProjectileSimulationResult()

proto external vector ProjectileMoveComponent.GetProjectileSimulationResult	(	vector	initPosition,
		float	initSpeed,
		float	initElevationAngle,
		float	initAzimuth = 0,
		vector	windSpeed = vector.Zero,
		float	targetHeight = 0,
		bool	mustFallDown = true,
		float	maxSimulationTime = -1,
		float	maxHorizontalDistance = -1 )

Predicts the projectile simulation result (there's no interaction with the world).

Only works when projectile debugging is enabled.

Parameters

initPosition	launch position.
initSpeed	launch speed.
initElevationAngle	elevation angle in degrees.
initAzimuth	azimuth angle in degrees.
windSpeed	wind velocity.
targetHeight	target height that the projectile must reach before simulation ends.
mustFallDown	if true, the projectile must fall down below this height for simulation to end. if false, projectile should simply reach this height.
maxSimulationTime	maximum simulation time in seconds. if maxSimulationTime <= 0, 60s is used.
maxHorizontalDistance	maximum distance along the launch azimuth direction. if value < 0, 10km is used

Returns

The final position of the projectile (either reached target or time expired)

GetRewindDuration()

proto external float ProjectileMoveComponent.GetRewindDuration

(

)

Queries the rewind duration (equal to the RTT of the remote shooter's connection at the time of the shot) from the projectile for lag compensation.

Warning

This has to be performed on authority, and before a shell is launched or on non-network shots, the return value will be zero.

Returns

The current rewind duration in seconds.

GetVelocity()

proto external vector ProjectileMoveComponent.GetVelocity

(

)

Launch()

proto external void ProjectileMoveComponent.Launch	(	vector	direction,
		vector	parentVelocity,
		float	initSpeedCoef,
		IEntity	projectileEntity,
		IEntity	gunner,
		IEntity	parentEntity,
		IEntity	lockedTarget,
		IEntity	weaponComponent )

SetBulletCoef()

proto external void ProjectileMoveComponent.SetBulletCoef

(

float

coef

)

Sets the bullet speed coef of this bullet.

Init speed gets created with muzzle bullet speed coef and this bullet speed coef. (Used for i.e. mortar charge rings)

Parameters

coef	New bullet speed coef

Warning

Value does not set total speed coef but just the value set on the bullet. For total: multiply bullet speed coef from muzzle with this value.

SetRewindDuration()

proto external void ProjectileMoveComponent.SetRewindDuration

(

float

duration

)

Sets the rewind duration (equal to the RTT of the remote shooter's connection) of the projectile for lag compensation.

Parameters

duration

The new rewind duration in milliseconds.

Warning

This has to be performed on authority, and must be done after the shell is launched.

---

The documentation for this interface was generated from the following file:

• Game/generated/Projectile/ProjectileMoveComponent.c