RAGE Multiplayer Wiki - User contributions [en]

Template:Blip functions c

2022-02-06T16:36:16Z

Update450:

*[[Blip::Blip]]
*[[Blip::addTextComponentSubstringName|Blip.addTextComponentSubstringName]]
*[[Blip::doesExist|Blip.doesExist]]
*[[Blip::endTextCommandSetName|Blip.endTextCommandSetName]]
*[[Blip::getAlpha|Blip.getAlpha]]
*[[Blip::getColour|Blip.getColour]]
*[[Blip::getCoords|Blip.getCoords]]
*[[Blip::getFirstInfoId|Blip.getFirstInfoId]]
*[[Blip::getInfoIdDisplay|Blip.getInfoIdDisplay]]
*[[Blip::getInfoIdEntityIndex|Blip.getInfoIdEntityIndex]]
*[[Blip::getInfoIdPickupIndex|Blip.getInfoIdPickupIndex]]
*[[Blip::getInfoIdType|Blip.getInfoIdType]]
*[[Blip::getHudColour|Blip.getHudColour]]
*[[Blip::getNextInfoId|Blip.getNextInfoId]]
*[[Blip::getSprite|Blip.getSprite]]
*[[Blip::isFlashing|Blip.isFlashing]]
*[[Blip::isMissionCreator|Blip.isMissionCreator]]
*[[Blip::isOnMinimap|Blip.isOnMinimap]]
*[[Blip::isShortRange|Blip.isShortRange]]
*[[Blip::hideNumberOn|Blip.hideNumberOn]]
*[[Blip::pulse|Blip.pulse]]
*[[Blip::setAlpha|Blip.setAlpha]]
*[[Blip::setAsFriendly|Blip.setAsFriendly]]
*[[Blip::setAsMissionCreator|Blip.setAsMissionCreator]]
*[[Blip::setAsShortRange|Blip.setAsShortRange]]
*[[Blip::setBright|Blip.setBright]]
*[[Blip::setCategory|Blip.setCategory]]
*[[Blip::setColour|Blip.setColour]]
*[[Blip::setCoords|Blip.setCoords]]
*[[Blip::setDisplay|Blip.setDisplay]]
*[[Blip::setFade|Blip.setFade]]
*[[Blip::setFlashes|Blip.setFlashes]]
*[[Blip::setFlashesAlternate|Blip.setFlashesAlternate]]
*[[Blip::setFlashInterval|Blip.setFlashInterval]]
*[[Blip::setFlashTimer|Blip.setFlashTimer]]
*[[Blip::setHighDetail|Blip.setHighDetail]]
*[[Blip::setNameFromTextFile|Blip.setNameFromTextFile]]
*[[Blip::setNameToPlayerName|Blip.setNameToPlayerName]]
*[[Blip::setPriority|Blip.setPriority]]
*[[Blip::setRotation|Blip.setRotation]]
*[[Blip::setRoute|Blip.setRoute]]
*[[Blip::setRouteColour|Blip.setRouteColour]]
*[[Blip::setScale|Blip.setScale]]
*[[Blip::setSecondaryColour|Blip.setSecondaryColour]]
*[[Blip::setShowCone|Blip.setShowCone]]
*[[Blip::setShowHeadingIndicator|Blip.setShowHeadingIndicator]]
*[[Blip::setSprite|Blip.setSprite]]
*[[Blip::showNumberOn|Blip.showNumberOn]]

Blip::setColor

2022-02-06T16:31:38Z

Update450: Update450 moved page Blip::setColor to Blip::setColour over redirect: wrong function name

#REDIRECT [[Blip::setColour]]

Blip::setColour

2022-02-06T16:31:38Z

Update450: Update450 moved page Blip::setColor to Blip::setColour over redirect: wrong function name

