Players::call: Difference between revisions
No edit summary |
m (Replaced HTML with template) |
||
| Line 5: | Line 5: | ||
==Syntax== | ==Syntax== | ||
< | <pre> | ||
mp.players.call(String eventName[, Array Arguments]); | mp.players.call(String eventName[, Array Arguments]); | ||
mp.players.call(Array players, String eventName[, Array Arguments]); | mp.players.call(Array players, String eventName[, Array Arguments]); | ||
</ | </pre> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''eventName:''' Event name, what will be called. | *'''eventName:''' Event name, what will be called. | ||
| Line 15: | Line 16: | ||
==Example== | ==Example== | ||
1. Trigger "disablePlayerRegeneration" event for everyone near new mp.Vector3(150, 100, 50). | 1. Trigger "disablePlayerRegeneration" event for everyone near new mp.Vector3(150, 100, 50). | ||
{{ServersideCode| | |||
<pre> | |||
< | |||
const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20)); | const playersArray = mp.players.toArray().filter((player) => (player.dist(new mp.Vector3(150, 100, 50)) < 20)); | ||
mp.players.call(playersArray, "disablePlayerRegeneration"); | mp.players.call(playersArray, "disablePlayerRegeneration"); | ||
</ | </pre> | ||
}} | |||
2. Trigger "disablePlayerRegeneration" event for everyone. | 2. Trigger "disablePlayerRegeneration" event for everyone. | ||
{{ServersideCode| | |||
<pre> | |||
< | |||
mp.players.call("disablePlayerRegeneration"); | mp.players.call("disablePlayerRegeneration"); | ||
</ | </pre> | ||
}} | |||
==See Also== | ==See Also== | ||
{{Player_block}} | {{Player_block}} | ||
Revision as of 12:26, 26 October 2018
This function triggers an event for:
- the whole server
- specified players array
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