Resource:Missiontimer - Revision history

Vincent at 15:20, 16 May 2012

2012-05-16T15:20:55Z

← Older revision		Revision as of 15:20, 16 May 2012
Line 52:		Line 52:

	Missiontimer is only compatible with MTASA 1.0 onwards.		Missiontimer is only compatible with MTASA 1.0 onwards.

			[[ru:Resource:Missiontimer]]

R3mp at 22:10, 16 August 2010

2010-08-16T22:10:20Z

← Older revision		Revision as of 22:10, 16 August 2010
Line 12:		Line 12:

	The arguments for createMissionTimer as follows:		The arguments for createMissionTimer as follows:
	<syntaxhighlight lang="lua">createMissionTimer ( duration, countdown, ~~showCS~~, x, y, bg, font, scale )</syntaxhighlight>		<syntaxhighlight lang="lua">createMissionTimer ( duration, countdown, format, x, y, bg, font, scale, r, g, b )</syntaxhighlight>
	* duration - The time in milliseconds		* duration - The time in milliseconds
	* countdown - A bool of whether to countdown or count up. Setting it to true will count down from the duration, setting it to false will count up to the duration (latter isnt tested yet)		* countdown - A bool of whether to countdown or count up. Setting it to true will count down from the duration, setting it to false will count up to the duration (latter isnt tested yet)

R3mp at 20:31, 16 August 2010

2010-08-16T20:31:24Z

← Older revision		Revision as of 20:31, 16 August 2010
Line 6:		Line 6:
	The "deathmatch" gamemode is an example use of missiontimer. It uses the "createMissionTimer" function to create a timer, and then the onMissionTimerElapsed event to trigger at the end:		The "deathmatch" gamemode is an example use of missiontimer. It uses the "createMissionTimer" function to create a timer, and then the onMissionTimerElapsed event to trigger at the end:

	<syntaxhighlight lang="lua"> g_MissionTimer = exports.missiontimer:createMissionTimer (g_TimeLimit,true,~~true~~,0.5,20,true,"default-bold",1,~~"Time left: "~~)		<syntaxhighlight lang="lua"> g_MissionTimer = exports.missiontimer:createMissionTimer (g_TimeLimit,true,"%m:%s",0.5,20,true,"default-bold",1,255,255,255)
	addEventHandler ( "onMissionTimerElapsed", g_MissionTimer, onTimeElapsed )		addEventHandler ( "onMissionTimerElapsed", g_MissionTimer, onTimeElapsed )
	</syntaxhighlight>		</syntaxhighlight>
Line 15:		Line 15:
	* duration - The time in milliseconds		* duration - The time in milliseconds
	* countdown - A bool of whether to countdown or count up. Setting it to true will count down from the duration, setting it to false will count up to the duration (latter isnt tested yet)		* countdown - A bool of whether to countdown or count up. Setting it to true will count down from the duration, setting it to false will count up to the duration (latter isnt tested yet)
	* ~~showCS~~ - A ~~bool~~ of whether to show ~~Centiseconds. true shows them~~, ~~false hides them. Showing centi~~ seconds ~~means its in~~ the ~~format of MM:SS:CS~~ (~~e.g. 12~~:31:~~10), hiding them means its in the format of MM:SS (12~~:31)		* format - A string detailing the format of the timer text to be shown. You can chose whether to show minutes, seconds or centiseconds using these 3 strings:
			** %m - minutes
			** %s - seconds
			** %cs - centiseconds
			This allows you to add normal text onto the timer as well as showing the time left (eg: "Time left: %m:%s")
	* x,y - Position on the screen, this uses "smart positioning". It can be relative or absolute - the deathmatch gamemode creates it at 0.5,20. This means the x value is in the centre, the y is 20pixels from the top. If you specify a negative value it draws the other way, i.e. -20 would be 20pixels from the bottom rather than the top. The same can be done for x.		* x,y - Position on the screen, this uses "smart positioning". It can be relative or absolute - the deathmatch gamemode creates it at 0.5,20. This means the x value is in the centre, the y is 20pixels from the top. If you specify a negative value it draws the other way, i.e. -20 would be 20pixels from the bottom rather than the top. The same can be done for x.
	* bg - Whether to draw the default rounded-rectangle behind the timer. Setting this to false will hide it		* bg - Whether to draw the default rounded-rectangle behind the timer. Setting this to false will hide it
	* font - The font of the timer. Looks best in default-bold		* font - The font of the timer. Looks best in default-bold
	* scale - The size of the text/bg.		* scale - The size of the text/bg.
	* ~~prefix~~ - ~~Any text that you want~~ to ~~show in front~~ of the ~~time~~ (~~eg: Time left: 00:00~~)~~. Leave this blank for no text~~		* r,g,b - The red/green/blue components to make up the colour of the timer text (defaults to white)


