Players::call: Difference between revisions
CocaColaBear (talk | contribs) (Created page with "{{Incomplete Functions}}") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Incomplete Functions}} | {{Incomplete Functions}} | ||
This function calls an event for a) the whole server; b) specified players array | |||
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"> | |||
mp.players.call(String eventName, Array Arguments); | |||
mp.players.call(Array players, String eventName, Array Arguments); | |||
</syntaxhighlight> | |||
===Required Arguments=== | |||
*'''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== | |||
1. Trigger "disablePlayerRegeneration" event for everyone near new mp.Vector3(150, 100, 50). | |||
<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"> | |||
const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20)); | |||
mp.players.call(playersArray, "disablePlayerRegeneration"); | |||
</syntaxhighlight> | |||
</div> | |||
2. Trigger "disablePlayerRegeneration" event for everyone. | |||
<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.call("disablePlayerRegeneration"); | |||
</syntaxhighlight> | |||
</div> | |||
==See Also== | |||
{{Player_block}} | |||
Revision as of 14:46, 18 August 2018
This page is Incomplete. This function calls an event for a) the whole server; b) specified players array NB: I just tested in local, without error, but it need to be tested with, at least, two players (in different dimensions).
Syntax
mp.players.call(String eventName, Array Arguments);
mp.players.call(Array players, String eventName, Array Arguments);
Required Arguments
- 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
1. Trigger "disablePlayerRegeneration" event for everyone near new mp.Vector3(150, 100, 50).
Server-Side
const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20));
mp.players.call(playersArray, "disablePlayerRegeneration");
2. Trigger "disablePlayerRegeneration" event for everyone.
Server-Side
mp.players.call("disablePlayerRegeneration");
See Also
- Functions
- Player::ban
- Player::call
- Player::callProc
- Player::callToStreamed
- Player::callUnreliable
- Player::cancelPendingRpc
- Player::clearDecorations
- Player::getClothes
- Player::getDecoration
- Player::getFaceFeature
- Player::getHeadBlend
- Player::getHeadOverlay
- Player::getProp
- Player::getWeaponAmmo
- Player::giveWeapon
- Player::hasPendingRpc
- Player::invoke
- Player::isStreamed
- Player::isStreamedFor
- Player::kick
- Player::kickSilent
- Player::notify
- Player::outputChatBox
- Player::playAnimation
- Player::playScenario
- Player::putIntoVehicle
- Player::removeFromVehicle
- Player::removeObject
- Player::removeWeapon
- Player::removeAllWeapons
- Player::resetWeapon
- Player::setClothes
- Player::setCustomization
- Player::setDecoration
- Player::setFaceFeature
- Player::setHairColor
- Player::setHeadBlend
- Player::setHeadOverlay
- Player::setProp
- Player::setWeaponAmmo
- Player::spawn
- Player::stopAnimation
- Player::updateHeadBlend
- Player::enableVoiceTo
- Player::disableVoiceTo
- Weapons::clear
- Entity::destroy
- Entity::dist
- Entity::distSquared
- Entity::getVariable
- Entity::setVariable
- Entity::setVariables
- Properties
- Player::action
- Player::aimTarget
- Player::allWeapons
- Player::armour
- Player::eyeColor
- Player::faceFeatures
- Player::hairColor
- Player::hairHighlightColor
- Player::heading
- Player::health
- Player::rgscId
- Player::ip
- Player::serial
- Player::isAiming
- Player::isClimbing
- Player::isEnteringVehicle
- Player::isInCover
- Player::isInMelee
- Player::isJumping
- Player::isLeavingVehicle
- Player::isOnLadder
- Player::isReloading
- Player::name
- Player::packetLoss
- Player::ping
- Player::seat
- Player::socialClub
- Player::streamedPlayers
- Player::vehicle
- Player::voiceListeners
- Player::disableOutgoingSync
- Player::weapon
- Player::weaponAmmo
- Player::weapons
- Entity::alpha
- Entity::data
- Entity::dimension
- Entity::id
- Entity::model
- Entity::position
- Entity::type