SetTimer never call the callback

Development Programming & Scripting
1

Hello,

It can be a bug or a misunderstanding on my side.

I have a class which implements a singleton.

class FKServerManager : public TSharedFromThis<FKServerManager>
{
public:

	/** constructor. */
	FKServerManager(TWeakObjectPtr<UKLocalPlayer> InLocalPlayer);

	/** destructor. */
	~FKServerManager();

	/**
	* @return the global instance of the FKServerManager.
	*/
	static TSharedPtr<FKServerManager> Get()
	{
		return FKServerManager::Instance;
	}

	/**
	 * @brief Initializes the server manager with a local player.
	 *
	 * @param InLocalPlayer The local player.
	 */
	static void Initialize(TWeakObjectPtr<UKLocalPlayer> InLocalPlayer)
	{
		if (FKServerManager::Instance.IsValid())
		{
			FKServerManager::Instance.Reset();
		}
		FKServerManager::Instance = MakeShareable(new FKServerManager(InLocalPlayer));
	};

This class is in charge of searching servers and game instance running on servers.

The LocalPlayer implements a ULocalPlayer

UCLASS(config=Engine)
class UKLocalPlayer : public ULocalPlayer, public FKILocalPlayer
{
	GENERATED_UCLASS_BODY()

public:
	/**
	* Get the world the players actor belongs to
	*
	* @return  Returns the world of the ULocalPlayer.
	*/
	virtual UWorld* GetWorld() const override
	{
		return ULocalPlayer::GetWorld();
	};

	/** Quick access to the world timer manager */
	FTimerManager& GetWorldTimerManager() const
   {
     return GetWorld()->GetTimerManager();
   }

....

When I launch a search of servers, I need to call a function in the Server Manager to reinitiate a search in case no adequate games are found.
To do it I made the following call within a function in the Server Manager.

				FTimerHandle TempHandle;
				LocalPlayer->GetWorldTimerManager().SetTimer(TempHandle, FTimerDelegate::CreateSP(this, &FKServerManager::LaunchSearchAgain), 2.0f, false);

The problem is that function is never called.

Is the problem related to the fact that the call is made within a function in a result of Session Search Completed ?
Or is it a problem with a thread safe compatibility ?

I don’t want to call the function LaunchSearchAgain() within the Session Search Completed function to avoid accumulating function calls in the stack.

Anyone has an idea why the function is never called ?

Txs.
D.

2

Hi domzorg,

I think the problem that you are running into here is that the SetTimer template is not working when you try to call a function outside of the class it is being used in. You can get around this by implementing a function in the class where you are setting the timer that will call the function in the other class that you need.

I tried this by setting up a dynamic delegate in my class that had the timer, and bound the delegate in another class. When the timer ran out, it called a function in the same class that broadcast the delegate, which was picked up by the other class that then ran its own function. You could conceivably have the delegate broadcast immediately and the timer run in the other class before calling its own function, or you could even have a timer run in both classes before and after the delegate is broadcast.

3

Hi ,

You mean that the call-back must be in LocalPlayer in my case ?

Since the timer is set within the FKServerManager and the call-back function is in FKServerManager also.
I have to use the LocalPlayer to get a valid World object to access a valid TimerManager.

Is that right ?

4

Hi domzorg,

Sorry, I didn’t notice that your timer was being set in the FKServerManager class. Would it be possible to get a sample project showing how you have this set up?

5

Ok.
I have to prepare something. The project is too big to sent it as is.
Or can I send you just the files concerned by this problem ?

6

Sorry, I thought I had replied to your comment on Friday. I think all that I would need is any class involved in this setup. In particular, FKServerManager, UKLocalPlayer, and FKILocalPlayer. I think that will provide me with enough information to see how you are setting this up and, hopefully, why the function is not being called.

7

Sorry for the delay.
I’ll coming back to you later, since I’m working on another project for two months.

8

Hi,
I’ve prepared a project based on the ShooterGame.

link text

I’ve the change the quit call-back to includes a timer for leaving the game.

void FShooterIngameMenu::OnUIQuit()
{
	UShooterGameInstance* const GI = Cast<UShooterGameInstance>(PlayerOwner->GetGameInstance());
	if (GI)
	{
		GI->LabelPlayerAsQuitter(PlayerOwner);
	}
	UE_LOG(LogShooter, Log, TEXT("FShooterIngameMenu::OnUIQuit"));
	UShooterLocalPlayer* const ShooterLocalPlayer = Cast<UShooterLocalPlayer>(PlayerOwner);
	if (ShooterLocalPlayer)
	{
		ShooterLocalPlayer->LeaveGame();
		return;
	}

	GameMenuWidget->LockControls(true);
	GameMenuWidget->HideMenu();

	UWorld* const World = PlayerOwner ? PlayerOwner->GetWorld() : nullptr;
	if (World)
	{
		const FShooterMenuSoundsStyle& MenuSounds = FShooterStyle::Get().GetWidgetStyle<FShooterMenuSoundsStyle>("DefaultShooterMenuSoundsStyle");
		MenuHelper::PlaySoundAndCall(World, MenuSounds.ExitGameSound, GetOwnerUserIndex(), this, &FShooterIngameMenu::Quit);
	}
}

I’ve changed the LocalPlayer and added function for leaving the game with a timer.

UCLASS(config=Engine, transient)
class UShooterLocalPlayer : public ULocalPlayer
{
	GENERATED_UCLASS_BODY()

public:

