Attributes

Attributes are dynamic variables that can be assigned to a weapon via behaviors, to emitter output data assets or to attachment executions. These variables can be assigned a gameplay tag so that any attachment that is applied with that tag will modify all attributes that match the same tag. Attachments can be added and removed at runtime to augment a weapon.

Defining A New Attribute#

To use an attribute, simply create the parameter in the header of your class (or as a default variable in BP) and call Register. This will initialize it on the shooting component and will automatically get cleaned up when the object that it is registered with is destroyed.

Header:

UE_DECLARE_GAMEPLAY_TAG_EXTERN(TAG_Weapon_Attribute_Example)

UCLASS()
class UGSExecution_Example : public UGSWeaponAttachmentExecution
{
    GENERATED_BODY()

public:
  virtual void Setup_Implementation(UGSShootingComponent* ShootingComponent, int32 ID) override;

protected:
  UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Example", meta=(ClampMin="1"))
  FGSWeaponAttribute ExampleAttribute = FGSWeaponAttribute(TAG_Weapon_Attribute_Example, 1);
};

CPP:

UE_DEFINE_GAMEPLAY_TAG(TAG_Weapon_Attribute_Example, "Weapon.Attribute.Example")

void UGSExecution_Example::Setup_Implementation(UGSShootingComponent* ShootingComponent, int32 ID)
{
  Super::Setup_Implementation(ShootingComponent, ID);

  ExampleAttribute.Register(this, ShootingComponent);
}

Create the attribute and assign it a tag

Register the attribute with the shooting component

Attribute Viewer#

The attribute preview section in the weapon data allows you to view all attributes that have been registered with a weapon, along with which component it is registered with. You can also assign attachments to the preview and see how that affects the attributes on the weapon.