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

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

Section 3 : GAS에 AttributeSet 추가하기

---

AttributeSet

ASC(AbilitySystemComponent)에 여러 AttributeSet 사용 가능

• 하나의 Attribute Set 클래스 안에 여러 Attribute 목록을 갖도록하거나
  

• 하나의 목록을 가진 여러 Attribute Set 클래스를 추가해서 사용 가능 (이 경우 모호성 문제때문에 AttributeSet 클래스는 다르게 써야함)

---

Prediction

Attribute 값을 조정하는 방식은 여러가지가 있지만 예제에서는 게임플레이 이펙트를 사용한다.
이를 통해 언리얼 엔진에서 지원하는 리플리케이션 방식인 로컬 예측 방식을 사용할 수 있기때문

로컬 예측 방식(Local Predicted)이란

반응성과 정확성 사이에 균형이 잘 잡힌 옵션입니다. 클라이언트가 명령을 내리면 로컬 클라이언트에서 어빌리티가 즉시 실행되지만, 어빌리티의 실제 영향이 어땠는지에 대한 최종 결정은 서버가 내리고 클라이언트를 오버라이드할 수 있습니다. 실제로 클라이언트는 서버에 어빌리티 실행 권한을 요청하지만, 클라이언트 관점의 결과를 서버가 동의할 것으로 예상하고 로컬에서 진행합니다. 클라이언트는 로컬에서 어빌리티의 비헤이비어를 예측하므로, 클라이언트의 예측이 서버와 모순되지 않는다면 지연 없이 완전히 매끄럽게 느껴질 것입니다.
출처 : 언리얼 공식 문서

FGameplayAttributeData

Attribute를 표현하는 구조체로 BaseValue와 CurrentValue로 구성되어있다.

• BaseValue 는 MaxValue가 아니므로 HealthAttribute를 만든다고 할 때 Base를 MaxHealth처럼 사용하는 것이 아니고 MaxHealthAttribute를 따로 만들어서 사용
• 각 Value는 float형

---

Attribute 추가하기

크게 세가지 공통 코드를 추가해야한다.
1. ReplicatedUsing 클래스 지정자와 RepNotify 추가하기
2. GetLifetimeReplicatedProps에 변수 등록하기
3. GAMEPLAYATTRIBUTE_REPNOTIFY로 ASC와 연동하기

1. ReplicatedUsing 클래스 지정자와 RepNotify 추가하기

UPROPERTY(BlueprintReadOnly,ReplicatedUsing=OnRep_Health,Category="Vital Attributes")
	FGameplayAttributeData Health;

• ReplicatedUsing 클래스 지정자를 추가하고 RepNotify 함수명을 달아준다.

UFUNCTION()
	void OnRep_Health(const FGameplayAttributeData& OldHealth) const;

• 동일한 함수를 추가해준다.
• 인자에 이전값을 참조로 받아오도록 설정할 수 있다. (필요없으면 빼도 됨)

2. GetLifetimeReplicatedProps에 변수 등록하기

GetLifetimeReplicatedProps 함수를 오버라이드 한 뒤
DOREPLIFETIME_CONDITION_NOTIFY 매크로를 통해 Attribute를 등록한다.

void UAuraAttributeSet::GetLifetimeReplicatedProps(TArray<class FLifetimeProperty>& OutLifetimeProps) const
{
	Super::GetLifetimeReplicatedProps(OutLifetimeProps);

	DOREPLIFETIME_CONDITION_NOTIFY(UAuraAttributeSet,Health,COND_None,REPNOTIFY_Always);
}

DOREPLIFETIME_CONDITION_NOTIFY(클래스, 멤버, 조건, 노티파이 설정)

• COND_None : 리플리케이션되는 방식을 설정하는 것 (None은 항상 리플리케이션되도록 함)
• 마지막 인자인 REPNOTIFY_Always는 항상 리플리케이션되도록 설정한 것.
  (기본값은 REPNOTIFY_OnChanged로 로컬 값과 다를 때만 리플리케이션)

3. GAMEPLAYATTRIBUTE_REPNOTIFY로 ASC와 연동하기

void UAuraAttributeSet::OnRep_Health(const FGameplayAttributeData& OldHealth) const
{
	GAMEPLAYATTRIBUTE_REPNOTIFY(UAuraAttributeSet,Health,OldHealth);
}

RepNotify 함수에서 리플리케이션 될 때 ASC에도 전달되도록 사용하는 헬퍼 매크로이다.

"This is a helper macro that can be used in RepNotify functions to handle attributes that will be predictively modified by clients."

---

Attribute Accessors

