Udemy Unreal - Gameplay Ability System - Top Down RPG (Section 5)

📖 유데미 GAS 강의 중 기록해두고 싶은 내용을 적어둔 포스트

Section 5 : Gameplay Effect

---

GameplayEffect

UObject 클래스를 상속받은 데이터 클래스이다.

• 사용할 때는 따로 자식 클래스 만들지 말고 이 클래스로 BP를 만들면 된다.
  (이미 충분히 많은 기능이 있고 다양한 로직이 구성되어 있음)

Attribute와 GameplayTag를 수정할 때 사용한다.

Modifier : 값 수정
Execution : 값 수정뿐 아니고 코드를 추가해서 특정 액션 수행 가능

---

GameplayEffectSpec

GameplayEffect

정적 정의
속성 변경, 지속 시간, 주기, 태그, 그리고 조건부 논리 등을 설정해 놓은 설계도
특수한 상황 구현을 위해 서브클래스를 만드는 대신 Exectuion이나 Modifier를 활용하기

GameplayEffectSpec

런타임에 생성되는 인스턴스
FGameplayEffectSpec 구조체로 존재
특정 GameplayEffect를 기반으로 구체적인 수치, 적용 대상, 레벨 등을 포함해서 만들어짐

관계

1. GameplayEffect를 만든다.

2. 게임 중 능력이 발동되면 코드에서 MakeOutgoingSpec() 같은 함수를 써서 GameplayEffectSpec을 생성한다.

3. 이 GameplayEffectSpec이 ApplyGameplayEffectSpecToTarget() 등의 함수로 타겟에게 적용된다.

적용 예시

void AAuraEffectActor::ApplyEffectToTarget(AActor* TargetActor, TSubclassOf<UGameplayEffect> GameplayEffectClass)
{
	// UAbilitySystemBlueprintLibrary::GetAbilitySystemComponent 사용하면 ASC 불러올 수 있음
	// 내부 코드를 보면
	// 1. IAbilitySystemInterface 상속 받은 경우 : 인터페이스 구현 함수로 불러옴
	// 2. 받지 않은 경우 : AbilitySystemComponent를 찾아서 불러오는 2가지 경우 모두 대응함
	UAbilitySystemComponent* TargetASC = UAbilitySystemBlueprintLibrary::GetAbilitySystemComponent(TargetActor);
	if (TargetASC == nullptr)
	{
		return;
	}

	check(GameplayEffectClass);
	// FGameplayEffectContextHandle 만들기
	FGameplayEffectContextHandle EffectContextHandle = TargetASC->MakeEffectContext();
	// Context에는 다양한 정보가 들어가고 Handle은 Wrapper 클래스임
	// EffectContext에 정보 추가 (이 이펙트를 발생시킨 객체 추가한 것)
	EffectContextHandle.AddSourceObject(this);
	
	// FGameplayEffectSpec 만들기
	FGameplayEffectSpecHandle EffectSpecHandle = TargetASC->MakeOutgoingSpec(GameplayEffectClass,ActorLevel,EffectContextHandle);

	// ApplyGameplayEffect~~ 종류 여러가지 있음
	// 인자로 EffectSpec 참조 포인터가 필요한데 EffectSpecHandle은 래퍼이고 그 안에는 Data(SharedPtr)가 들어있음
	// SharedPtr 자체도 래퍼이므로 Get하면 포인터가 나옴
	// 포인터가 아닌 그 참조값 자체가 필요하므로 * 를 붙여줌
	FActiveGameplayEffectHandle ActiveGameplayEffectHandle = TargetASC->ApplyGameplayEffectSpecToSelf(*EffectSpecHandle.Data.Get());
}

ApplyGameplayEffectSpecToTarget()은 FActiveGameplayEffectHandle을 리턴한다.

• 해당 핸들을 통해 이펙트를 컨트롤 할 수 있음
  ex) 기존 적용된 이펙트를 제거하기

---

Duration Policy

GameplayEffect의 DurationPolicy는 크게 세가지

Instant

AttributeData의 BaseValue를 즉각적으로 수정

Duration

AttributeData의 CurrentValue를 특정 시간동안 수정
-> 시간이 지나면 BaseValue로 돌아온다.

ex) 5초간 방어력이 100 증가하는 경우 (기존 10)

• 5초간 110 유지 후 10으로 돌아온다.

Inifinite

AttributeData의 CurrentValue를 특정 시간동안 수정
-> 시간이 지나면 BaseValue로 돌아온다.

ex) 방어력이 100 증가하는 경우 (기존 10)

