OnResourcePreStart - Revision history

Srslyyyy: Improve example.

2021-09-16T08:07:37Z

Improve example.

← Older revision		Revision as of 08:07, 16 September 2021
Line 20:		Line 20:
	This code will output the name of any resource that is starting.		This code will output the name of any resource that is starting.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function displayStartingRes ( res )		function displayStartingRes(res)
	outputChatBox ( "Resource " .. getResourceName(res) .. " is going to start", ~~getRootElement()~~, 255, 255, 255 )		outputChatBox("Resource "..getResourceName(res).." is going to start.", root, 255, 255, 255)
	end		end
	addEventHandler ( "onResourcePreStart", ~~getRootElement()~~, displayStartingRes )		addEventHandler("onResourcePreStart", root, displayStartingRes)
	</syntaxhighlight>		</syntaxhighlight>

	{{See also/Server event\|Resource events}}		{{See also/Server event\|Resource events}}

Botder at 03:04, 27 September 2018

2018-09-27T03:04:19Z

← Older revision		Revision as of 03:04, 27 September 2018
Line 26:		Line 26:
	</syntaxhighlight>		</syntaxhighlight>

	==See ~~Also==~~		{{See also/Server event\|Resource events}}
	~~===~~Resource events~~===~~
	~~{{Resource_events}}~~
	~~===Event functions===~~
	~~{{Event functions~~}}

Botder at 02:20, 27 September 2018

2018-09-27T02:20:46Z

← Older revision		Revision as of 02:20, 27 September 2018
Line 26:		Line 26:
	</syntaxhighlight>		</syntaxhighlight>

	{{See ~~also/Server event\|~~Resource events}}		==See Also==
			===Resource events===
			{{Resource_events}}
			===Event functions===
			{{Event functions}}

Myonlake: /* Parameters */

2018-04-02T22:07:33Z

Parameters

← Older revision		Revision as of 22:07, 2 April 2018
Line 9:		Line 9:
	</syntaxhighlight>		</syntaxhighlight>

	*'''startingResource''': ~~The~~ resource that is starting		*'''startingResource''': the [[resource]] that is starting.

	==Source==		==Source==

Rafalh: Mention that OnResourcePreStart source is root element, not resource root element...

2018-03-21T20:00:31Z

Mention that OnResourcePreStart source is root element, not resource root element...

← Older revision		Revision as of 20:00, 21 March 2018
Line 3:		Line 3:
	Analogous to [[onResourceStart]], but triggered before script files are initialised.		Analogous to [[onResourceStart]], but triggered before script files are initialised.
	{{Note\|This event isn't triggered within the resource starting.}}		{{Note\|This event isn't triggered within the resource starting.}}


	'''Important:''' If you attach this event to the [[root element]] it will be called when ''any'' [[resource]] starts - attach it to to the [[root element]] of the desired resource, eg. [[getResourceRootElement]]([[getResourceFromName]]("freeroam")).

	==Parameters==		==Parameters==
Line 15:		Line 12:

	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the root [[element]] ~~of the resource~~.		The [[event system#Event source\|source]] of this event is the root [[element]].

	==Cancel effect==		==Cancel effect==

Zangomangu at 14:49, 12 January 2014

2014-01-12T14:49:49Z

← Older revision		Revision as of 14:49, 12 January 2014
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	__NOTOC__		__NOTOC__
	This event is triggered ~~before a~~ resource ~~is loaded~~.		Analogous to [[onResourceStart]], but triggered before script files are initialised.
			{{Note\|This event isn't triggered within the resource starting.}}

	'''Important:''' If you attach this event to the root element it will called when ''any'' resource starts~~, not just the resource your script is running inside. As such, most of the time you will want~~ to ~~check that the resource passed~~ to ~~this event matches your resource (compare with~~ the ~~value returned by~~ [[~~getThisResource~~]]~~) before doing anything~~. ~~Alternatively you can attach the event to~~ [[getResourceRootElement]]([[~~getThisResource~~]]()).
			'''Important:''' If you attach this event to the [[root element]] it will be called when ''any'' [[resource]] starts - attach it to to the [[root element]] of the desired resource, eg. [[getResourceRootElement]]([[getResourceFromName]]("freeroam")).

	==Parameters==		==Parameters==
Line 13:		Line 15:

	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the root [[element]].		The [[event system#Event source\|source]] of this event is the root [[element]] of the resource.

	==Cancel effect==		==Cancel effect==
			If this event is cancelled, the resource won't begin starting.

	==Example==		==Example==
Line 21:		Line 24:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function displayStartingRes ( res )		function displayStartingRes ( res )
	outputChatBox ( "Resource " .. getResourceName(res) .. " is ~~starting~~", getRootElement(), 255, 255, 255 )		outputChatBox ( "Resource " .. getResourceName(res) .. " is going to start", getRootElement(), 255, 255, 255 )
	end		end
	addEventHandler ( "onResourcePreStart", getRootElement(), displayStartingRes )		addEventHandler ( "onResourcePreStart", getRootElement(), displayStartingRes )

Jaysds at 01:32, 6 April 2012

2012-04-06T01:32:29Z

← Older revision		Revision as of 01:32, 6 April 2012
Line 1:		Line 1:
	~~{{Needs_Checking\|first parameter isn't the same resource/memory adress like getThisResource(). In addition this event is always attached to the root element}}~~
	{{Server event}}		{{Server event}}
	__NOTOC__		__NOTOC__

Winky- at 21:03, 9 January 2012

2012-01-09T21:03:32Z

← Older revision		Revision as of 21:03, 9 January 2012
Line 1:		Line 1:
			{{Needs_Checking\|first parameter isn't the same resource/memory adress like getThisResource(). In addition this event is always attached to the root element}}
	{{Server event}}		{{Server event}}
	__NOTOC__		__NOTOC__
	~~{{Needs_Checking\|first parameter isn't the same resource/memory adress like getThisResource(). In addition this event is always attached to the root element}}~~
	This event is triggered before a resource is loaded.		This event is triggered before a resource is loaded.

Justus H. at 19:26, 9 January 2012

2012-01-09T19:26:04Z

← Older revision		Revision as of 19:26, 9 January 2012
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	__NOTOC__		__NOTOC__
	{{Needs_Checking\|first parameter isn't the same resource/memory adress like getThisResource()}}		{{Needs_Checking\|first parameter isn't the same resource/memory adress like getThisResource(). In addition this event is always attached to the root element}}
	This event is triggered before a resource is loaded.		This event is triggered before a resource is loaded.

Justus H. at 19:24, 9 January 2012

2012-01-09T19:24:08Z

← Older revision		Revision as of 19:24, 9 January 2012
Line 1:		Line 1:
	{{Server event}}		{{Server event}}
	__NOTOC__		__NOTOC__
			{{Needs_Checking\|first parameter isn't the same resource/memory adress like getThisResource()}}
	This event is triggered before a resource is loaded.		This event is triggered before a resource is loaded.

Line 13:		Line 14:

	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the root [[element]] ~~in the resource that is starting~~.		The [[event system#Event source\|source]] of this event is the root [[element]].

	==Cancel effect==		==Cancel effect==