Attribute마다 기본적으로 사용할 일이 많은 Getter, Setter, Init 등의 함수를 일일이 만들지 않도록 접근자 생성 매크로를 지원한다.

사용법

attributeset.h을 찾아보면 ATTRIBUTE_ACCESSORS가 정의된 부분이 있다.
해당 매크로를 커스텀 클래스 헤더에 추가하면 된다.

• 처음에 주석처리 되어있기때문에 주석 부분이랑 * 부분 지워야 함

추가할 라인

#define ATTRIBUTE_ACCESSORS(ClassName, PropertyName) \
	GAMEPLAYATTRIBUTE_PROPERTY_GETTER(ClassName, PropertyName) \
	GAMEPLAYATTRIBUTE_VALUE_GETTER(PropertyName) \
	GAMEPLAYATTRIBUTE_VALUE_SETTER(PropertyName) \
	GAMEPLAYATTRIBUTE_VALUE_INITTER(PropertyName)

사용 예시

UPROPERTY(BlueprintReadOnly,ReplicatedUsing=OnRep_Health,Category="Vital Attributes")
	FGameplayAttributeData Health;
	ATTRIBUTE_ACCESSORS(UAuraAttributeSet,Health)

ATTRIBUTE_ACCESSORS(클래스,속성이름) 를 등록하면 이후

InitMaxHealth(100);
InitHealth(GetMaxHealth());

이런식으로 Get속성이름Attribute, Get속성이름, Set속성이름, Init속성이름 4개의 함수를 사용할 수 있다.

함수 원형

#define GAMEPLAYATTRIBUTE_PROPERTY_GETTER(ClassName, PropertyName) \
	static FGameplayAttribute Get##PropertyName##Attribute() \
	{ \
		static FProperty* Prop = FindFieldChecked<FProperty>(ClassName::StaticClass(), GET_MEMBER_NAME_CHECKED(ClassName, PropertyName)); \
		return Prop; \
	}

#define GAMEPLAYATTRIBUTE_VALUE_GETTER(PropertyName) \
	FORCEINLINE float Get##PropertyName() const \
	{ \
		return PropertyName.GetCurrentValue(); \
	}

#define GAMEPLAYATTRIBUTE_VALUE_SETTER(PropertyName) \
	FORCEINLINE void Set##PropertyName(float NewVal) \
	{ \
		UAbilitySystemComponent* AbilityComp = GetOwningAbilitySystemComponent(); \
		if (ensure(AbilityComp)) \
		{ \
			AbilityComp->SetNumericAttributeBase(Get##PropertyName##Attribute(), NewVal); \
		}; \
	}

#define GAMEPLAYATTRIBUTE_VALUE_INITTER(PropertyName) \
	FORCEINLINE void Init##PropertyName(float NewVal) \
	{ \
		PropertyName.SetBaseValue(NewVal); \
		PropertyName.SetCurrentValue(NewVal); \
	}

각 함수의 기능

Get속성이름Attribute : FGameplayAttribute 구조체를 리턴
Get속성이름 : CurrentValue를 리턴
Set속성이름 : BaseValue를 설정
Init속성이름 : BaseValue와 CurrentValue를 동시에 설정

---

showdebug abilitysystem

콘솔 명령어 showdebug abilitysystem 을 입력해 엔진에서 디버깅이 가능하다.
(스크린샷 좌측 중앙에 속성과 값이 표시되는 것을 확인할 수 있다.)

---

인터페이스를 통해 AttributeSet 접근하기

if (IAbilitySystemInterface* ASCInterface = Cast<IAbilitySystemInterface>(OtherActor))
{
		const UAuraAttributeSet* AuraAttributeSet = 
											Cast<UAuraAttributeSet>(ASCInterface->
											GetAbilitySystemComponent()->
											GetAttributeSet(UAuraAttributeSet::StaticClass()));
}

1. OtherActor가 ASC 인터페이스를 상속 받았다면 캐스팅 성공
2. ASC 인터페이스 구현 함수인 GetAbilitySystemComponent()를 통해 액터의 ASC에 접근
3. GetAttributeSet()을 통해 ASC에 등록된 AttributeSet에 접근한다.

• ASC는 초기화될 때 자동으로 OwnerActor에 존재하는 AttributeSet을 찾아서 컴포넌트에 등록하므로 따로 할당하지 않았더라도 불러올 수 있다.
• GetAttributeSet()의 인자는 TSubclassOf<UAttributeSet>이므로 StaticClass()를 통해 넘겨준다.

---

커밋

https://github.com/jongmin7759/Unreal_GAS/commit/799da6ebfcdfd0fc84d565ca6c900b71b9c132b7