第一次提交
This commit is contained in:
不明不惑
@@ -0,0 +1,22 @@
|
||||
// Copyright 2025 https://yuewu.dev/en All Rights Reserved.
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "CoreMinimal.h"
|
||||
#include "Kismet/BlueprintFunctionLibrary.h"
|
||||
#include "GCS_AttackDefinitionFunctionLibrary.generated.h"
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
UCLASS()
|
||||
class GENERICCOMBATSYSTEM_API UGCS_AttackDefinitionFunctionLibrary : public UBlueprintFunctionLibrary
|
||||
{
|
||||
GENERATED_BODY()
|
||||
|
||||
public:
|
||||
#if WITH_EDITOR
|
||||
UFUNCTION(BlueprintCallable, Category = "Editor Scripting | DataTable", DisplayName = "MigrateAttackDefinitionTable")
|
||||
static void MigrateAttackDefinitionTable(UDataTable* InTable);
|
||||
#endif
|
||||
};
|
||||
@@ -0,0 +1,309 @@
|
||||
// Copyright 2025 https://yuewu.dev/en All Rights Reserved.
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "CoreMinimal.h"
|
||||
#include "GCS_CombatEnumLibrary.h"
|
||||
#include "GenericTeamAgentInterface.h"
|
||||
#include "GCS_CombatStructLibrary.h"
|
||||
#include "AbilitySystem/GCS_GameplayEffectContext.h"
|
||||
#include "CombatFlow/GCS_AttackDefinition.h"
|
||||
#include "Kismet/BlueprintFunctionLibrary.h"
|
||||
#include "GCS_CombatFunctionLibrary.generated.h"
|
||||
|
||||
class UGCS_AttackRequest_Base;
|
||||
class IGCS_CombatTeamAgentInterface;
|
||||
class IGCS_WeaponInterface;
|
||||
class IGCS_CombatEntityInterface;
|
||||
|
||||
/**
|
||||
* Utility functions for combat-related operations.
|
||||
* 战斗相关操作的实用函数。
|
||||
*/
|
||||
UCLASS()
|
||||
class GENERICCOMBATSYSTEM_API UGCS_CombatFunctionLibrary : public UBlueprintFunctionLibrary
|
||||
{
|
||||
GENERATED_BODY()
|
||||
|
||||
public:
|
||||
/**
|
||||
* Gets the combat team agent interface from an actor or its components.
|
||||
* 从Actor或其组件获取战斗队伍代理接口。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @return The combat team agent interface. 战斗队伍代理接口。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, Category="GCS|CombatTeam", meta=(DefaultToSelf="Actor"))
|
||||
static TScriptInterface<IGCS_CombatTeamAgentInterface> GetCombatTeamAgentInterface(AActor* Actor);
|
||||
|
||||
/**
|
||||
* Finds the combat team agent interface on an actor or its components.
|
||||
* 在Actor或其组件上查找战斗队伍代理接口。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @param OutInterface The found interface (output). 找到的接口（输出）。
|
||||
* @return True if found. 如果找到返回true。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, Category="GCS|CombatTeam", meta=(DefaultToSelf="Actor", ExpandBoolAsExecs="ReturnValue"))
|
||||
static bool FindCombatTeamAgentInterface(AActor* Actor, TScriptInterface<IGCS_CombatTeamAgentInterface>& OutInterface);
|
||||
|
||||
/**
|
||||
* Gets the combat interface from an actor or its components.
|
||||
* 从Actor或其组件获取战斗接口。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @return The combat interface. 战斗接口。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "GCS", meta=(DefaultToSelf="Actor"))
|
||||
static TScriptInterface<IGCS_CombatEntityInterface> GetCombatEntityInterface(AActor* Actor);
|
||||
|
||||
/**
|
||||
* Gets the implementer(entity) of the combat interface.
|
||||
* 获取战斗接口的实现者。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @return The object implementing the combat interface. 实现战斗接口的对象。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "GCS", meta=(DefaultToSelf="Actor"))
|
||||
static UObject* GetCombatEntity(AActor* Actor);
|
||||
|
||||
/**
|
||||
* Gets the weapon interface from an actor or its components.
|
||||
* 从Actor或其组件获取武器接口。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @return The weapon interface. 武器接口。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "GCS", meta=(DefaultToSelf="Actor"))
|
||||
static TScriptInterface<IGCS_WeaponInterface> GetWeaponInterface(AActor* Actor);
|
||||
|
||||
/**
|
||||
* Gets the main skeletal mesh component from an actor.
|
||||
* 从Actor获取主要骨骼网格组件。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @param OverrideMeshLookupTag Optional override tag for lookup. 可选的覆盖查找标签。
|
||||
* @return The skeletal mesh component. 骨骼网格组件。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "GCS", meta=(DefaultToSelf="Actor"))
|
||||
static USkeletalMeshComponent* GetMainCharacterMeshComponent(AActor* Actor, FName OverrideMeshLookupTag = NAME_None);
|
||||
|
||||
/**
|
||||
* Gets the main mesh component from an actor.
|
||||
* 从Actor获取主要网格组件。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @param OverrideMeshLookupTag Optional override tag for lookup. 可选的覆盖查找标签。
|
||||
* @return The mesh component. 网格组件。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "GCS", meta=(DefaultToSelf="Actor"))
|
||||
static UMeshComponent* GetMainMeshComponent(AActor* Actor, FName OverrideMeshLookupTag = NAME_None);
|
||||
|
||||
/**
|
||||
* Gets socket names with a specified prefix from a component.
|
||||
* 从组件获取具有指定前缀的插槽名称。
|
||||
* @param Component The component to query. 要查询的组件。
|
||||
* @param Prefix The prefix to match. 要匹配的前缀。
|
||||
* @param SearchCase The case sensitivity for the search. 搜索的大小写敏感性。
|
||||
* @return Array of matching socket names. 匹配的插槽名称数组。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category = "GCS")
|
||||
static TArray<FName> GetSocketNamesWithPrefix(const USceneComponent* Component, FString Prefix, ESearchCase::Type SearchCase);
|
||||
|
||||
/**
|
||||
* Finds the combat interface on an actor or its components.
|
||||
* 在Actor或其组件上查找战斗接口。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @param OutInterface The found interface (output). 找到的接口（输出）。
|
||||
* @return True if found. 如果找到返回true。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, Category = "GCS", meta=(DefaultToSelf="Actor", ExpandBoolAsExecs="ReturnValue"))
|
||||
static bool FindCombatInterface(AActor* Actor, TScriptInterface<IGCS_CombatEntityInterface>& OutInterface);
|
||||
|
||||
/**
|
||||
* Finds the weapon interface on an actor or its components.
|
||||
* 在Actor或其组件上查找武器接口。
|
||||
* @param Actor The actor to query. 要查询的Actor。
|
||||
* @param OutInterface The found interface (output). 找到的接口（输出）。
|
||||
* @return True if found. 如果找到返回true。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, Category = "GCS", meta=(DefaultToSelf="Actor", ExpandBoolAsExecs="ReturnValue"))
|
||||
static bool FindWeaponInterface(AActor* Actor, TScriptInterface<IGCS_WeaponInterface>& OutInterface);
|
||||
|
||||
/**
|
||||
* Calculates the angle between two actors.
|
||||
* 计算两个Actor之间的角度。
|
||||
* @param From The source actor. 来源Actor。
|
||||
* @param To The target actor. 目标Actor。
|
||||
* @return The angle as a rotator. 角度（旋转器）。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="GCS")
|
||||
static FRotator CalculateAngleBetweenActors(const AActor* From, const AActor* To);
|
||||
|
||||
/**
|
||||
* Check team relationship using CombatTeamAgentInterface.
|
||||
* @param A The first actor.
|
||||
* @param B The second actor.
|
||||
* @return True if both actors are in the same team.
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="GCS")
|
||||
static bool IsSameCombatTeam(const AActor* A, const AActor* B);
|
||||
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="GCS")
|
||||
static FGenericTeamId GetCombatTeamId(const AActor* Actor);
|
||||
|
||||
static FGenericTeamId QueryCombatTeamId(const AActor* Actor, bool bCombatAgent = true, bool bGenericAgent = true);
|
||||
|
||||
/**
|
||||
* Determines the direction from an angle.
|
||||
* 从角度确定方向。
|
||||
* @param Angle The input angle. 输入角度。
|
||||
* @return The direction enum. 方向枚举。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="GCS")
|
||||
static EGCS_Direction CalculateDirectionFromAngle(const float Angle);
|
||||
|
||||
/**
|
||||
* Selects a montage based on direction.
|
||||
* 根据方向选择蒙太奇。
|
||||
* @param Direction The direction enum. 方向枚举。
|
||||
* @param Montages Array of montages to choose from. 可选的蒙太奇数组。
|
||||
* @return The selected montage. 选中的蒙太奇。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="GCS")
|
||||
static TSoftObjectPtr<UAnimMontage> SelectMontageByDirection(EGCS_Direction Direction, TArray<TSoftObjectPtr<UAnimMontage>> Montages);
|
||||
|
||||
/**
|
||||
* Adds a tagged value to an array.
|
||||
* 向数组添加标记值。
|
||||
* @param TaggedValues The tagged values array (modified). 标记值数组（修改）。
|
||||
* @param Tag The gameplay tag. 游戏标签。
|
||||
* @param ValueToAdd The value to add. 要添加的值。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="GCS", meta=(DeprecatedFunction, DeprecationMessage="Use Set Tagged Value To Combat Payload."))
|
||||
static void AddTaggedValue(UPARAM(ref)
|
||||
TArray<FGCS_TaggedValue>& TaggedValues, FGameplayTag Tag, float ValueToAdd);
|
||||
|
||||
/**
|
||||
* Gets a tagged value from an array.
|
||||
* 从数组获取标记值。
|
||||
* @param TaggedValues The tagged values array. 标记值数组。
|
||||
* @param Tag The gameplay tag to find. 要查找的游戏标签。
|
||||
* @return The associated value. 关联值。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="GCS", meta=(DeprecatedFunction, DeprecationMessage="Use Get Tagged Value From Combat Payload."))
|
||||
static float GetTaggedValue(const TArray<FGCS_TaggedValue> TaggedValues, FGameplayTag Tag);
|
||||
|
||||
/**
|
||||
* Filters a gameplay tag container based on another container.
|
||||
* 根据另一个容器过滤游戏标签容器。
|
||||
* @param TagContainer The container to filter. 要过滤的容器。
|
||||
* @param OtherContainer The container to filter against. 过滤依据的容器。
|
||||
* @return The filtered tag container. 过滤后的标签容器。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="GCS")
|
||||
static FGameplayTagContainer FilterGameplayTagContainer(const FGameplayTagContainer& TagContainer, FGameplayTagContainer OtherContainer);
|
||||
|
||||
/**
|
||||
* Adds an attack definition handle to a gameplay effect spec.
|
||||
* 将攻击定义句柄添加到游戏效果规格。
|
||||
* @param SpecHandle The effect spec handle. 效果规格句柄。
|
||||
* @param AttackHandle The attack definition handle. 攻击定义句柄。
|
||||
* @return The modified effect spec handle. 修改后的效果规格句柄。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="GCS")
|
||||
static FGameplayEffectSpecHandle AddAttackHandleToGameplayEffectSpec(FGameplayEffectSpecHandle SpecHandle, FDataTableRowHandle AttackHandle);
|
||||
|
||||
/**
|
||||
* Adds an attack definition to a gameplay effect spec.
|
||||
* 将攻击定义添加到游戏效果规格。
|
||||
* @param SpecHandle The effect spec handle. 效果规格句柄。
|
||||
* @param AtkDefinition The attack definition. 攻击定义。
|
||||
* @return The modified effect spec handle. 修改后的效果规格句柄。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="GCS")
|
||||
static FGameplayEffectSpecHandle AddAttackDefinitionToGameplayEffectSpec(FGameplayEffectSpecHandle SpecHandle, const FGCS_AttackDefinition& AtkDefinition);
|
||||
|
||||
/**
|
||||
* Adds an attack definition handle to a gameplay effect container spec.
|
||||
* 将攻击定义句柄添加到游戏效果容器规格。
|
||||
* @param ContainerSpec The effect container spec. 效果容器规格。
|
||||
* @param AttackHandle The attack definition handle. 攻击定义句柄。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="GCS")
|
||||
static void AddAttackHandleToGameplayEffectContainerSpec(FGGA_GameplayEffectContainerSpec ContainerSpec, FDataTableRowHandle AttackHandle);
|
||||
|
||||
/**
|
||||
* Sets the attack definition handle in an effect context.
|
||||
* 在效果上下文中设置攻击定义句柄。
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @param Handle The attack definition handle. 攻击定义句柄。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, Category = "Ability|EffectContext", Meta = (DisplayName = "Set Attack Definition Handle"))
|
||||
static void EffectContextSetAttackDefinitionHandle(FGameplayEffectContextHandle EffectContext, UPARAM(meta=(RowType="/Script/GenericCombatSystem.GCS_AttackDefinition"))
|
||||
FDataTableRowHandle Handle);
|
||||
|
||||
/**
|
||||
* Gets the combat payload required by GCS within effect context.
|
||||
* 获取效果上下文中，GCS所需的数据荷载。
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @return The required data payload within GameplayEffectContext for GCS. GCS在GameplayEffectContext中所需的数据何在。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="Ability|EffectContext", Meta = (DisplayName = "Get Combat Payload"))
|
||||
static FGCS_ContextPayload_Combat EffectContextGetCombatPayload(FGameplayEffectContextHandle EffectContext);
|
||||
|
||||
// Quicker access to Combat payload.
|
||||
static FGCS_ContextPayload_Combat* EffectContextGetMutableCombatPayload(const FGameplayEffectContextHandle& EffectContext);
|
||||
|
||||
/**
|
||||
* Add single tag to the DynamicTags within combat payload.
|
||||
* 获取战斗数据中的动态标签。
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @param TagToAdd The tag to add. 要添加的标签。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, Category="Ability|EffectContext", Meta = (DisplayName = "Add Tag To Combat Payload"))
|
||||
static void EffectContextAddTagToCombatPayload(FGameplayEffectContextHandle EffectContext, FGameplayTag TagToAdd);
|
||||
|
||||
/**
|
||||
* Shortcut to get the dynamic tags within combat payload.
|
||||
* 获取战斗数据中的动态标签。
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @param OutTags The dynamic tags. 动态标签。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="Ability|EffectContext", meta=( DisplayName="Get DynamicTags From Combat Payload"))
|
||||
static void EffectContextGetDynamicTagsFromCombatPayload(FGameplayEffectContextHandle EffectContext, FGameplayTagContainer& OutTags);
|
||||
|
||||
/**
|
||||
* Sets a tagged value to combat payload
|
||||
* 向战斗数据添加以标签关联的数值。
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @param Tag The gameplay tag. 游戏标签。
|
||||
* @param NewValue The value to set. 要设置的值。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="Ability|EffectContext", meta=( DisplayName="Set Tagged Value To Combat Payload"))
|
||||
static void EffectContextSetTaggedValueToCombatPayload(FGameplayEffectContextHandle EffectContext, FGameplayTag Tag, float NewValue);
|
||||
|
||||
/**
|
||||
* Gets a tagged value from combat payload.
|
||||
* 从战斗数据获取以标签关联的数值
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @param Tag The gameplay tag to find. 要查找的游戏标签。
|
||||
* @return The associated value,0 if not found. 关联值,没找到就返回0。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure=false, Category="Ability|EffectContext", meta=( DisplayName="Get Tagged Value From Combat Payload"))
|
||||
static float EffectContextGetTaggedValueFromCombatPayload(FGameplayEffectContextHandle EffectContext, FGameplayTag Tag);
|
||||
|
||||
/**
|
||||
* Gets the attack definition handle from an effect context.
|
||||
* 从效果上下文中获取攻击定义句柄。
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @return The attack definition handle. 攻击定义句柄。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="Ability|EffectContext", Meta = (DisplayName = "Get Attack Definition Handle"))
|
||||
static FDataTableRowHandle EffectContextGetAttackDefinitionHandle(FGameplayEffectContextHandle EffectContext);
|
||||
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="Ability|EffectContext", Meta = (DisplayName = "Is Predicting Context"))
|
||||
static bool EffectContextGetIsPredictingContext(FGameplayEffectContextHandle EffectContext);
|
||||
|
||||
/**
|
||||
* Gets the attack definition from an effect context.
|
||||
* 从效果上下文中获取攻击定义。
|
||||
* @param EffectContext The effect context. 效果上下文。
|
||||
* @return The attack definition. 攻击定义。
|
||||
*/
|
||||
UFUNCTION(BlueprintCallable, BlueprintPure, Category="Ability|EffectContext", Meta = (DisplayName = "Get Attack Definition"))
|
||||
static FGCS_AttackDefinition EffectContextGetAttackDefinition(FGameplayEffectContextHandle EffectContext);
|
||||
};
|
||||
Reference in New Issue
Block a user