Function to set a blip color. Default to yellow if not used.
==Syntax==
<syntaxhighlight lang="javascript">blip.setColour(color);</syntaxhighlight>
===Required Argument===
* '''color:''' {{RageType|Number}} [[Blips#Blip_colors|color list]]
===Return value===
* '''Undefined'''
==Example==
{{ClientsideCode|
<syntaxhighlight lang="javascript">
let blip = mp.blips.new(1, new mp.Vector3(407.95, -961.05, 0));
blip.setColour(1); // Set blip color to red
</syntaxhighlight>
}}
==See also==
{{Blip_s_function_c}}
[[Category:Clientside API]]
[[Category:Blip API]]
[[Category:Client-side Function]]

User:Update450

2021-08-10T16:25:53Z

Update450: Created page with "czesc"

czesc

Graphics::drawMarker

2021-08-10T16:22:02Z

Update450: visual enhancement

{{ClientSide}}

Use this function to draw a marker.
This function is used in a ''render'' event.
__TOC__
<br>
{{JSContainer|
<pre>
mp.game.graphics.drawMarker(type,
posX, posY, posZ,
dirX, dirY, dirZ,
rotX, rotY, rotZ,
scaleX, scaleY, scaleZ,
colorR, colorG, colorB, alpha,
bobUpAndDown, faceCamera, p19,
rotate, textureDict, textureName, drawOnEnts
);
</pre>

=== Required Arguments ===
*'''type''': {{RageType|number}}
*'''posX''': {{RageType|number}}
*'''posY''': {{RageType|number}}
*'''posZ:''': {{RageType|number}}
*'''dirX''': {{RageType|number}}
*'''dirY''': {{RageType|number}}
*'''dirZ''': {{RageType|number}}
*'''rotX''': {{RageType|number}}
*'''rotY''': {{RageType|number}}
*'''rotZ''': {{RageType|number}}
*'''scaleX''': {{RageType|number}}
*'''scaleY''': {{RageType|number}}
*'''scaleZ''': {{RageType|number}}
*'''colorR''': {{RageType|number}}
*'''colorG''': {{RageType|number}}
*'''colorB''': {{RageType|number}}
*'''alpha''': {{RageType|number}}
*'''bobUpAndDown''': {{RageType|boolean}}
*'''faceCamera''': {{RageType|boolean}}
*'''p19''': {{RageType|number}}
*'''rotate''': {{RageType|boolean}}
*'''textureDict''': {{RageType|string}}
*'''textureName''': {{RageType|string}}
*'''drawOnEnts''': {{RageType|boolean}}
===Return value===
*{{RageType|void}}
==Example==
This example will create a little marker above the player's head.
{{ClientsideCode|
<pre>
new mp.Event('render', () => {
let pos = mp.players.local.position;

mp.game.graphics.drawMarker(
0,
pos.x, pos.y, pos.z + 2,
0, 0, 0,
0, 0, 0,
1.0, 1.0, 1.0,
255, 255, 255, 255,
false, false, 2,
false, null, null, false,
);
});
</pre>
}}
}}
==See also==
{{Graphics_functions_c}}
[[Category:Clientside API]]

Graphics::drawMarker

2021-08-10T16:09:48Z

Update450: mp.game v2 example compatibility

__NOTOC__
===Description===
Use this function to draw a marker.

This function is used in a ''render'' event.
===Syntax===
{{ClientSide}}
<syntaxhighlight lang="javascript">
mp.game.graphics.drawMarker(type,
posX, posY, posZ,
dirX, dirY, dirZ,
rotX, rotY, rotZ,
scaleX, scaleY, scaleZ,
colorR, colorG, colorB, alpha,
bobUpAndDown, faceCamera, p19,
rotate, textureDict, textureName, drawOnEnts
);
</syntaxhighlight>
=== Required Arguments ===
*'''type''': {{RageType|number}}
*'''posX''': {{RageType|number}}
*'''posY''': {{RageType|number}}
*'''posZ:''': {{RageType|number}}
*'''dirX''': {{RageType|number}}
*'''dirY''': {{RageType|number}}
*'''dirZ''': {{RageType|number}}
*'''rotX''': {{RageType|number}}
*'''rotY''': {{RageType|number}}
*'''rotZ''': {{RageType|number}}
*'''scaleX''': {{RageType|number}}
*'''scaleY''': {{RageType|number}}
*'''scaleZ''': {{RageType|number}}
*'''colorR''': {{RageType|number}}
*'''colorG''': {{RageType|number}}
*'''colorB''': {{RageType|number}}
*'''alpha''': {{RageType|number}}
*'''bobUpAndDown''': {{RageType|boolean}}
*'''faceCamera''': {{RageType|boolean}}
*'''p19''': {{RageType|number}}
*'''rotate''': {{RageType|boolean}}
*'''textureDict''': {{RageType|string}}
*'''textureName''': {{RageType|string}}
*'''drawOnEnts''': {{RageType|boolean}}
===Return value===
*{{RageType|void}}
==Example==
This example will create a little marker above the player's head.
{{ClientsideCode|
<pre>
new mp.Event('render', () => {
let pos = mp.players.local.position;

mp.game.graphics.drawMarker(
0,
pos.x, pos.y, pos.z + 2,
0, 0, 0,
0, 0, 0,
1.0, 1.0, 1.0,
255, 255, 255, 255,
false, false, 2,
false, null, null, false,
);
});

</pre>
==See also==
{{Graphics_functions_c}}
[[Category:Clientside API]]

Entity::setOwnVariables

2021-04-29T09:09:00Z

Update450: Created page with "{{ServersideJsFunction}} Set multiple custom data variables that will be only available to an entity. {{JSContainer| ==Syntax== <pre> entity.setOwnVariables({'variable1': va..."

{{ServersideJsFunction}}

Set multiple custom data variables that will be only available to an entity.

{{JSContainer|
==Syntax==
<pre>
entity.setOwnVariables({'variable1': value1, 'variable2': value2});
</pre>

== Example ==

This will set the multiple values for specific player, which will only be available to him.

{{ServersideCode|
<pre>
player.setOwnVariables({
'foo': 'bar',
'beast': true
});
</pre>
}}

Now variables can be used on client-side but they will be only available for player specified on server-side.
<br>
{{ClientsideCode|
<pre>
mp.players.local.getVariable('foo'); // 'bar'
mp.players.local.getVariable('beast'); // true
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Pool::atHandle

2021-01-04T10:46:21Z

Update450: Created page with "This function is used to return an element from a pool at an entity handle. ==Syntax== <pre> Entity pool.atHandle(Number handle) </pre> ===Required Arguments=== *'''handle:'..."

This function is used to return an element from a pool at an entity handle.

==Syntax==
<pre>
Entity pool.atHandle(Number handle)
</pre>
===Required Arguments===
*'''handle:''' You can get that for example using entity.handle function.

===Returns===
*{{RageType|Entity}}
*'''Note:''' If entity with selected handle does not exist, it will return '''undefined'''.

==Example==
This example will return a player by '''handle''' and output his name on the chat.
{{ClientsideCode|
<pre>
const player = mp.players.atHandle(mp.players.at(0).handle); // get handle of player with id 0
if (player) {
mp.gui.chat.push(`Player with handle: ${localPlayerHandle} is named ${player.name}.`);
} else {
mp.gui.chat.push(`Player with handle: ${localPlayerHandle} does not exist.`);
}
</pre>
}}

==See Also==
{{EntityPool_function}}

Ui::setNotificationMessage

2020-12-05T12:22:39Z

Update450: Minor edits

See [[Notification Pictures]] for a list of notification pictures. Pictures from this link have the same '''textureDict''' and '''textureName'''.

Also some of them needs to be requested with [[Graphics::requestStreamedTextureDict]].

==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.setNotificationMessage(textureDict, textureName, flash, iconType, sender, subject);</syntaxhighlight>

===Icon types===
* '''No Icon''': 0, 4, 5, 6
* '''Speech Bubble''': 1
* '''Message''': 2
* '''Friend Request''': 3
* '''Arrow''': 7
* '''RP''': 8
* '''Money''': 9

=== Required Arguments ===
*'''textureDict:''' {{RageType|String}}
*'''textureName:''' {{RageType|String}}
*'''flash:''' {{RageType|Boolean}}
*'''iconType:''' {{RageType|Int}}
*'''sender:''' {{RageType|String}}
*'''subject:''' {{RageType|String}}

===Return value===
*{{RageType|Int}}

==Example==
{{ClientsideCode|
<pre>
const notifyWithPicture = () => {
mp.game.ui.setNotificationTextEntry('STRING');
mp.game.ui.setNotificationMessage('CHAR_RON', 'CHAR_RON', false, 2, 'New Message', 'Hello World!');
};

notifyWithPicture();
</pre>
}}
Output:
[[File:outputnative.png|200px]]

Values '''textureDict''' and '''textureName''' gives you ability to make custom notifcation pictures using: [[Using_DLC_Packs_with_Custom_Textures]]
{{ClientsideCode|
<pre>
// Before using your custom textures you must request them by this function
mp.game.graphics.requestStreamedTextureDict('notifications', true);

const notifyWithPicture = () => {
mp.game.ui.setNotificationTextEntry('STRING');
mp.game.ui.setNotificationMessage('notifications', 'rage', false, 2, 'New Message', 'Hi, now your notifications look ~y~beast');
};

notifyWithPicture();
</pre>
}}
Output:
[[File:outputcustom.png|200px]]

or using in-game sprites and textures (see [[Textures]]):
{{ClientsideCode|
<pre>
// Just in case you should request textureDict
mp.game.graphics.requestStreamedTextureDict('commonmenu', true);

const notifyWithPicture = () => {
mp.game.ui.setNotificationTextEntry('STRING');
return mp.game.ui.setNotificationMessage('commonmenu', 'mp_specitem_cash', false, 9, 'New notification!', 'Your account has been charged');
};

notifyWithPicture();
</pre>
}}
Output:
[[File:outputcustom2.png|200px]]

==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]

Ui::setNotificationMessage

2020-12-05T10:07:51Z

Update450: New examples, icons info, and tutorial how to use own textures and in-game sprites

See [[Notification Pictures]] for a list of notification pictures. Pictures from this link have the same '''textureDict''' and '''textureName'''.

Also some of them needs to be requested with [[Graphics::requestStreamedTextureDict]].

==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.setNotificationMessage(textureDict, textureName, flash, iconType, sender, subject);</syntaxhighlight>

===Icon types===
* '''No Icon''': 0, 4, 5, 6
* '''Speech Bubble''': 1
* '''Message''': 2
* '''Friend Request''': 3
* '''Arrow''': 7
* '''RP''': 8
* '''Money''': 9

=== Required Arguments ===
*'''textureDict:''' {{RageType|String}}
*'''textureName:''' {{RageType|String}}
*'''flash:''' {{RageType|Boolean}}
*'''iconType:''' {{RageType|Int}}
*'''sender:''' {{RageType|String}}
*'''subject:''' {{RageType|String}}

===Return value===
*{{RageType|Int}}

==Example==
{{ClientsideCode|
<pre>
const notifyWithPicture = () => {
mp.game.ui.setNotificationTextEntry('STRING');
mp.game.ui.setNotificationMessage('CHAR_RON', 'CHAR_RON', false, 2, 'New Message', 'Hello World!');
};

notifyWithPicture();
</pre>
}}
Output:
[[File:outputnative.png|200px]]

Values '''textureDict''' and '''textureName''' gives you ability to make custom notifcation pictures using: [[Using_DLC_Packs_with_Custom_Textures]]
{{ClientsideCode|
<pre>
// Before using your custom textures you must request them by this function
mp.game.graphics.requestStreamedTextureDict('notifications', true);

const notifyWithPicture = () => {
mp.game.ui.setNotificationTextEntry('STRING');
mp.game.ui.setNotificationMessage('notifications', 'ragelogo', false, 2, 'New Message', 'Hi, now your notifications look ~y~beast');
};

notifyWithPicture();
</pre>
}}
Output:
[[File:outputcustom.png|200px]]

or using in-game sprites:
{{ClientsideCode|
<pre>
// Just in case you should request textureDict
mp.game.graphics.requestStreamedTextureDict('commonmenu', true);

const notifyWithPicture = () => {
mp.game.ui.setNotificationTextEntry('STRING');
return mp.game.ui.setNotificationMessage('commonmenu', 'mp_specitem_cash', false, 9, 'New notification!', 'Your account has been charged');
};

notifyWithPicture();
</pre>
}}
Output:
[[File:outputcustom2.png|200px]]

==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]

File:Outputcustom2.png

2020-12-05T10:02:27Z

Update450: https://wiki.rage.mp/index.php?title=Ui::setNotificationMessage Image showing notification with picture using in-game sprites.

== Summary ==
https://wiki.rage.mp/index.php?title=Ui::setNotificationMessage

Image showing notification with picture using in-game sprites.

File:Outputcustom.png

2020-12-05T09:41:30Z

Update450: https://wiki.rage.mp/index.php?title=Ui::setNotificationMessage Image showing notification with custom image using dlcpacks.

== Summary ==
https://wiki.rage.mp/index.php?title=Ui::setNotificationMessage

Image showing notification with custom image using dlcpacks.

File:Outputnative.png

2020-12-05T09:10:35Z

Update450: https://wiki.rage.mp/index.php?title=Ui::setNotificationMessage Image showing notification with picture from gamefiles.

== Summary ==
https://wiki.rage.mp/index.php?title=Ui::setNotificationMessage

Image showing notification with picture from gamefiles.