Events::addDataHandler - Revision history

Xabi at 08:16, 26 December 2022

2022-12-26T08:16:28Z

← Older revision		Revision as of 08:16, 26 December 2022
Line 1:		Line 1:
	This Function is used to alert client-side with entity's data change for a specified variable		This Function is used to alert client-side with entity's data change for a specified variable

	{{ClientsideCsJsFunction}}		<br>{{ClientsideCsJsFunction}}

	{{CSharpContainer\|		{{CSharpContainer\|
Line 7:		Line 7:
	RAGE.Events.AddDataHandler(string name, OnEntityDataChangeDelegate handler);		RAGE.Events.AddDataHandler(string name, OnEntityDataChangeDelegate handler);
	</pre>		</pre>

	~~{{Parameters}}~~
	* '''name'''
	* '''handler'''
	}}		}}

Xabi at 08:11, 26 December 2022

2022-12-26T08:11:58Z

← Older revision		Revision as of 08:11, 26 December 2022
Line 5:		Line 5:
	{{CSharpContainer\|		{{CSharpContainer\|
	<pre>		<pre>
	RAGE.~~events~~.AddDataHandler(string name, OnEntityDataChangeDelegate handler);		RAGE.Events.AddDataHandler(string name, OnEntityDataChangeDelegate handler);
	</pre>		</pre>

Kar at 16:17, 6 November 2019

2019-11-06T16:17:56Z

← Older revision		Revision as of 16:17, 6 November 2019
Line 22:		Line 22:
	** '''entity''': {{RageType\|Entity}} - The [[:Category:Entity API\|entity]] that had the data change.		** '''entity''': {{RageType\|Entity}} - The [[:Category:Entity API\|entity]] that had the data change.
	** '''value''': {{RageType\|Any}} - The new value of the data key.		** '''value''': {{RageType\|Any}} - The new value of the data key.
			** '''oldValue''': {{RageType\|Any}} - The old value of the data key.

	{{Example}}		{{Example}}
Line 30:		Line 31:
	*/		*/

	mp.events.addDataHandler("testVar", (entity, value) => {		mp.events.addDataHandler("testVar", (entity, value, oldValue) => {
	mp.gui.chat.push(`testVar changed to ${value} on entity ${entity.handle}.`);		mp.gui.chat.push(`testVar changed to ${value} on entity ${entity.handle}.`);
	});		});
Line 51:		Line 52:
	{{ClientsideCode\|		{{ClientsideCode\|
	<pre>		<pre>
	mp.events.addDataHandler('newNick', function (entity, value) {		mp.events.addDataHandler('newNick', function (entity, value, oldValue) {
	if (entity.type === 'player') mp.gui.chat.push(`${player.getVariable('oldNick')} has changed nickname to ${value}`)		if (entity.type === 'player') mp.gui.chat.push(`${player.getVariable('oldNick')} has changed nickname to ${value}`)
	})		})

RoboN1X: Merged from old page https://wiki.rage.mp/index.php?title=AddDataHandler

2019-05-24T13:37:52Z

Merged from old page https://wiki.rage.mp/index.php?title=AddDataHandler

← Older revision		Revision as of 13:37, 24 May 2019
Line 1:		Line 1:
	This Function is used to alert client-side with entity's data change for a specified variable		This Function is used to alert client-side with entity's data change for a specified variable

	~~==Syntax==~~		{{ClientsideCsJsFunction}}

			{{CSharpContainer\|
	<pre>		<pre>
	mp.events.~~addDataHandler~~(~~"syncedVariable"~~, ~~function (entity, value) {~~		RAGE.events.AddDataHandler(string name, OnEntityDataChangeDelegate handler);
	~~// do something...~~
	});
	</pre>		</pre>

	~~==Example==~~		{{Parameters}}
			* '''name'''
			* '''handler'''
			}}

	~~This example sets nickname for player and triggers players~~' ~~clientside~~ data ~~handler~~		{{JSContainer\|
			<pre>
			mp.events.addDataHandler(key, handlerFunction);
			</pre>
			{{Parameters}}
			* '''key''': {{RageType\|String}} - Shared data key's name.
			* '''handlerFunction''': Handler function with parameters:
			** '''entity''': {{RageType\|Entity}} - The [[:Category:Entity API\|entity]] that had the data change.
			** '''value''': {{RageType\|Any}} - The new value of the data key.

	{{~~ClientsideCode\|~~		{{Example}}
	<pre>		<pre>
	mp.events.addDataHandler(~~'newNick'~~, ~~function~~ (entity, value) {		/*
	~~if (entity.type === 'player')~~ mp.gui.chat.push(`${~~player.getVariable('oldNick')~~} ~~has changed nickname to~~ ${~~value~~}`)		Handles testVar change.
	})		Do "player.data.testVar = 1234;" on server-side to trigger this.
			*/

			mp.events.addDataHandler("testVar", (entity, value) => {
			mp.gui.chat.push(`testVar changed to ${value} on entity ${entity.handle}.`);
			});
	</pre>		</pre>
	}}
	~~<br>~~		{{Example}}
			This example sets nickname for player and triggers players' clientside data handler

	{{ServersideCode\|		{{ServersideCode\|
	<pre>		<pre>
Line 28:		Line 46:
	});		});
	</pre>		</pre>
			}}


			{{ClientsideCode\|
			<pre>
			mp.events.addDataHandler('newNick', function (entity, value) {
			if (entity.type === 'player') mp.gui.chat.push(`${player.getVariable('oldNick')} has changed nickname to ${value}`)
			})
			</pre>
			}}
	}}		}}

	==See Also==		==See Also==
			* [[EntityDataChangeByKey]]

	{{Event_functions}}		{{Event_functions}}

			[[Category:Entity API]]
			[[Category:Shared Property]]
			[[Category:Client-side Function]]

Unknown: Created page with "This Function is used to alert client-side with entity's data change for a specified variable ==Syntax==

 mp.events.addDataHandler("syncedVariable", function (entity, va..."

2019-05-24T11:41:00Z

Created page with "This Function is used to alert client-side with entity's data change for a specified variable ==Syntax== <pre> mp.events.addDataHandler("syncedVariable", function (entity, va..."

New page

This Function is used to alert client-side with entity's data change for a specified variable

==Syntax==
<pre>
mp.events.addDataHandler("syncedVariable", function (entity, value) {
// do something...
});
</pre>

==Example==

This example sets nickname for player and triggers players' clientside data handler

{{ClientsideCode|
<pre>
mp.events.addDataHandler('newNick', function (entity, value) {
if (entity.type === 'player') mp.gui.chat.push(`${player.getVariable('oldNick')} has changed nickname to ${value}`)
})
</pre>
}}
<br>
{{ServersideCode|
<pre>
mp.events.addCommand('setNick', (player, nickname) => {
player.setVariable('oldNick', player.name);
player.name = nickname;
player.setVariable('newNick', nickname);
});
</pre>
}}

==See Also==
{{Event_functions}}