NetworkRunner - cheona-thousand-man/Unity-myBasics-Wiki GitHub Wiki

개요

• Fusion Network에서 Peer(or Client)를 나타내는 Unity 컴포넌트
• 통제 항목 messasing, matchmaking, connecting, spawning, simulation, state replication
• 하나의 Unity 인스턴스에서 여러 개의 NetworkRunner 인스턴스 실행 가능
  

사용법

1. 생성

• 런타임 시 Prefab에서 인스턴스화
• 씬 오브젝트로 로드
• 런타임 시 게임 오브젝트에 NetworkRunner 컴포넌트 동적으로 추가

2. 시작 및 연결

한 번 생성된 NetworkRunner 인스턴스는 matchmaking에 연결 or 방(룸) 생성/참가 가능

3. 방(룸) 생성 또는 참가

• StartGame(StartGameArgs args) 호출 시 args에 따라, Peer가 방 생성하거나 참가(싱글 플레이어 모드에서는 X)
• 참고
  • 네트워크에 연결된 Peer는 하나의 NetworkRunner 인스턴스 사용
  • 게임 세션에서 연결 해제 or 연결 실패 시 해당 NetworkRunner는 파괴 필요
  • 새로운 게임 세션을 시작하기 위해 새로운 NetworkRunner 인스턴스 생성

주요 프로퍼티/메서드

1. 프로퍼티

• Config[get] Returns the NetworkProjectConfig reference.
• Instances[get] A list of all NetworkRunners.
• DeltaTime[get] Returns the fixed tick time interval. Derived from the SimulationConfig.TickRate.
• IsClient[get] / IsServer[get] / IsPlayer[get] / IsSinglePlayer[get] / IsSharedModeMasterClient[get]
• IsRunning[get] Returns if this Fusion.Simulation is valid and running.
• LocalPlayer[get] Returns a PlayerRef for the local simulation. For a dedicated server PlayerRef.IsValid will equal false. PlayerRefs are assigned in order from 0 to MaxPlayers-1 and are re-used as players join and leave. The only caveat is that the server player (if one exists), always gets the last index no matter how many clients are connected.
• Tick[get] The tick associated with the current state of networked objects, or the current simulation tick being processed (when evaluated during FixedUpdateNetwork).
• State[get] The current state of the runner, if it's Starting, Running, Shutdown.
• DeltaTime[get] Returns the fixed tick time interval. Derived from the SimulationConfig.TickRate.

2. 메서드

• Despawn (NetworkObject networkObject, bool allowPredicted=false) Destroys a NetworkObject.
• Disconnect (PlayerRef player) Disconnect a player from the server.
• Exists (NetworkId id) Returns if the Fusion.Simulation contains a NetworkObject with given id in the current State SimulationSnapshot.
• Exists (NetworkObject obj) Returns if the Fusion.Simulation contains a reference to a NetworkObject in the current State SimulationSnapshot.
• FindObject (NetworkId oref) Get the NetworkObject instance for this NetworkRunner from a NetworkId.
• GetPlayerObject (PlayerRef player) Gets the network object associated with a specific player.
• GetPlayerUserId (PlayerRef player=default) Gets Player's UserID.
• HasAnyActiveConnections ()
• IsPlayerActive (PlayerRef player) / IsPlayerValid (PlayerRef player)
• SendRpc (SimulationMessage message {, out RpcSendResult info}) Sends RPC message. Not meant to be used directly, ILWeaver calls this.
• SetPlayerObject (PlayerRef player, NetworkObject networkObject) Sets the network object associated with this player.
• Shutdown (bool destroyGameObject=true, ShutdownReason shutdownReason=ShutdownReason.Ok, bool forceShutdownProcedure=false)
• Spawn (GameObject prefab, Vector3? position=null, Quaternion? rotation=null, PlayerRef? inputAuthority=null, OnBeforeSpawned onBeforeSpawned=null, NetworkObjectPredictionKey? predictionKey=null, bool syncPhysics=true) Attempts to network instantiate a NetworkObject using a GameObject. The supplied GameObject must have a NetworkObject component.
• StartGame (StartGameArgs args) Starts the local Fusion Runner and takes care of all major setup necessary.
• TryFindBehaviour (NetworkBehaviourId bref, out NetworkBehaviour behaviour) Get the NetworkBehaviour instance for this NetworkRunner from a NetworkBehaviourId.

상세

Runner 지원 컴포넌트

• NetworkRunner 컴포넌트 시작 시, 모든 자식 SimulationBehaviour 컴포넌트 등록
  → FixedUpdateNetwork(), Render() 콜백
• INetworkRunnerCallback 인터페이스를 구현하는 모든 자식 컴포넌트 콜백 등록

1. 내장 Fusion Runner 컴포넌트

• HitBoxManager 런타임에 자동으로 추가 / 히트박스와 히트박스 히스토리 관리
• RunnerLagCompensationGizmos 지연 보상 기즈모 활성화
• RunnerAOIGizmos 관심영역(Area Of Interest) 기즈모 활성화
• RunnerEnableVisibility
  • 다중 Peer 모드에서 Runner 가시성 활성화
  • 모든 Scene 및 스폰된 게임 오브젝트가 가시성 처리를 위해 등록
  • Runner Visibility Controls 창 작동에 필요

사용자 정의 SimulationBehaviour Runner 컴포넌트

NetworkRunner 게임 오브젝트에 추가(둘 중 하나)

• SimulationBehaviour 상속받는 컴포넌트
• INetworkRunnerCallbacks 구현하는 컴포넌트
  → NetworkRunner.StartGame() 호출 시 NetworkRunner 인스턴스에 자동 등록 후, 적절한 시점에 관련 콜백 호출

Player / PlayerRef 구조체

• [전용 서버/공유 모드 게임 서버 제외] 모든 Peer는 입력을 제공하는 사용자로 간주
• NetworkRunner에는 관련된 PlayerRef 구조체 값 보유
  • 로컬(클라이언트) PlayerRef = Runner.LocalPlayer
  • 서버 PlayerRef.None
• PlayerRef
  • 네트워크 오브젝트에 대한 Peer의 입력/상태 권한 보유 여부
  • RPC(Remote Procedure Calls)의 Peer을 지정하는 데 사용

네트워크 연결

• Peer 연결 및 전송 처리
• 매치메이킹 서버, 룸 서버, 게임 서버에 대한 연결 관리

Tick 관리

• Tick simulation, re-simulation 결정
• Tick simulation 시 FixedUpdateNetwork(), simulation 관련된 이벤트 호출

네트워크 오브젝트 관리

네트워크 오브젝트 Lifecycle(spawn, despawn etc), replication, Scene management, all networking, 관련 콜백 관리

Phycis Scene, 관심 (영역) 관리

이벤트 함수

모든 NetworkBehaviour 이벤트와 타이밍 세그먼트는 NetworkRunner 컴포넌트에서 시작

• SimulationBehabiour 가상 이벤트 콜백 함수
  • FixedUpdateNetwork()
  • Render()
• NetworkBehaviour 가상 이벤트 콜백 함수
  • Spawned()
  • Despawned()
• 추가적으로 이벤트 콜백을 구현 가능하게 해 주는 인터페이스
  • IAfterSpawned
  • IBeforeAllTicks
  • IAfterAllTicks
  • IBeforeTick
  • IAfterTick
  • IPlayerJoined
  • IPlayerLeft