Loading Screen Text - Revision history

SteveL: + 2.04 changes

2015-06-20T18:14:26Z

+ 2.04 changes

← Older revision		Revision as of 18:14, 20 June 2015
Line 1:		Line 1:
			: ''In TDM 2.03 and before, this works only on a fresh game start, not when loading a saved game. It'll be changed in TDM 2.04.''

	It's common to add flavour text to a loading screen to help set the mood and give the player something to read while the map is loading.		It's common to add flavour text to a loading screen to help set the mood and give the player something to read while the map is loading.

Line 5:		Line 7:
	Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.		Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.

	~~''edit: presently this doesn't seem to work when you load a game, only on a fresh start. [Springheel]''~~		<pre>

	onNamedEvent OnRandomValueInitialised		onNamedEvent OnRandomValueInitialised
	{		{
	if ("gui::random_value" < 0.1)		if ("gui::random_value" < 0.1)
	{		{
	set "TextLoading::text" "Text1"; // Replace "TextLoading" with the name of your text windowdef.		set "TextLoading::text" "Text1"; // Replace "TextLoading" with the name of your text windowdef.
	}		}
	else if ("gui::random_value" < 0.2)		else if ("gui::random_value" < 0.2)
	{		{
	set "TextLoading::text" "Text2";		set "TextLoading::text" "Text2";
	}		}
	else if ("gui::random_value" < 0.3)		else if ("gui::random_value" < 0.3)
	{		{
	set "TextLoading::text" "Text3";		set "TextLoading::text" "Text3";
	}		}
	else if ("gui::random_value" < 0.4)		else if ("gui::random_value" < 0.4)
	{		{
	set "TextLoading::text" "Text4";		set "TextLoading::text" "Text4";
	}		}
	else if ("gui::random_value" < 0.5)		else if ("gui::random_value" < 0.5)
	{		{
	set "TextLoading::text" "Text5";		set "TextLoading::text" "Text5";
	}		}
	else if ("gui::random_value" < 0.6)		else if ("gui::random_value" < 0.6)
	{		{
	set "TextLoading::text" "Text6";		set "TextLoading::text" "Text6";
	}		}
	else if ("gui::random_value" < 0.7)		else if ("gui::random_value" < 0.7)
	{		{
	set "TextLoading::text" "Text7";		set "TextLoading::text" "Text7";
	}		}
	else if ("gui::random_value" < 0.8)		else if ("gui::random_value" < 0.8)
	{		{
	set "TextLoading::text" "Text8";		set "TextLoading::text" "Text8";
	}		}
	else if ("gui::random_value" < 0.9)		else if ("gui::random_value" < 0.9)
	{		{
	set "TextLoading::text" "Text9";		set "TextLoading::text" "Text9";
	}		}
	else		else
	{		{
	set "TextLoading::text" "Text10";		set "TextLoading::text" "Text10";
	}		}
	}		}
			</pre>

	(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.		(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.

			===Changes in TDM 2.04===
			In TDM 2.03, the "OnRandomValueInitialised" GUI code is activated only on new mission starts, not when the player is loading a saved game. In TDM 2.04, the GUI event will be activated during save game loads too, including for quick loads.

			Quick loads can be very fast, so you might want to suppress your text (or other random GUI actions) during quickloading. TDM 2.04 will add another flag to the state information available to your gui: "gui::quickloading" which will be set to 1 when quickloading or 0 when not.

			Example usage:
			<pre>
			onNamedEvent OnRandomValueInitialised
			{
			if ("gui::quickloading" == 0) // Don't display text when quickloading
			{
			if ("gui::random_value" < 0.1)
			{
			set "TextLoading::text" "Text1"; // Replace "TextLoading" with the name of your text windowdef.
			}
			else if ("gui::random_value" < 0.2)
			{
			... etc etc
			}
			}
			</pre>

Springheel at 00:13, 12 July 2011

2011-07-12T00:13:02Z

← Older revision		Revision as of 00:13, 12 July 2011
Line 5:		Line 5:
	Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.		Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.

	''		''edit: presently this doesn't seem to work when you load a game, only on a fresh start. [Springheel]''
	edit: presently this doesn't seem to work when you load a game, only on a fresh start. [Springheel]''

	onNamedEvent OnRandomValueInitialised		onNamedEvent OnRandomValueInitialised

Springheel at 00:12, 12 July 2011

2011-07-12T00:12:44Z

← Older revision		Revision as of 00:12, 12 July 2011
Line 5:		Line 5:
	Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.		Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.

			''
			edit: presently this doesn't seem to work when you load a game, only on a fresh start. [Springheel]''

	onNamedEvent OnRandomValueInitialised		onNamedEvent OnRandomValueInitialised

Springheel at 11:08, 30 April 2011

2011-04-30T11:08:57Z

← Older revision		Revision as of 11:08, 30 April 2011
Line 3:		Line 3:
	Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.		Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.

	Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.		Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.

Springheel at 11:08, 30 April 2011

2011-04-30T11:08:26Z

← Older revision		Revision as of 11:08, 30 April 2011
Line 10:		Line 10:
	if ("gui::random_value" < 0.1)		if ("gui::random_value" < 0.1)
	{		{
	set "TextLoading::text" "Text1";		set "TextLoading::text" "Text1"; // Replace "TextLoading" with the name of your text windowdef.
	}		}
	else if ("gui::random_value" < 0.2)		else if ("gui::random_value" < 0.2)

Springheel at 20:59, 6 February 2010

2010-02-06T20:59:58Z

← Older revision		Revision as of 20:59, 6 February 2010
Line 5:		Line 5:
	Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.		Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.

	~~<math>~~
	onNamedEvent OnRandomValueInitialised		onNamedEvent OnRandomValueInitialised
	{		{
Line 49:		Line 49:
	}		}
	}		}
	~~</math>~~
	(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.		(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.

Springheel at 20:59, 6 February 2010

2010-02-06T20:59:35Z

← Older revision		Revision as of 20:59, 6 February 2010
Line 3:		Line 3:
	Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.		Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.

	~~<math>~~Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.		Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.


			<math>
	onNamedEvent OnRandomValueInitialised		onNamedEvent OnRandomValueInitialised
	{		{
Line 49:		Line 49:
	}		}
	}		}
			</math>
	(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.		(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.
	~~</math>~~

Springheel at 20:53, 6 February 2010

2010-02-06T20:53:57Z

← Older revision		Revision as of 20:53, 6 February 2010
Line 3:		Line 3:
	Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.		Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.

	<~~nowiki~~>Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.		<math>Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.


	~~[code]~~
	onNamedEvent OnRandomValueInitialised		onNamedEvent OnRandomValueInitialised
	{		{
Line 49:		Line 49:
	}		}
	}		}
	~~[/code]~~
	(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.</~~nowiki~~>		(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.
			</math>

Springheel: New page: It's common to add flavour text to a loading screen to help set the mood and give the player something to read while the map is loading. Mappers can now add a random selection of text, ...

2010-02-06T20:53:16Z

New page: It's common to add flavour text to a loading screen to help set the mood and give the player something to read while the map is loading. Mappers can now add a random selection of text, ...

New page

It's common to add flavour text to a loading screen to help set the mood and give the player something to read while the map is loading.

Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.

<nowiki>Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set.

[code]
onNamedEvent OnRandomValueInitialised
{
if ("gui::random_value" < 0.1)
{
set "TextLoading::text" "Text1";
}
else if ("gui::random_value" < 0.2)
{
set "TextLoading::text" "Text2";
}
else if ("gui::random_value" < 0.3)
{
set "TextLoading::text" "Text3";
}
else if ("gui::random_value" < 0.4)
{
set "TextLoading::text" "Text4";
}
else if ("gui::random_value" < 0.5)
{
set "TextLoading::text" "Text5";
}
else if ("gui::random_value" < 0.6)
{
set "TextLoading::text" "Text6";
}
else if ("gui::random_value" < 0.7)
{
set "TextLoading::text" "Text7";
}
else if ("gui::random_value" < 0.8)
{
set "TextLoading::text" "Text8";
}
else if ("gui::random_value" < 0.9)
{
set "TextLoading::text" "Text9";
}
else
{
set "TextLoading::text" "Text10";
}
}
[/code]
(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.</nowiki>