Remote Procedure Calls (PRC) - cheona-thousand-man/Unity-myBasics-Wiki GitHub Wiki

개요

• 원격 프로시저 호출(RPC) 게임 이벤트를 공유하는 데 적합
• Input Struct와 [Networked] 속성 지속적으로 변화하는 네트워크 클라이언트 간의 상태를 공유하는 데 적합

예를 들어 플레이어가 인벤토리에서 특정 키를 사용하여 잠긴 문을 여는 드문 복잡한 상호작용을 수행하고자 할 때,

• 이를 Input Authority가 없는 객체와 상호작용하는 경우에 RPC가 적합
  • Input Struct에 추가 필드를 포함시켜 이러한 작업을 기술적으로 수행할 수 있지만, 이는 Input Struct 구조 복잡화
  • Input Struct는 신뢰할 수 없는 메시지로 전송되며, 플레이어가 기대하는 단일 일회성 작업에 영향O (지속적인 입력(예: 캐릭터 이동)에는 큰 문제X)

Setup

• 인스턴스 RPC
• 정적 RPC
• 대상 지정 RPC

Instance RPC

NetworkObject의 NetworkBehaviour에서 RPC 정의

1. void 또는 RpcInvokeInfo 반환 형식의 일반 C# 메서드 선언
2. 메서드 이름 앞이나 뒤에 RPC 추가(대소문자 구분 없음)
3. 메서드 선언 앞에 [Rpc] 속성을 추가
4. RpcSources 및 RpcTargets 매개변수를 구성하여 RPC를 호출할 수 있는 위치와 실행되는 위치 제어

[Rpc(sources: RpcSources.InputAuthority, targets: RpcTargets.StateAuthority)]
public void RPC_Configure(string name, Color color, RpcInfo info = default){
    playerName = name;
    playerColor = color;
}

Static RPC

약간 다른 규칙 준수

1. RpcSources 및 RpcTargets 매개변수 무시
2. 메서드의 첫 번째 매개변수로 NetworkRunner 요구
3. 특정 NetworkObject에 바인딩되지 않으므로 SimulationBehaviour에 구현 가능

[Rpc]
public static void Rpc_MyStaticRpc(NetworkRunner runner, int a) { }

RPC 속성 매개변수 (필수)

1. RpcSources RPC를 보낼 수 있는 Peer를 정의
2. RpcTargets 실행되는 Peer를 정의

• All 세션의 모든 피어(서버 포함)가 보낼 수 있으며 실행됩니다.
• Proxies 객체에 Input Authority 또는 State Authority가 없는 피어가 보낼 수 있으며 실행됩니다.
• InputAuthority 객체에 Input Authority가 있는 피어가 보낼 수 있으며 실행됩니다.
• StateAuthority 객체에 State Authority가 있는 피어가 보낼 수 있으며 실행됩니다.

RPC에는 명시적인 상태가 없습니다. 나중에 참가한 클라이언트와 연결이 끊겼다가 다시 연결된 클라이언트는 RPC가 발생한 사실을 잊어버립니다. 따라서 RPC가 둘 중 어느 상태인지 확인 필요합니다.

• 진정한 일회성 상태(예: 채팅 메시지)인지
• [Networked] 속성에 간접적으로 기록된 영향을 가지는지

public class Player : NetworkBehaviour {
    [Networked] public string playerName { get; set; }
    [Networked] public Color playerColor { get; set; }

    [Rpc(RpcSources.InputAuthority, RpcTargets.StateAuthority)]
    public void RPC_Configure(string name, Color color) {
        playerName = name;
        playerColor = color;
    }
}

선택적 RPC 속성 매개변수

• Channel(기본값 Reliable) RPC가 전송 중 손실될 수 있는 경우 Unreliable로 설정
• InvokeLocal(기본값 true) RPC가 로컬 클라이언트에서 호출될지 여부
• InvokeResim(기본값 false) 재시뮬레이션 중에 RPC가 호출될지 여부
• TickAligned(기본값 true) RPC가 전송된 틱에서 또는 이후에 RPC를 실행할지 여부 설정

[Rpc (RpcSources.All, RpcTargets.All, InvokeLocal = true, InvokeResim = true, TickAligned = false )]
void RpcStartBoost(){
    m_BoostAnim.StartBoostAnimation();
}

RPC 메서드 매개변수

RPC는 런타임에 직렬화되므로 일반적인 CLR 타입(e.g.: bool)을 사용하는 것이 Fusion 특유의 타입(e.g. NetworkBool)보다 권장

허용되는 데이터 매개변수