Line 40:		Line 44:
	Set the time that the clock will turn red (in milliseconds) (ie: to indicate there is not much time left)		Set the time that the clock will turn red (in milliseconds) (ie: to indicate there is not much time left)

	<syntaxhighlight lang="lua">~~setMissionTimerPrefix~~ ( missionTimer, ~~prefix~~ )</syntaxhighlight>		<syntaxhighlight lang="lua">setMissionTimerFormat ( missionTimer, format )</syntaxhighlight>
	Set the ~~prefix~~ text on the timer		Set the text format for the timer

R3mp at 16:32, 16 August 2010

2010-08-16T16:32:09Z

← Older revision		Revision as of 16:32, 16 August 2010
Line 6:		Line 6:
	The "deathmatch" gamemode is an example use of missiontimer. It uses the "createMissionTimer" function to create a timer, and then the onMissionTimerElapsed event to trigger at the end:		The "deathmatch" gamemode is an example use of missiontimer. It uses the "createMissionTimer" function to create a timer, and then the onMissionTimerElapsed event to trigger at the end:

	<syntaxhighlight lang="lua"> g_MissionTimer = exports.missiontimer:createMissionTimer (g_TimeLimit,true,true,0.5,20,true,"default-bold",1)		<syntaxhighlight lang="lua"> g_MissionTimer = exports.missiontimer:createMissionTimer (g_TimeLimit,true,true,0.5,20,true,"default-bold",1,"Time left: ")
	addEventHandler ( "onMissionTimerElapsed", g_MissionTimer, onTimeElapsed )		addEventHandler ( "onMissionTimerElapsed", g_MissionTimer, onTimeElapsed )
	</syntaxhighlight>		</syntaxhighlight>
Line 20:		Line 20:
	* font - The font of the timer. Looks best in default-bold		* font - The font of the timer. Looks best in default-bold
	* scale - The size of the text/bg.		* scale - The size of the text/bg.
			* prefix - Any text that you want to show in front of the time (eg: Time left: 00:00). Leave this blank for no text


Line 38:		Line 39:
	<syntaxhighlight lang="lua">setMissionTimerHurryTime ( missionTimer, time )</syntaxhighlight>		<syntaxhighlight lang="lua">setMissionTimerHurryTime ( missionTimer, time )</syntaxhighlight>
	Set the time that the clock will turn red (in milliseconds) (ie: to indicate there is not much time left)		Set the time that the clock will turn red (in milliseconds) (ie: to indicate there is not much time left)

			<syntaxhighlight lang="lua">setMissionTimerPrefix ( missionTimer, prefix )</syntaxhighlight>
			Set the prefix text on the timer

R3mp at 18:52, 11 August 2010

2010-08-11T18:52:07Z

