지금은 4.26x까지 지원하고 있다.
여기에 설명 한 것은 루아에 익숙 하지 않기 때문에 틀릴수도 있다.
UnLua를 설치
UnLua를 설치 하는것 부터 알아 보자.1. 다운로드
https://github.com/Tencent/UnLua
2. 다운로드 받은 후 Plugins 폴더를 복사 한다.
3. 탐색기에서 프로젝트 파일 위에서 "Generate Visual Studio project files"을 실행 한다.
비쥬얼 스튜디오 솔루션 트리에서 "unlua" 폴더가 보이는지 확인 한다.
블루프린트 스태틱 바인딩
블루 프린트에서 게임모드를 만든다.생성된 블루 프린트를 열어 보자.
클래스 세팅을 클릭한다.
구현된 인터페이스에 UnLuaInterface를 추가한다.
툴바에서 "Lua Template" 버튼을 클릭한다.
결과)
"Content/Script" 폴더 아래에 게임모드와 같은 폴더 구조와 같은 파일 이름이 생성 된다.
BP_MYGAME.uasset 블루프린트의 템플레이트를 생성 하면 BP_MYGAME_C.lua 파일이 만들어진다.
BP_MYGAME_C.lua 파일
require "UnLua"
local BP_MYGAME_C = Class()
--function BP_MYGAME_C:Initialize(Initializer)
--end
--function BP_MYGAME_C:UserConstructionScript()
--end
--function BP_MYGAME_C:ReceiveBeginPlay()
--end
--function BP_MYGAME_C:ReceiveEndPlay()
--end
-- function BP_MYGAME_C:ReceiveTick(DeltaSeconds)
-- end
--function BP_MYGAME_C:ReceiveAnyDamage(Damage, DamageType, InstigatedBy, DamageCauser)
--end
--function BP_MYGAME_C:ReceiveActorBeginOverlap(OtherActor)
--end
--function BP_MYGAME_C:ReceiveActorEndOverlap(OtherActor)
--end
return BP_MYGAME_C
local BP_MYGAME_C = Class()
--function BP_MYGAME_C:Initialize(Initializer)
--end
--function BP_MYGAME_C:UserConstructionScript()
--end
--function BP_MYGAME_C:ReceiveBeginPlay()
--end
--function BP_MYGAME_C:ReceiveEndPlay()
--end
-- function BP_MYGAME_C:ReceiveTick(DeltaSeconds)
-- end
--function BP_MYGAME_C:ReceiveAnyDamage(Damage, DamageType, InstigatedBy, DamageCauser)
--end
--function BP_MYGAME_C:ReceiveActorBeginOverlap(OtherActor)
--end
--function BP_MYGAME_C:ReceiveActorEndOverlap(OtherActor)
--end
return BP_MYGAME_C
C++ 스택틱 바인딩
C++ 파일을 스택틱 바인딩 하는법에 대해서 알아 보자.build.cs에 모듈을 추가 한다.
언리얼 build.cs 파일에 "UnLua", "Lua"를 추가 한다.
----> "Lua"를 추가하지 않으면 "UnLua.h" 포함 할때 "lua.hpp" 파일을 찾을수 없다는 에러가 뜬다.
클래스에 헤더 파일을 추가한다.
#include "UnLuaInterface.h"
클래스는 IUnLuaInterface를 상속한다.
#include "CoreMinimal.h"
#include "GameFramework/GameModeBase.h"
#include "UnLuaInterface.h"
#include "luatestGameModeBase.generated.h"
UCLASS()
class LUATEST_API AluatestGameModeBase : public AGameModeBase, public IUnLuaInterface
#include "GameFramework/GameModeBase.h"
#include "UnLuaInterface.h"
#include "luatestGameModeBase.generated.h"
UCLASS()
class LUATEST_API AluatestGameModeBase : public AGameModeBase, public IUnLuaInterface
로딩 할 모듈(루아 파일)을 GetModuleName_Implementation 메소드에서 지정 한다.
class LUATEST_API AluatestGameModeBase : public AGameModeBase, public IUnLuaInterface
{
......
public:
virtual FString GetModuleName_Implementation() const override
{
return TEXT("MyLuaGameMode");
}
};
{
......
public:
virtual FString GetModuleName_Implementation() const override
{
return TEXT("MyLuaGameMode");
}
};
C++ 스태틱 바인딩 적용
게임모드에 IUnLuaInterface를 추가 하였다.MyLuaGameMode.lua 모듈을 로딩 하고 있다.
luatestGameModeBase.h 파일
#pragma once
#include "CoreMinimal.h"
#include "GameFramework/GameModeBase.h"
#include "UnLuaInterface.h"
#include "luatestGameModeBase.generated.h"
UCLASS()
class LUATEST_API AluatestGameModeBase : public AGameModeBase, public IUnLuaInterface
{
GENERATED_BODY()
public:
virtual void BeginPlay() override;
UFUNCTION()
void RunLuaFunction();
UFUNCTION()
void RunFromLuaClass();
public:
virtual FString GetModuleName_Implementation() const override
{
UE_LOG(LogTemp, Log, TEXT("UnLua GetModuleName_Implementation "));
return TEXT("MyLuaGameMode");
}
private:
UPROPERTY()
int mIndex = 7;
};
#include "CoreMinimal.h"
#include "GameFramework/GameModeBase.h"
#include "UnLuaInterface.h"
#include "luatestGameModeBase.generated.h"
UCLASS()
class LUATEST_API AluatestGameModeBase : public AGameModeBase, public IUnLuaInterface
{
GENERATED_BODY()
public:
virtual void BeginPlay() override;
UFUNCTION()
void RunLuaFunction();
UFUNCTION()
void RunFromLuaClass();
public:
virtual FString GetModuleName_Implementation() const override
{
UE_LOG(LogTemp, Log, TEXT("UnLua GetModuleName_Implementation "));
return TEXT("MyLuaGameMode");
}
private:
UPROPERTY()
int mIndex = 7;
};
UFUNCTION, UPROPERTY를 지정해야 함수나 변수를 루아로 익스포트 할수 있다.
MyLuaGameMode.lua 파일
require "UnLua"
print("----------------- MyLuaGameMode.Lua --------!!!!" )
--C++에서 CallTableFunc 명령어를 호출 할때 사용하기 위해 전역으로 선언한다.
MyLuaGameMode = Class()
--local MyLuaGameMode = Class()
function MyLuaGameMode:UserConstructionScript()
print("UnLua MyLuaGameMode ConstructionScript !!!!" )
end
--블루 프린트 함수 호출
function MyLuaGameMode:ReceiveBeginPlay()
--Lua에서 C++ 멤버를 가져 올수도 있다.
print(self.mIndex)
self.mIndex = 99
print("UnLua MyLuaGameMode BeginPlay !!!!" )
UE4.UKismetSystemLibrary.PrintString(self,"MyLuaGameMode:ReceiveBeginPlay")
--Lua에서 C++ 클래스 메소드를 호출한다.
self.RunFromLuaClass(self);
--Lua에서 루아 클래스 메소드를 호출한다.
self.DisplayTest();
end
function MyLuaGameMode:DisplayTest()
print("MyLuaGameMode:DisplayTest !!!!" )
end
--CPP에서 루아를 호출 하는 함수
function MyLuaGameMode:RunFromCPPNative()
print("in Lua - MyLuaGameMode:RunFromCPPNative" )
end
return MyLuaGameMode
print("----------------- MyLuaGameMode.Lua --------!!!!" )
--C++에서 CallTableFunc 명령어를 호출 할때 사용하기 위해 전역으로 선언한다.
MyLuaGameMode = Class()
--local MyLuaGameMode = Class()
function MyLuaGameMode:UserConstructionScript()
print("UnLua MyLuaGameMode ConstructionScript !!!!" )
end
--블루 프린트 함수 호출
function MyLuaGameMode:ReceiveBeginPlay()
--Lua에서 C++ 멤버를 가져 올수도 있다.
print(self.mIndex)
self.mIndex = 99
print("UnLua MyLuaGameMode BeginPlay !!!!" )
UE4.UKismetSystemLibrary.PrintString(self,"MyLuaGameMode:ReceiveBeginPlay")
--Lua에서 C++ 클래스 메소드를 호출한다.
self.RunFromLuaClass(self);
--Lua에서 루아 클래스 메소드를 호출한다.
self.DisplayTest();
end
function MyLuaGameMode:DisplayTest()
print("MyLuaGameMode:DisplayTest !!!!" )
end
--CPP에서 루아를 호출 하는 함수
function MyLuaGameMode:RunFromCPPNative()
print("in Lua - MyLuaGameMode:RunFromCPPNative" )
end
return MyLuaGameMode
util.lua 파일
require "UnLua"
function LuaTest()
print("********************LuaTest function !!!!" )
end
function LuaTest()
print("********************LuaTest function !!!!" )
end
아래 명령어로 모듈 로딩을 하면 제일 먼저 실행 되는지 확인을 위해 추가 하였다.
print 루아 명령을 실행하면 언리언 에디터 출력 로그에 출력 된다.
print("----------------- MyLuaGameMode.Lua --------!!!!" )
C++에서 CallTableFunc 명령어를 호출 할때 사용하기 위해 전역으로 선언한다.
unlua 예제에서는 local 되어 있는데 전역으로 바꾼다.
MyLuaGameMode = Class()
--local MyLuaGameMode = Class()
ReceiveBeginPlay는 C++, BluePrint BeginPlay에 대응 되는 루아 명령어이다.
C++에서 BeginPlay와 같이 사용할때는 순서가 어떻게 되는지 확인이 필요 하다.
function MyLuaGameMode:ReceiveBeginPlay()
언리얼의 PrintString 명령도 호출 할수 있다.
UE4.UKismetSystemLibrary.PrintString(self,"MyLuaGameMode:ReceiveBeginPlay")
루아에서 C++의 메소드를 호출 할때는 함수 이름에 "self"를 적어 준다.
루아 클래스에게 C++ 클래스는 super 클래스가 되기 때문에 "self"를 넘겨 준다.
self.RunFromLuaClass(self);
루아 클래스에서 루마 메소드를 호출 하는 예이다.
self.DisplayTest();
C++에서 루아를 호출 할수 있는지 확인 하기 위해 추가한 함수이다.
function MyLuaGameMode:RunFromCPPNative()
print("in Lua - MyLuaGameMode:RunFromCPPNative" )
end
luatestGameModeBase.cpp
#include "luatestGameModeBase.h"
#include "UnLua.h"
void AluatestGameModeBase::RunFromLuaClass()
{
UE_LOG(LogTemp, Warning, TEXT("C++ UnLua RunFromLuaClass"));
}
void AluatestGameModeBase::RunLuaFunction()
{
UE_LOG(LogTemp, Warning, TEXT("C++ UnLua RunLuaFunction"));
#if 0
//루아 함수 호출
lua_State* L = UnLua::GetState();
UnLua::RunFile(L, "util.lua");
UnLua::Call(L, "LuaTest");
#else
//루아 메소드 호출
lua_State* L = UnLua::GetState();
//"MyLuaGameMode"을 전역 변수로 선언 했기 때문에 별도로 로딩 하지 않아도 실행 되는것 확인
//UnLua::RunFile(L, "MyLuaGameMode.lua");
UnLua::CallTableFunc(L, "MyLuaGameMode", "RunFromCPPNative");
#endif
}
void AluatestGameModeBase::BeginPlay()
{
mIndex = 78;
UE_LOG(LogTemp, Warning, TEXT("C++ before ReceiveBeginPlay UnLua mIndex = %d"), mIndex);
UE_LOG(LogTemp, Warning, TEXT("C++ UnLua BeginPlay"));
Super::BeginPlay();
UE_LOG(LogTemp, Warning, TEXT("C++ after ReceiveBeginPlay UnLua mIndex = %d"), mIndex);
RunLuaFunction();
}
#include "UnLua.h"
void AluatestGameModeBase::RunFromLuaClass()
{
UE_LOG(LogTemp, Warning, TEXT("C++ UnLua RunFromLuaClass"));
}
void AluatestGameModeBase::RunLuaFunction()
{
UE_LOG(LogTemp, Warning, TEXT("C++ UnLua RunLuaFunction"));
#if 0
//루아 함수 호출
lua_State* L = UnLua::GetState();
UnLua::RunFile(L, "util.lua");
UnLua::Call(L, "LuaTest");
#else
//루아 메소드 호출
lua_State* L = UnLua::GetState();
//"MyLuaGameMode"을 전역 변수로 선언 했기 때문에 별도로 로딩 하지 않아도 실행 되는것 확인
//UnLua::RunFile(L, "MyLuaGameMode.lua");
UnLua::CallTableFunc(L, "MyLuaGameMode", "RunFromCPPNative");
#endif
}
void AluatestGameModeBase::BeginPlay()
{
mIndex = 78;
UE_LOG(LogTemp, Warning, TEXT("C++ before ReceiveBeginPlay UnLua mIndex = %d"), mIndex);
UE_LOG(LogTemp, Warning, TEXT("C++ UnLua BeginPlay"));
Super::BeginPlay();
UE_LOG(LogTemp, Warning, TEXT("C++ after ReceiveBeginPlay UnLua mIndex = %d"), mIndex);
RunLuaFunction();
}
루아에서 클래스 메소드가 불려 지는지 확인하기 위해 추가한 메소드이다.
AluatestGameModeBase::RunFromLuaClass()
AluatestGameModeBase::RunLuaFunction() 함수에서 루아 함수와 루아 클래스의 메소드를 호출 하고 있다.
루아 함수를 호출 하는 예이다.
lua_State* L = UnLua::GetState();
UnLua::RunFile(L, "util.lua");
UnLua::Call(L, "LuaTest");
루아 메소드를 호출하는 예이다.
루아에서 MyLuaGameMode를 전역으로 선언 하여 RunFile를 별도로 할 필요가 없다.
lua_State* L = UnLua::GetState();
//"MyLuaGameMode"을 전역 변수로 선언 했기 때문에 별도로 로딩 하지 않아도 실행 되는것 확인
//UnLua::RunFile(L, "MyLuaGameMode.lua");
UnLua::CallTableFunc(L, "MyLuaGameMode", "RunFromCPPNative");
C++ BeginPlay이다.
루아의 ReceiveBeginPlay는 블루프린트의 ReceiveBeginPlay를 이용하고 있다.
블루프린트의 BeginPlay는 실제 내부 코드는 ReceiveBeginPlay 함수이다.
ReceiveBeginPlay, BeginPlay 실행 순서는 다음과 같다.
void AluatestGameModeBase::BeginPlay()
{
//루아 코드 실행전
Super::BeginPlay(); //루아 ReceiveBeginPlay 실행
//루아 코드 실행 후
}
C++ 변수를 루아와 연결
이 부분은 자주 사용 되기 때문에 다시 설명한다.C++ 멤버로 변수 선언
접근 지정자는 상관없고 UPROPERTY를 지정해야 루아로 멤버를 익스포트 할수 있다.
UPROPERTY()
int mIndex = 7;
루아에서 변수 사용
self를 이용해서 사용 할수 있다.
self.mIndex = 99
다운로드:
luatest.Build.cs
luatestGameModeBase.h
luatestGameModeBase.cpp
MyLuaGameMode.lua
util.lua
참조)
루아에서 C++ PrintString 호출
https://www.programmersought.com/article/25326264507/
C++에서 루아 호출
https://github.com/Tencent/UnLua/issues/60
UNLUA 메인 설명 페이지
https://www.zhihu.com/topic/21248591/hot
HelloWorldUMG
https://zhuanlan.zhihu.com/p/330790611
Unlua 소스 코드 분석 및 메모리 관리
https://zhuanlan.zhihu.com/p/186209883
Unlua 전반적인 설명
https://blog.csdn.net/weixin_34803466/article/details/112494155
UnLua 분석 (1) 객체 바인딩 루아
https://zhuanlan.zhihu.com/p/100058725
UnLua는 UE 호출 lua와 함께 UE 정적 내보내기 2