Unregister

method
Unregister<public>(Agent: agent): void

Removes `Agent` as a target when using the *CanBeHeardBy* Registered Players or NonRegisteredPlayers options.

Module
/Fortnite.com/Devices
Declared in
audio_mixer_device
Source
fortnite

Used in

OnUnseat(Agent : agent) : void =
        DriverCamera.RemoveFrom(Agent)
        Throttle.Unregister(Agent)
        SteerLeft.Unregister(Agent)
        SteerRight.Unregister(Agent)
        PaintInput.Unregister(Agent)
        set Driving = false
        Print("CarCapstone: driver left -> controls released.")
OnExit(Agent : agent) : void =
        DriverCamera.RemoveFrom(Agent)
        HornInput.Unregister(Agent)
        Print("CarFirstPerson: driver exited -> first person OFF.")

    # The configured key was pressed by a seated driver.
    OnHorn(Agent : agent) : void =
        Print("CarFirstPerson: HONK!")
PropHuntTemplate / Heartbeat verse-source
Disable(PropAgent:agent, HeartBeatVFXData:heartbeat_vfx):void =
        Logger.Print("Disabling heart beat.")

        # Deactivate the VFX visuals.
        HeartBeatVFXData.Deactivate()

        # Unregister the prop agent from the audio player device, causing the heartbeat audio to stop.
        SFXPlayer.Unregister(PropAgent)

        # Decrement the heartbeat counter. This counter should never drop below 0.
        set NumberOfHeartBeats -= 1
        if (NumberOfHeartBeats < 0) then set NumberOfHeartBeats = 0
ProceduralBuilding / Root Device verse-source
DisableBuildInputForPlayer(Agent:agent):void=
        InputDevice_Place.Unregister(Agent)
        InputDevice_Delete.Unregister(Agent)
        InputDevice_PrevCategory.Unregister(Agent)
        InputDevice_NextCategory.Unregister(Agent)
CameraSystem / Enhanced Camera Controller verse-source
UnsubscribePlayerFromInput(Player : agent) : void =
        if (Subscription := CameraInputSubscription?):
            Subscription.Cancel()
        if (Subscription := CameraReleaseSubscription?):
            Subscription.Cancel()
        GetPlayspace().GetHUDController().ResetElementVisibility(array{CameraUIKeys})
        CameraInputKey.Unregister(Player)
    
    # Camera State Management
    GetPlayerState(Player : agent)<transacts> : ?enhanced_player_camera_state =
        if (State := RegisteredPlayersMap[Player]):
            option{State}
        else:
CameraSystem / Camera Module verse-source
UnsubscribePlayerFromInput(Player : agent) : void =
            if (Subscription := CameraInputSubscription?):
                Subscription.Cancel()
            if (Subscription := CameraReleaseSubscription?):
                Subscription.Cancel()
            GetPlayspace().GetHUDController().ResetElementVisibility(array{CameraUIKeys})
            CameraInputKey.Unregister(Player)
    

        # Camera State Management
        GetPlayerState(Player : agent)<transacts> : ?player_camera_state =
            if (State := RegisteredPlayersMap[Player]):
                option{State}
GamePlay / Vehicle Controller Device verse-source
CancelSubscription(InputForwardSubscription)
        CancelSubscription(InputSirensSubscription)
        CancelSubscription(InputLeftSubscription)
        CancelSubscription(InputRightSubscription)
        CancelSubscription(InputReverseSubscription)

        InputForward.Unregister(Agent)
        InputForward.Disable()
        InputReverse.Unregister(Agent)
        InputReverse.Disable()
        InputLeft.Unregister(Agent)
        InputLeft.Disable()
        InputRight.Unregister(Agent)
JoustingGame / Jousting Roles verse-source
if (Input := InputTrigger?):
            Input.Disable()
            Input.Unregister(Agent)
        
        #if (Camera := CameraController?):
        #    Camera.UnregisterPlayer(Agent)
        #    Camera.DisableCameras()
        
        if (Map := MapController?):
JoustingGame / Jousting Input Controller verse-source
# Unregister a player and cleanup
    UnregisterPlayer(Player : agent):void =
        UnRegisterInputs(Player)
        UnRegisterSkillChecks(Player)
        #CancelInputMap(InputSubscriptionsMap, Player)
        if (PlayerData := GetPlayerData[Player]):
            for (Sub : PlayerData.SessionData.InputSubscriptions):
                Sub.Cancel()