fort_multi_trace_weapon_component class

Base class for authoring logic and data in the SceneGraph. Using components you can author re-usable building blocks of logic and data which can then be added to entities in the scene.

Components are a very low level building block which can be used in many ways. For example:

• Exposing engine level concepts like mesh or sound
• Adding gameplay capabilities like damage or interaction
• Storing an inventory for a character in the game

As components are generic there is no specific way that they must be used. It is up to the needs of your experience if you use one big game component or if you break up logic into many small components.

Classes deriving from component must also specify <final_super> to be added to entities. This ensures the class will always derive directly from component. Further subclassing of the initial derived component is allowed and does not require specifying <final_super> on the derived classes.

Only one instance of a component from each subclass group can be added to an entity at a time. For example, given this group of components, only one light_component can exist on a single entity. To create multiple lights you should use multiple entities.

light_component := class(component){} capsule_light_component := class(light_component){} directional_light_component := class(light_component){} spot_light_component := class(light_component){} sphere_light_component := class(light_component){} rect_light_component := class(light_component){}

============================================================================== Component Lifetime

Components move through a series of lifetime functions as they are added to entities, added to the scene, and begin running in the simulation. Components should override these methods to perform setup and run their simulation.

As a component shuts down it will then move through shutdown version of these functions, giving users the opportunity to clean up any retained state on the component before it is disposed . Lifetime Methods: OnAddedToScene OnBeginSimulation -> OnSimulate OnEndSimulation OnRemovingFromScene ==============================================================================

Base component for weapon related properties

The component on weapons entities like pistols and assault rifles for tweaking weapon properties

The multiplier that affects the recoil of the weapon when aiming down sights

The multiplier that affects the weapon spread while aiming down sights

The sounds to use when ending aiming down sights

The sounds to use when starting aiming down sights

The particle system to use for weapon bullet shells

The number of bullets to fire per shot

The particle system to use for weapon bullet tracers. The FX system's HitDistance parameter will update with impact distance or max range of the weapon.

The multiplier that affects the weapon spread cooldown over time when not shooting

The multiplier that affects the weapon spread while crouching

The damage dealt by the weapon

The transform by which to offset the bullet shell ejection FX

The parent entity of this component.

• Components must have a parent entity pointer provided when being constructed.
• Components cannot be moved between parents.

The damage multiplier for the environment

The sounds to use when equipping the weapon

The multiplier that affects the weapon spread expansion per shot

The fire rate of the weapon

Event that is signalled when the weapon holster state changes

The multiplier that affects the weapon spread while idle

Indicates whether the weapon is currently holstered

The magazine size of the weapon

The max range of the weapon

The multiplier that affects the weapon spread while moving

The particle system to use for weapon muzzle flash

The transform by which to offset the weapon muzzle

The sounds to use when the weapon is out of ammo

Range based damage multiplier

The multiplier that affects the recoil of the weapon

The sounds to use when finishing a reload

The sounds to use when inserting a magazine during reload

The sounds to use when starting a reload

The reload time of the weapon

The amount of ammo consumed per shot

The multiplier that affects the weapon spread while sliding

The multiplier that affects the weapon spread while sprinting

Set callbacks to TickEvents.PrePhysics and TickEvents.PostPhysics to receive per-frame updates before and after physics is updated on your object.

The sounds to use when firing the weapon

Succeeds if the component is currently in the scene.

• After OnAddedToScene is called this call succeeds.
• After OnRemovingFromScene is called this call fails.

Succeeds if the component is currently simulating.

• After OnBeginSimulation is called this call succeeds.
• After OnEndSimulation is called this call fails.

Called when the component is added to the scene by parenting it under the simulation entity or another entity already in the scene.

• Querying for components in the scene is valid after this phase completes.

Called when the component begins simulating within the scene.

• Use this to set up TickEvent callbacks or other setup that must be guaranteed to complete immediately.
• OnAddedToScene is guaranteed to run before OnBeginSimulation.

Called when the component ends simulation within the scene.

• Simulation ends on a component when the experience resets, the parent entity is removed from the scene.
• Cached TickEvents cancelables should be canceled in OnEndSimulation.
• OnSimulate task will be canceled before OnEndSimulation is called.
• OnEndSimulation is only called on components that have already had OnBeginSimulation called.

Respond to a scene event. Return true to consume the event and halt propagation to the next entity.

Called when the component is about to be removed from the scene.

• Components are removed from a scene when the parent entity is removed from the scene.
• OnRemovingFromScene is only called on components that have already had OnAddedToScene called.

Called when the component begins simulating within the scene.

• Use this to add asynchronous/suspends update logic for a component.
• OnBeginSimulation is guaranteed to run before OnSimulate.
• OnSimulate will be cancelled before OnEndSimulation

Removes the component from the entity.

• Removed components are removed from the scene and can only be added back to the same entity.
• Flows through OnEndSimulation-> OnRemovingFromScene.

Send a scene event to this component, invoking OnReceive. Returns true if any participant consumed the event.