• 해제되기 전까지는 110 유지하다가 이펙트 비활성화하면 10으로 돌아온다.
  (FActiveGameplayEffectHandle 활용)

// Remove 인자에 -1 (기본값) 넣으면 모든 스택이 제거됨
ASC->RemoveActiveGameplayEffect(ActiveGameplayEffectHandle,1); // 1개만 제거

Periodic

Duration, Infinite에만 적용

특정 기간동안 적용되는 이펙트에 n초마다 이펙트가 발동하도록 해준다.
BaseValue에 직접 영향을 준다.

• CurrentValue 수정 후 돌아오는 방식이 아니기때문에 이펙트가 풀려도 기존값으로 돌아오지 않음

ex) 2초동안 총 20의 체력 회복을 하는 경우 (Period는 0.1초 간격)

• Duration : 2초
• Period : 0.1
• Modifier : Add , 1

---

EffectStack

한번에 적용되는 이펙트의 수를 제한할 수 있다.

Stacking Type

bySource : 같은 타겟이어도 소스가 다르면 이펙트 스택 따로 계산

byTarget : 같은 타겟이라면 소스가 달라도 스택을 합쳐서 계산

---

이펙트 적용 전,후 처리

PreAttributeChange()

이펙트 적용 전 값 클램핑할 때 사용 (다른 함수 호출이나 기능은 하지 않을 것 권장)

오버라이드해서 사용

virtual void PreAttributeChange(const FGameplayAttribute& Attribute, float& NewValue) override;
.
.
.
void UAuraAttributeSet::PreAttributeChange(const FGameplayAttribute& Attribute, float& NewValue)
{
	Super::PreAttributeChange(Attribute, NewValue);
	
    // Accessor 매크로 사용해서 원하는 Attribute에 적용
	if (Attribute == GetHealthAttribute())
	{
    	// NewValue를 수정
		NewValue =  FMath::Clamp(NewValue, 0.f , GetMaxHealth());
	}
}

이펙트 적용 전에 호출되는 것이기 때문에 이 이후 단계에서 값 수정이 일어난다면
최종적으로는 클램핑 범위를 넘어갈 수도 있으므로 주의 필요.

---

PostGameplayEffectExecute()

게임플레이 이펙트 실행 후 호출되는 함수로 Data를 통해 연관된 대부분의 엔티티에 접근 가능함

오버라이드해서 사용

virtual void PostGameplayEffectExecute(const struct FGameplayEffectModCallbackData& Data) override;
.
.
.
void UAuraAttributeSet::PostGameplayEffectExecute(const struct FGameplayEffectModCallbackData& Data)
{
	Super::PostGameplayEffectExecute(Data);

	// EffectContextHandle
	EffectContextHandle = Data.EffectSpec.GetContext();
    // Source의 AbilitySystemComponent 받아오기
	SourceASC = Props.EffectContextHandle.GetOriginalInstigatorAbilitySystemComponent();
	// SourceASC를 통해 AvatarActor, Controller 등에 접근 가능
	
	// Target의 액터 정보에도 접근 가능
	if (Data.Target.AbilityActorInfo.IsValid() && Data.Target.AbilityActorInfo->AvatarActor.IsValid())
	{
    	// Target의 AvatarActor와, ASC등에 접근
		TargetAvatarActor = Data.Target.AbilityActorInfo->AvatarActor.Get();
		TargetController = Data.Target.AbilityActorInfo->PlayerController.Get();
		TargetCharacter = Cast<ACharacter>(Props.TargetAvatarActor);
		TargetASC = UAbilitySystemBlueprintLibrary::GetAbilitySystemComponent(Props.TargetAvatarActor);
	}
	
}

FGameplayEffectModCallbackData를 통해 다양한 정보에 접근하고 원하는 작업을 수행할 수 있다.

---

CurveTable

GameplayEffect BP에서 레벨에 따른 Magnitude 값 적용을 위해 커브테이블을 사용할 수 있다.

float 값 * 커브 내의 level에 할당된 값이 곱해져서 적용됨
ex) 1 * HealingCurve Level 1 값 5.f 인 5가 적용됨 (Preview At 1 : 5.000)

GameplayEffectSpec을 만들 때 레벨 넣어줌

// FGameplayEffectSpec 만들기
TargetASC->MakeOutgoingSpec(GameplayEffectClass,ActorLevel,EffectContextHandle);

---

커밋

https://github.com/jongmin7759/Unreal_GAS/commit/f3b3cfe6533cc40d1eec12ff70f2d76a282be4f3
https://github.com/jongmin7759/Unreal_GAS/commit/69c7bbe7bd815cefe911d6076443df6f378537d1