• 원시 타입 byte, sbyte, Int16, Int32, Int64, UInt16, UInt32, UInt64, float, double
• Unity 구조체 타입 Vector2, Vector3, Vector4, Quaternion, Matrix4x4, Vector2Int, Vector3Int, BoundingSphere, Bounds, Rect, BoundsInt, RectInt, Color, Color32
• System.Guid
• 사용자 정의 INetworkStructs
• Fusion 정의 INetworkStructs NetworkString, NetworkBool, Ptr, Angle, BitSet64, BitSet128, BitSet192, BitSet256, PlayerRefSet, NetworkId, NetworkButtons, NetworkRNG, NetworkObjectGuid, NetworkObjectHeader, NetworkPrefabRef, NetworkPrefabId, SceneRef, TickTimer, IFixedStorage (_2, _4, _8, _16, _32, _64, _128, _256, _512)
• Fusion 타입 NetworkObject (NetworkId로 직렬화됨), NetworkBehaviour (NetworkId와 NetworkBehaviour 인덱스로 직렬화됨), PlayerRef (PlayerRef.PlayerId로 직렬화됨)
• String
• 위에 나열된 타입의 배열

RpcInfo (선택)

RPC 메서드 선언에서 RPC 메타 정보를 제공하는 RpcInfo 사용 가능

• Tick 전송된 Tick
• Source 이를 보낸 플레이어(PlayerRef)
• Channel Unreliable 또는 Reliable로 전송되었는지 여부
• IsInvokeLocal 이 RPC를 로컬 플레이어가 호출했는지 여부

[Rpc(sources: RpcSources.InputAuthority, targets: RpcTargets.StateAuthority)]
public void RPC_Configure(string name, Color color, RpcInfo info = default){
    playerName = name;
    playerColor = color;
}

매개변수는 항상 RpcInfo info = default로 선언

Server vs Host Source

1. [Server Mode] 서버에서 보낸 RPC에 포함된 RpcInfo.Source는 PlayerRef.None으로 설정
2. [Host Mode]
   1. 호스트-클라이언트는 서버와 플레이어 둘 다 실행
   2. 기본적으로 호스트가 보낸 RPC는 서버와 동일하게 작동하여 RpcInfo.Source를 PlayerRef.None으로 설정
   3. 호스트의 로컬 PlayerRef를 포함하려면 HostMode 속성을 RpcHostMode.SourceIsHostPlayer로 설정

HostMode는 다음 두 모드 중 하나로 설정

• RpcHostMode.SourceIsServer (기본값) RpcInfo.Source가 PlayerRef.None으로 설정
• RpcHostMode.SourceIsHostPlayer Fusion이 HostMode로 실행될 때 RpcInfo.Source가 로컬 PlayerRef로 설정

호스트의 PlayerRef를 RpcSource.Info에 포함하기 위해 이전 코드를 예시와 같이 수정

[Rpc(sources: RpcSources.InputAuthority, targets: RpcTargets.StateAuthority, HostMode = RpcHostMode.SourceIsHostPlayer)]
public void RPC_Configure(string name, Color color, RpcInfo info = default){
    playerName = name;
    playerColor = color;
}

RpcInvokeInfo (선택)

RPC 메서드는 반환값으로 RPC 호출 및 전송 작업에 대한 정보가 담긴 RpcInvokeInfo를 반환 값으로 정의 가능

• LocalInvokeResult 로컬 호출 작업의 성공 여부 또는 실패 원인을 나타내는 RpcLocalInvokeResult 열거형 값
• SendCullResult 원격 피어에 대한 RPC 호출의 성공 여부 또는 실패 원인을 나타내는 RpcSendCullResult 열거형 값
• SendResult RPC 전송 작업에 대한 메타 정보를 포함하는 RpcSendResult 구조체
• Result RPC 메시지 전송 작업의 결과 플래그를 나타내는 RpcSendMessageResult
• MessageSize RPC 패키지의 크기
• Receivers 이 RPC 작업의 수신자로 포함된 PlayerRefs 컬렉션
• CulledReceivers 이 RPC 전송 작업에서 제외된 PlayerRefs 컬렉션

참고: 이는 전송 성공 여부나 실패 여부에 대한 정보가 아니라, 호출 및 전송 작업의 결과에 대한 정보만 포함됩니다.

[Rpc]
public RpcInvokeInfo RpcFoo() {
  // RPC 작업 수행
  return default;
}

public override void FixedUpdateNetwork() {
  var info = RpcFoo();
  Debug.Log(info);
}

대상 지정 RPC

특정 플레이어 기기에서만 실행될 RPC를 지정하려면 대상 지정 RPC를 사용

• 인스턴스 RPC와 정적 RPC 모두 PlayerRef 매개변수를 추가하고 [RpcTarget] 속성을 적용하여 대상 지정 RPC로 변환
• 일반적인 사용 사례는 팀 채팅과 같이 메시지가 특정 팀의 플레이어에게만 전달되도록 하는 경우

참고: [RpcTarget] 매개변수에 PlayerRef.None을 전달하면 서버를 대상으로 합니다!

[Rpc(sources: RpcSources.InputAuthority, targets: RpcTargets.All)]
public void Rpc_TargetedInstanceMessage([RpcTarget] PlayerRef player, string message) {}

[Rpc(sources: RpcSources.InputAuthority, targets: RpcTargets.All)]
public static void Rpc_MyTargetedStaticMessage(NetworkRunner runner, [RpcTarget] PlayerRef player, string message) {}

중요: 메서드 선언 내에서 사용하는 [RpcTarget] 속성은 메서드 선언 앞에 있는 [Rpc] 속성의 RpcTargets 매개변수와 다릅니다.