← Older revision		Revision as of 18:52, 11 August 2010
Line 23:		Line 23:

	There are also some other exported functions that you may or may not need:		There are also some other exported functions that you may or may not need:
	<syntaxhighlight lang="lua">
	setMissionTimerTime ( missionTimer, time ) --Sets the countdown/countup target time		<syntaxhighlight lang="lua">setMissionTimerTime ( missionTimer, time )</syntaxhighlight>
	getMissionTimerTime ( missionTimer ) --Gets the number currently on the clock		Sets the countdown/countup target time (in milliseconds)
	setMissionTimerFrozen ( missionTimer, frozen ) ~~--Freeze~~ the timer
	isMissionTimerFrozen ( missionTimer )		<syntaxhighlight lang="lua">getMissionTimerTime ( missionTimer )</syntaxhighlight>
	</syntaxhighlight>		Gets the number currently showing on the clock (in milliseconds)

			<syntaxhighlight lang="lua">setMissionTimerFrozen ( missionTimer, frozen )</syntaxhighlight>
			Sets the timer to frozen (true) or normal (false)

			<syntaxhighlight lang="lua">isMissionTimerFrozen ( missionTimer )</syntaxhighlight>
			See if the timer is frozen

			<syntaxhighlight lang="lua">setMissionTimerHurryTime ( missionTimer, time )</syntaxhighlight>
			Set the time that the clock will turn red (in milliseconds) (ie: to indicate there is not much time left)


	To remove a missiontimer from the screen, use [[destroyElement]].		To remove a missiontimer from the screen, use [[destroyElement]].


	Missiontimer is only compatible with MTASA 1.0 onwards.		Missiontimer is only compatible with MTASA 1.0 onwards.

Talidan at 12:06, 11 September 2009

2009-09-11T12:06:03Z

← Older revision		Revision as of 12:06, 11 September 2009
Line 32:		Line 32:


	Missiontimer is only compatible with MTASA 1.0.		Missiontimer is only compatible with MTASA 1.0 onwards.

Paul Cortez: We want it to show up on the resource catalogue, don't we?

2009-09-09T17:53:47Z

We want it to show up on the resource catalogue, don't we?

← Older revision		Revision as of 17:53, 9 September 2009
Line 1:		Line 1:
			{{Resource page}}
	Missiontimer is a resource used to easily create timers that count down or up in your resources.		Missiontimer is a resource used to easily create timers that count down or up in your resources.

Talidan: Created page with 'Missiontimer is a resource used to easily create timers that count down or up in your resources. == Overview == The "deathmatch" gamemode is an example use of missiontimer. It…'

2009-08-07T19:16:18Z

Created page with 'Missiontimer is a resource used to easily create timers that count down or up in your resources. == Overview == The "deathmatch" gamemode is an example use of missiontimer. It…'

New page

Missiontimer is a resource used to easily create timers that count down or up in your resources.

== Overview ==

The "deathmatch" gamemode is an example use of missiontimer. It uses the "createMissionTimer" function to create a timer, and then the onMissionTimerElapsed event to trigger at the end:

<syntaxhighlight lang="lua"> g_MissionTimer = exports.missiontimer:createMissionTimer (g_TimeLimit,true,true,0.5,20,true,"default-bold",1)
addEventHandler ( "onMissionTimerElapsed", g_MissionTimer, onTimeElapsed )
</syntaxhighlight>
Then you use the onTimeElapsed function that you attached to the handler at the end of the timer.

The arguments for createMissionTimer as follows:
<syntaxhighlight lang="lua">createMissionTimer ( duration, countdown, showCS, x, y, bg, font, scale )</syntaxhighlight>
* duration - The time in milliseconds
* countdown - A bool of whether to countdown or count up. Setting it to true will count down from the duration, setting it to false will count up to the duration (latter isnt tested yet)
* showCS - A bool of whether to show Centiseconds. true shows them, false hides them. Showing centi seconds means its in the format of MM:SS:CS (e.g. 12:31:10), hiding them means its in the format of MM:SS (12:31)
* x,y - Position on the screen, this uses "smart positioning". It can be relative or absolute - the deathmatch gamemode creates it at 0.5,20. This means the x value is in the centre, the y is 20pixels from the top. If you specify a negative value it draws the other way, i.e. -20 would be 20pixels from the bottom rather than the top. The same can be done for x.
* bg - Whether to draw the default rounded-rectangle behind the timer. Setting this to false will hide it
* font - The font of the timer. Looks best in default-bold
* scale - The size of the text/bg.

There are also some other exported functions that you may or may not need:
<syntaxhighlight lang="lua">
setMissionTimerTime ( missionTimer, time ) --Sets the countdown/countup target time
getMissionTimerTime ( missionTimer ) --Gets the number currently on the clock
setMissionTimerFrozen ( missionTimer, frozen ) --Freeze the timer
isMissionTimerFrozen ( missionTimer )
</syntaxhighlight>
To remove a missiontimer from the screen, use [[destroyElement]].

Missiontimer is only compatible with MTASA 1.0.