RAGE Multiplayer Wiki - User contributions [en]

Player::setCustomization

2019-07-14T19:39:35Z

Aurusse: Previous array contain 19 elements. "jawHeight" was missing

This method set player customization.
==Parameters==
* '''gender: <span style="color:#008017>Boolean</span>'''
* '''shapeFirst: <span style="color:#008017>Number</span>'''
* '''shapeSecond: <span style="color:#008017>Number</span>'''
* '''shapeThird: <span style="color:#008017>Number</span>'''
* '''skinFirst: <span style="color:#008017>Number</span>'''
* '''skinSecond: <span style="color:#008017>Number</span>'''
* '''skinThird: <span style="color:#008017>Number</span>'''
* '''shapeMix: <span style="color:#008017>Number</span>'''
* '''skinMix: <span style="color:#008017>Number</span>'''
* '''thirdMix: <span style="color:#008017>Number</span>'''
* '''eyeColor: <span style="color:#008017>Number</span>'''
* '''hairColor: <span style="color:#008017>Number</span>'''
* '''hightlightColor: <span style="color:#008017>Number</span>'''
* '''faceFeatures: <span style="color:#008017>Float[]</span>. <b>IMPORTANT</b>: The array must contain 20 elements'''

== Syntax ==
{{ServersideCode|
<pre>
player.setCustomization(Boolean gender, Number shapeFirst, Number shapeSecond, Number shapeThird, Number skinFirst, Number skinSecond, Number skinThird, Number shapeMix, Number skinMix, Number thirdMix, Number eyeColor, Number hairColor, Number hightlightColor, Number[] faceFeatures)
</pre>
}}

== Example ==
{{ServersideCode|
<pre>
var bGender = true;
if(player.model != 1885233650) {
bGender = false;
}

var MotherBlend = 21, FatherBlend = 41, fBlendShape = 0.5, fBlendSkin = 0.5, HairHighlight = 0, HairColour = 0;

var NoseWidth = 0, NoseHeight = 0, NoseLength = 0, NoseBridge = 0, NoseTip = 0, NoseBridgeShift = 0;
var BrowHeight = 0, BrowWidth = 0, CBoneHeight = 0, CBoneWidth = 0, CheekWidth = 0, Eyes = 0, Lips = 0;
var JawWidth = 0, jawHeight = 0, ChinLength = 0, ChinPos = 0, ChinWidth = 0, ChinShape = 0, NeckWidth = 0;

player.setCustomization(bGender, MotherBlend, FatherBlend, 0, MotherBlend, FatherBlend, 0, fBlendShape, fBlendSkin, 0, 1, HairColour, HairHighlight,
[
NoseWidth, NoseHeight, NoseLength, NoseBridge, NoseTip, NoseBridgeShift,
BrowHeight, BrowWidth, CBoneHeight, CBoneWidth, CheekWidth, Eyes, Lips,
JawWidth, jawHeight, ChinLength, ChinPos, ChinWidth, ChinShape, NeckWidth
]
);
</pre>
}}

==See Also==
{{Player_block}}

[[Category:Player Appearance]]
[[Category:Server-side Function]]

Players::callInDimension

2018-08-17T13:43:18Z

Aurusse: Insert first informations about this function

{{Incomplete Functions}}
This function call added client-side event for any players in a specific dimension.
NB: I just tested in local, without error, but it need to be tested with, at least, two players (in different dimensions).

==Syntax==
<syntaxhighlight lang="javascript">
player.callInDimension(Number dimension, String eventName [, ...args]);
</syntaxhighlight>
===Required Arguments===
*'''dimension:''' The dimension in which the event will be sent.
*'''eventName:''' Event name, what will be called.
*'''args:''' Any arguments, what should be sended to client. Supports entities, strings, numbers and booleans. (Objects and Arrays should be packed to JSON format.)

==Example==
That's example will call event added on client side for player inside the dimension ID 2 and disable regeneration health.

<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
let disableRegeneration = () => {
mp.game.player.setHealthRechargeMultiplier(0); //Disable regeneration
mp.gui.chat.push("Regeneration disabled"); //Output text to default chatbox
};

mp.events.add('disablePlayerRegeneration', disableRegeneration);
</syntaxhighlight>
</div>

<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript" highlight="4">
mp.players.callInDimension(2, "disablePlayerRegeneration");
</syntaxhighlight>
</div>

<b> You cannot pass Vector3 types </b> ''(send them through x,y,z and put them in a Vector3 type variable in the client function)''

==See Also==
{{Player_block}}

PlayerCommand

2018-07-30T15:36:37Z

Aurusse: remove unnecessary semicolons and add a semicolon at the right place

This event is triggered when player send command .

==Parameters==
* '''player''' - player, who send command.
* '''command''' - string with arguments.

==Example #1==
This example will write "Hello!" to player, who will enter command /meetme into chatbox.s
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
mp.events.add("playerCommand", (player, command) => {
const args = command.split(/[ ]+/);
const commandName = args.splice(0, 1)[0];

if (commandName === "meetme") {
player.outputChatBox("Hello!");
}
});
</syntaxhighlight>
</div>

==Example #2==
This example will output info about entered command into client chatbox.

if you enter "/blah 123 566", it will output next message:
"You enter command a "blah", and all arguments it a [123,566]"
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
mp.events.add("playerCommand", (command) => {
const args = command.split(/[ ]+/);
const commandName = args[0];

args.shift();

if (commandName === "blah") {
mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(",")}]`);
}
});
</syntaxhighlight>
</div>

==See also==
{{Player_events}}