	virtual void SetControllerId(int32 NewControllerId) override;

	virtual FString GetNickname() const;

	class UShooterPersistentUser* GetPersistentUser() const;
	
	/** Initializes the PersistentUser */
	void LoadPersistentUser();
	/**
	* @brief Leave game.
	*
	* @param InDelay	(Optional) the delay to leave the game. Default is 3 seconds.
	*/
	void LeaveGame(float InDelay = 3.0f);

	/**
	* Get the world the players actor belongs to
	*
	* @return  Returns the world of the ULocalPlayer.
	*/
	virtual UWorld* GetWorld() const override;

	/** Quick access to the world timer manager */
	FTimerManager& GetWorldTimerManager() const;

	/**
	*	@brief Exec function
	*
	*  @param	InWorld		World context
	*	@param	Cmd			The command to execute
	*	@param	Out			The output device to utilize
	*	@return	bool		true if command was processed, false if not
	*/
	virtual bool Exec(UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Out)
	{
		if (PlayerController != NULL)
			return Super::Exec(InWorld, Cmd, Out);
		return false;
	};

private:
	/**
	* @brief Call-back of the LeaveGame function.
	*/
	void LeaveGameDelayed();

private:
	/** Persistent user data stored between sessions (i.e. the user's savegame) */
	UPROPERTY()
	class UShooterPersistentUser* PersistentUser;
};



UWorld* UShooterLocalPlayer::GetWorld() const
{
	UGameInstance* GameInstance = GetGameInstance();
	if (GameInstance)
	{
		return GameInstance->GetWorld();
	}
	return ULocalPlayer::GetWorld();
}

FTimerManager& UShooterLocalPlayer::GetWorldTimerManager() const
{
	return GetWorld()->GetTimerManager();
}

void UShooterLocalPlayer::LeaveGame(float InDelay /*= 3.0f*/)
{
	UE_LOG(LogShooter, Log, TEXT("FShooterMainMenu::LeaveGame"));
	FTimerDelegate TimerDelegate;
	TimerDelegate.BindUObject(this, &ThisClass::LeaveGameDelayed);
	FTimerHandle TempHandle;
	GetWorldTimerManager().SetTimer(TempHandle, TimerDelegate, InDelay, false);
}


void UShooterLocalPlayer::LeaveGameDelayed()
{
	UE_LOG(LogShooter, Log, TEXT("FShooterMainMenu::LeaveGameDelayed"));
	Exec(GetWorld(), TEXT("quit"), *GLog);
}

If you start the game within the editor as standalone game, with the -log
You can see that the call-back is never called.

I think it is a problem with UObject derived class.

I hope it will help.
D.

9

Thank you for providing the sample code. I believe I was able to see what you described, but can you confirm that this only happens when trying to quit from one of the maps in the project when playing in Standalone mode?

When I tried quitting from the Main Menu, or when running the game in the Visual Studio debugger, it appeared to work correctly. Is that the case for you?

10

Hello,

I’ve tried the SetTimer call in the game menu only, I don’t do it in the main menu.
I think it is a problem with UObject derived class. It works for AActor derived class.
I’m not sure it is a problem with leaving the map since the function FShooterIngameMenu::OnUIQuit() call the local player’s function LeaveGame() and return. Don’t leave any map, just sets a call-back with a timer that will execute the quit command.

I’ve tried within Visual Studio 201 in debug mode and launching the Editor. From the editor, I’ve launched the Standalone game.

Are you able to sets a timer within an UObject derived class ?

11

Hi,

Sorry for not responding sooner, I lost track of this post. Is this something that is still giving you trouble? I was able to do some additional debugging on this today, and I noticed something odd about this. If I launch standalone directly into a level in Shooter Game (either Highrise or Sanctuary, the result was the same), then delayed quit never gets called as you mentioned. However, if I instead launch into the ShooterEntry map, which provides the main menu, then load into one of the levels, the delayed quit works correctly. I also noticed that the in-game menu is slightly different in that case as well.

There appears to be a difference in how this logic is handled depending on how you initially get into the level, either directly or by loading in from the main menu. Unfortunately I am not familiar enough with Shooter Game to determine why that is the case. I suspect that something may not be getting initialized correctly when launching directly into the level.