BaseZeroingGenerator Interface Reference

BaseZeroingGenerator is an object used for generating zeroing information in Workbench. More...

Inheritance diagram for BaseZeroingGenerator:

Public Member Functions
proto external IEntity	GetOwnerEntity ()
	Gets the owning entity of the generator object, which might or might not be the same as the owner of the Sights component.
proto external BaseSightsComponent	GetSights ()
	Get the sights component that the zeroing is computed for.
proto external WeaponAnimationComponent	GetWeaponAnimationComponent ()
	Get the Weapon animation component of the sights.
proto external void	SetPointInfoGeneration (bool doGenerate)
	Flag the generation of PointInfo's.
proto external void	SetProjectileResource (ResourceName resourceName)

Detailed Description

BaseZeroingGenerator is an object used for generating zeroing information in Workbench.

Member Function Documentation

GetOwnerEntity()

proto external IEntity BaseZeroingGenerator.GetOwnerEntity

(

)

Gets the owning entity of the generator object, which might or might not be the same as the owner of the Sights component.

GetSights()

proto external BaseSightsComponent BaseZeroingGenerator.GetSights

(

)

Get the sights component that the zeroing is computed for.

GetWeaponAnimationComponent()

proto external WeaponAnimationComponent BaseZeroingGenerator.GetWeaponAnimationComponent

(

)

Get the Weapon animation component of the sights.

This will might be nullptr if the sights do not have a WeaponAnimationComponent, like e.g. with the UGL's.

SetPointInfoGeneration()

proto external void BaseZeroingGenerator.SetPointInfoGeneration

(

bool

doGenerate

)

Flag the generation of PointInfo's.

Normal operation is to generate a PointInfo with every SightRangeInfo generated, but some zeroing mechanisms like the PiP scopes don't need it.

By default, PointInfo is generated, so this really only needs to be called in case they are unwanted.

Parameters

doGenerate

boolean flag. If true, PointInfo's are generated. If false, they are not.

SetProjectileResource()

proto external void BaseZeroingGenerator.SetProjectileResource

(

ResourceName

resourceName

)

---

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

• Game/generated/BaseZeroingGenerator.c