RAGE Multiplayer Wiki - User contributions [en]

UncaughtException

2025-09-03T18:39:00Z

Koprawiki:

{{ClientsideJsFunction}}
{{JSContainer|
{{Parameters}}
* '''exception''': Unhandled exception, it is of '''any''' type.

{{Example}}
The example below cancels the default error message box on client unhandled exception/error and prints to the F11 console instead.

<syntaxhighlight lang="JavaScript">
mp.events.add("uncaughtException", (exception) => {
// Print the message to F11 console or do whatever you need with it
mp.console.logError(`[uncaughtException]: ${exception}`);

// Cancel the event to prevent default error message box
return true;
});
</syntaxhighlight>
}}
==See also==
{{Player_events_clientside}}

UnhandledRejection

2025-09-03T18:38:34Z

Koprawiki:

{{ClientsideJsFunction}}
{{JSContainer|
{{Parameters}}
* '''promise''': Promise that was rejected and not handled, it is of '''Promise<any>''' type.
* '''error''': Error of the promise that was rejected, it is of '''any''' type.

{{Example}}
The example below cancels the default error message box on client unhandled promise rejection and prints to the F11 console instead.

<syntaxhighlight lang="JavaScript">
mp.events.add('unhandledRejection', (promise, error) => {
// Print the message to F11 console or do whatever you need with it
mp.console.logError(`[unhandledRejection]: ${JSON.stringify(promise)} ${error}`);

// Cancel the event to prevent default error message box
return true;
});
</syntaxhighlight>
}}
==See also==
{{Player_events_clientside}}

UnhandledRejection

2025-09-03T18:30:12Z

Koprawiki: example of canceling default message box

{{ClientsideJsFunction}}
{{JSContainer|
{{Parameters}}
* '''promise''': Promise that was rejected and not handled, it is of '''Promise<any>''' type.
* '''error''': Error of the promise that was rejected, it is of '''any''' type.

{{Example}}
The example below cancels the default error message box on client unhandled promise rejection and prints to the F11 console instead.

<syntaxhighlight lang="JavaScript">
mp.events.add('unhandledRejection', (promise, error) => {
// Print the message to F11 console instead or forward to the server for logging
mp.console.logError(`[unhandledRejection]: ${JSON.stringify(promise)} ${error}`);

// Cancel the event to prevent default error message box
return true;
});
</syntaxhighlight>
}}
==See also==
{{Player_events_clientside}}

Clientside JS FAQ

2025-03-09T00:19:28Z

Koprawiki: edit at the request of cibucristi

__TOC__

{{FAQContainer|
How can I send data from CEF(browser) to server-side?|
Create a client-side event middleman to handle events easily between CEF - Server-side.

Client-side event middleman
{{Example}}
<pre>
mp.events.add("SEND_TO_SERVER", (event_name, ...args) => {
mp.events.callRemote(event_name, ...args);
});
</pre>

From CEF
<pre>
mp.trigger('SEND_TO_SERVER', name, ...args);
</pre>
}}

{{FAQContainer|
How to prevent player from toggling engine state on vehicle enter?|
{{Example}}
<pre>
mp.events.add("playerReady", () => {
mp.game.vehicle.defaultEngineBehaviour = false;
mp.players.local.setConfigFlag(429, true);
});
</pre>
}}

{{FAQContainer|
Are there any free gamemodes available to start from?|
Yes, check the [https://rage.mp/files/ resources] posted in our forums, there are a lot of free handful scripts and gamemodes to start from.
}}

Audio::requestAmbientBank

2025-01-04T06:19:53Z

Koprawiki:

This function will load requested ambient bank.
{{ClientsideJsFunction}}
{{JSContainer|

===Required Params===
*'''ambientBankName:''' {{RageType|string}}
*'''p1:''' {{RageType|boolean}}
*'''p2:''' {{RageType|number}} — Always -1

===Return value===
*''' {{RageType|boolean}} '''

==Syntax==
<syntaxhighlight lang="javascript">
mp.game.audio.requestAmbientBank(ambientBankName, p1, -1)
</syntaxhighlight>

==Example==
<syntaxhighlight lang="javascript">
// Asynchronously loads 'DLC_LUXE/LUXE_SMOKE_CIGAR' ambient audio bank.
await mp.game.waitForAsync(() => mp.game.audio.requestAmbientBank("DLC_LUXE/LUXE_SMOKE_CIGAR", false, -1));
</syntaxhighlight>
}}
==See also==
{{Audio_s_function_c}}
[[Category:Clientside API]]

Cam::getFollowPedViewMode

2024-11-09T03:32:05Z

Koprawiki:

0 - Third Person Close
1 - Third Person Mid
2 - Third Person Far
4 - First Person

{{ClientsideJsFunction}}
{{JSContainer|

===Return value===
*''' {{RageType|number}} '''

==Syntax==
<syntaxhighlight lang="javascript">
mp.game.cam.getFollowPedViewMode()
</syntaxhighlight>

==Example==
<syntaxhighlight lang="javascript">
//todo
</syntaxhighlight>
}}
==See also==
{{Cam_functions_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Server settings

2024-09-07T15:05:07Z

Koprawiki:

* '''conf.json -''' is a configuration file which allows you manage your server easily.

== Settings ==
The following table will explain the use of the following settings:

{| class="wikitable"
|-
! Setting !! Default value !! Description
|-
| announce || false || Announce to the master server so people can see you in their server browser.
|-
| bind|| 127.0.0.1 || The IP to listen to.
|-
| gamemode|| Freeroam || The server's gamemode. [[gamemodes|List of valid gamemodes]]
|-
| encryption'''(deprecated)'''|| true || Setting is deprecated because it is always enabled and can not be disabled.
|-
| maxplayers || 100 || Maximum number of players your server will hold.
|-
| name || RAGE:MP Unofficial server || Server name that will be displayed to the master server. Use [] for tags. Eg. "Beast [Serious Roleplay]"
|-
| stream-distance || 500.0 || The distance on the X,Y plane which server entities will stream in for connected players.
|-
| port || 22005 || The port that the server will use. The server uses both UDP and TCP protocols. The port after that one (''port + 1'', so 22006 by default) will be used for the HTTP server that hosts the client packages for the clients to download from.
|-
| disallow-multiple-connections-per-ip|| false|| Allows (false) or disallows (true) multiple players to connect from the same IP address
|-
| limit-time-of-connections-per-ip|| 0|| Maximum time a player can try to reconnect before getting timeout
|-
| url|| || Website URL. Must be a valid URL. Truncated to 20 characters in [https://rage.mp/masterlist RAGE:MP Master List Web] (shows fine in RAGE:MP client).
|-
| language|| us || Server's language (needs to be a string, example: "language": "us" will display the United States flag on your server's name)
|-
| sync-rate|| 40|| This number indicates the interval, in milliseconds, that the server has to synchronize its entities. 40 = 40ms
|-
| resource-scan-thread-limit|| || Indicates the maximum number of threads used for resource scanning
|-
| max-ping|| || Maximum Ping accepted for the server
|-
| min-fps|| || Minimum FPS required for the server
|-
| max-packet-loss|| || Maximum Packet loss accepted in the server
|-
| allow-cef-debugging || || Whether the client can (true) or not (false) debug the server's CEF pages
|-
| enable-nodejs || true || Enables NodeJS serverside
|-
| csharp || disabled|| If your server will be using the C# bridge plugin set it to true, else don't add this line
|-
| enable-http-security|| false|| When set to true, enables an extra security layer to avoid the server being flooded by fake HTTP requests
|
|-
| voice-chat || || boolean true / false
|
|-
| allow-voice-chat-input || || (only available via registry at the moment); default value: 1
|
|-
| voice-chat-sample-rate || || allowed values are 8000, 16000, 24000, 48000
|-
| fastdl-host || || String URL, this parameter specifies the external URL from which clients will be able to download needed clientside packages. Otherwise they will download them directly from the server.
|-
| server-side-weapons-only-mode || true || boolean true / false, if it's set to true, only weapons that are given from server side will be synced (available with RAGE 1.1+)
|-
| api-threading-debugging || false || If set to true, it'll report every single usage of the API out of proper thread. Use it only for debugging since it adds some CPU overhead. (available with RAGE 1.1+)
|-
| fqdn || || string, e.g. "fqdn": "game-srv.rage.mp". Thanks to this option your players won't notice any server IP change, including the re-utilisation of downloaded packages.
|-
| resources-compression-level || 1 || Use 0 for local server, or a higher value for bandwidth optimisation. -9 for fast compression (available with RAGE 1.1+)
|-
| node-commandline-flags || || e.g. "node-commandline-flags": "--inspect" (available with RAGE 1.1+)
|-
| synchronization-extrapolation-multiplier || 0.0 || enables vehicle synchronization prediction disabling possible latency offset (available with RAGE 1.1+, enabled by default with 1.0 value in 0.3.7)
|-
| http-threads || 50 || Specifies how many concurrent connections will be handled at the same time, the rest will be queued (Increasing this number will increase bandwidth usage)
|-
| trigger-compression-logging || false || Log compression rates of all outgoing client event triggers with the dictionary the server has been initialized with (available with RAGE 1.1+)
|-
| trigger-compression-training || false || Dictionary training, takes data from all of your triggers and flushes it to the file specified at "trigger-compression-dictionary" at every 20th trigger. TIP: You can train it without joining using "mp.players.call" (available with RAGE 1.1+)
|-
| trigger-compression-dictionary || || File to load/save compression dictionary (available with RAGE 1.1+)
|
|-
| create-fastdl-snapshot || false || Generates client packages files to a folder to be downloadable and used with FastDL
|-
| disable-client-packages-ram-cache || false || Doesn't cache resources in memory (for only un-encrypted files with DISABLE_ENCRYPTION_LIST file) and instead streams it from storage
|-
| client-packages-shared-folder || || Enables you to use the same client resources across different servers (i guess) (FQDN must be a subdomain of shared folder name, e.g. foo.domain.com, bar.domain.com => domain.com)
|}

== Sample file ==

This is an example of '''conf.json''':

<syntaxhighlight lang="javascript">
{
"announce": false,
"bind": "127.0.0.1",
"gamemode": "freeroam",
"name": "RAGE:MP Unofficial server [Tag]",
"maxplayers": 100,
"port": 22005,
"stream-distance": 500.0
}
</syntaxhighlight>
[[Category:Reference]]

Weapon::setEnableLocalOutgoingDamage

2024-08-18T01:35:03Z

Koprawiki:

{{ClientsideJsFunction}}
Enables the 'outgoingDamage' event for this client.
Needs to be called in the 'playerReady' event.

{{JSContainer|
===Required Params===
*'''toggle:''' {{RageType|boolean}}

===Return value===
*''' {{RageType|void}} '''

==Syntax==
<syntaxhighlight lang="javascript">
mp.game.weapon.setEnableLocalOutgoingDamage(toggle)
</syntaxhighlight>

==Example==
<syntaxhighlight lang="javascript">
mp.events.add("playerReady", () => mp.game.weapon.setEnableLocalOutgoingDamage(true));
</syntaxhighlight>
}}
==See also==
{{Weapon_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

DeletePlayerWorldProp

2024-05-07T11:11:28Z

Koprawiki: Created page with "Removes world prop for given player {{CSharpContainer| {{#tag:syntaxhighlight|void {{Template:CSharp_Serverside_namespace}}Player.DeletePlayerWorldProp(Player player, int modelHash, Vector3 position, float radius);|lang=csharp}} {{Parameters}} *'''player:''' parameter input should be in '''Player''' type *'''modelHash:''' parameter modelHash should be in '''uint''' or '''int''' type *'''position:''' parameter position should be in '''Vector3''' type *'''radius:''' pa..."

Removes world prop for given player

{{CSharpContainer|
{{#tag:syntaxhighlight|void {{Template:CSharp_Serverside_namespace}}Player.DeletePlayerWorldProp(Player player, int modelHash, Vector3 position, float radius);|lang=csharp}}

{{Parameters}}
*'''player:''' parameter input should be in '''Player''' type
*'''modelHash:''' parameter modelHash should be in '''uint''' or '''int''' type
*'''position:''' parameter position should be in '''Vector3''' type
*'''radius:''' parameter radius should be in '''float''' type

[[Category:Serverside API]]
}}

Player::taskPlayAnim

2024-04-12T12:28:13Z

Koprawiki:

__TOC__

Plays an animation on the targetted ped.

You must always preload the dictionary (use [https://wiki.rage.mp/index.php?title=Streaming::requestAnimDict Streaming::requestAnimDict] to preload an animation), serverside will have some loaded but not all.

==Arguments==

'''Animation Dictionary, Animation Name'''
* A few possible values can be found on the [[Animations|Animations]] page.

'''Blend speed''':
* Defines the blend time before/after the animation. Most common value is 8.

:<pre>1 / [time in seconds] = [blend speed]</pre>

'''Duration (ms)''':
* How long the animation plays. -1 can be used to play the whole animation (or loop indefinitely, if flag 1 is used)

'''Animation Flags''':
*0: '''AF_DEFAULT'''
*1: '''AF_LOOPING''' - Repeat the animation
*2: '''AF_HOLD_LAST_FRAME''' - Hold on the last frame of the animation
*4: '''AF_REPOSITION_WHEN_FINISHED''' - When the animation finishes pop the peds physical reprsentation position to match the visual representations position Note that the animator must not unwind the animation and must have an independent mover node
*8: '''AF_NOT_INTERRUPTABLE''' - Can the task not be interupted by extenal events
*16: '''AF_UPPERBODY''' - Only plays the upper body part of the animation. Dampens any motion caused by the lower body animation.Note that the animation should include the root node
*32: '''AF_SECONDARY''' - The task will run in the secondary task slot. This means it can be used aswell as a movement task (for instance)
*64: '''AF_REORIENT_WHEN_FINISHED''' - When the animation finishes pop the peds physical reprsentation direction to match the visual representations direction. Note that the animator must not unwind the animation and must have an independent mover node
*128: '''AF_ABORT_ON_PED_MOVEMENT''' - Ends the animation early if the ped attemps to move e.g. if the player tries to move using the controller. Can also be used to blend out automatically when an ai ped starts moving by combining it with the AF_SECONDARY flag.
*256: '''AF_ADDITIVE''' - Play back the animation additively. Note, this will only produce sensible results on specifically authored additive animations!
*512: '''AF_TURN_OFF_COLLISION''' - Do not react to collision detection whilst this anim is playing
*1024: '''AF_OVERRIDE_PHYSICS''' - Do not apply any physics forces whilst the anim is playing. Automatically turns off collision, extracts any initial offset provided in the clip and uses per frame mover extraction.
*2048: '''AF_IGNORE_GRAVITY''' - Do not apply gravity while the anim is playing
*4096: '''AF_EXTRACT_INITIAL_OFFSET''' - Extract an initial offset from the playback position authored by the animator. Use this flag when playing back anims on different peds which have been authored to sync with each other
*8192: '''AF_EXIT_AFTER_INTERRUPTED''' - Exit the animation task if it is interrupted by another task (ie Natural Motion). Without this flag bing set looped animations will restart ofter the NM task

'''Tag synchronizer flags - sync the anim against ped movement (walking / running / etc)''':
*16384: '''AF_TAG_SYNC_IN''' - Sync the anim whilst blending in (use for seamless transitions from walk / run into a full body anim)
*32768: '''AF_TAG_SYNC_OUT''' - Sync the anim whilst blending out (use for seamless transitions from a full body anim into walking / running behaviour)
*65536: '''AF_TAG_SYNC_CONTINUOUS''' - Sync all the time (Only usefull to synchronize a partial anim e.g. an upper body)

*131072: '''AF_FORCE_START''' - Force the anim task to start even if the ped is falling / ragdolling / etc. Can fix issues with peds not playing their anims immediately after a warp / etc
*262144: '''AF_USE_KINEMATIC_PHYSICS''' - Use the kinematic physics mode on the entity for the duration of the anim (it should push other entities out of the way, and not be pushed around by players / etc
*524288: '''AF_USE_MOVER_EXTRACTION''' - Updates the peds capsule position every frame based on the animation. Use in conjunction with AF_USE_KINEMATIC_PHYSICS to create characters that cannot be pushed off course by other entities / geometry / etc whilst playing the anim.

*1048576: '''AF_HIDE_WEAPON''' - Indicates that the ped's weapon should be hidden while this animation is playing.

*2097152: '''AF_ENDS_IN_DEAD_POSE''' - When the anim ends, kill the ped and use the currently playing anim as the dead pose
*4194304: '''AF_ACTIVATE_RAGDOLL_ON_COLLISION''' - If the peds ragdoll bounds make contact with something physical (that isn't flat ground) activate the ragdoll and fall over.
*8388608: '''AF_DONT_EXIT_ON_DEATH''' - Currently used only on secondary anim tasks. Secondary anim tasks will end automatically when the ped dies. Setting this flag stops that from happening."
*16777216: '''AF_ABORT_ON_WEAPON_DAMAGE''' - Allow aborting from damage events (including non-ragdoll damage events) even when blocking other ai events using AF_NOT_INTERRUPTABLE.
*33554432: '''AF_DISABLE_FORCED_PHYSICS_UPDATE''' - Prevent adjusting the capsule on the enter state (useful if script is doing a sequence of scripted anims and they are known to more or less stand still)
*67108864: '''AF_PROCESS_ATTACHMENTS_ON_START''' - Force the attachments to be processed at the start of the clip
*134217728: '''AF_EXPAND_PED_CAPSULE_FROM_SKELETON''' - Expands the capsule to the extents of the skeleton
*268435456: '''AF_USE_ALTERNATIVE_FP_ANIM''' - Plays an alternative first person version of the clip on the player when in first person mode (the first person clip must be in the same dictionary, and be named the same as the anim you're playing, but with _FP appended on the end)
*536870912: '''AF_BLENDOUT_WRT_LAST_FRAME''' - Start blending out the anim early, so that the blend out duration completes at the end of the animation.
*1073741824 '''AF_USE_FULL_BLENDING''' - Use full blending for this anim and override the heading/position adjustment in CTaskScriptedAnimation::CheckIfClonePlayerNeedsHeadingPositionAdjust(), so that we don't correct errors (special case such as scrip-side implemented AI tasks, i.e. diving)

:''Note:'' You can sum flags together. For example, if you want an upper body controllable animation with last frame you can do 48+2 which is flag 50.

'''Start Offset''':
*Can be used to skip a part of the animation. Values are between 0.0 and 1.0 (doesn't seem to work, use mp.game.entity.setAnimCurrentTime instead)

==Syntax==
<pre>player.taskPlayAnim(animDictionary, animationName, blendInSpeed, blendOutSpeed, duration, flag, startOffset, lockX, lockY, lockZ);</pre>
=== Required Arguments ===
*'''animDictionary:''' String
*'''animationName:''' String
*'''blendInSpeed:''' float
*'''blendOutSpeed:''' float
*'''duration:''' int
*'''flag:''' int
*'''startOffset:''' float
*'''lockX:''' Boolean
*'''lockY:''' Boolean
*'''lockZ:''' Boolean
===Return value===
*'''Undefined'''

==Example==
The example below preloads an animation and applies it into the local player.
<pre>
mp.game.streaming.requestAnimDict("random@shop_robbery");//preload the animation
mp.players.local.taskPlayAnim("random@shop_robbery", "robbery_action_f", 8.0, 1.0, -1, 1, 1.0, false, false, false);
</pre>

==See also==
*'''[[Animations|Animations Dictionary]]'''
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::taskPlayAnim

2024-04-12T12:27:52Z

Koprawiki:

__TOC__

Plays an animation on the targetted ped.

You must always preload the dictionary (use [https://wiki.rage.mp/index.php?title=Streaming::requestAnimDict Streaming::requestAnimDict] to preload an animation), serverside will have some loaded but not all.

==Arguments==

'''Animation Dictionary, Animation Name'''
* A few possible values can be found on the [[Animations|Animations]] page.

'''Blend speed''':
* Defines the blend time before/after the animation. Most common value is 8.

:<pre>1 / [time in seconds] = [blend speed]</pre>

'''Duration (ms)''':
* How long the animation plays. -1 can be used to play the whole animation (or loop indefinitely, if flag 1 is used)

'''Animation Flags''':
*0: '''AF_DEFAULT'''
*1: '''AF_LOOPING''' - Repeat the animation
*2: '''AF_HOLD_LAST_FRAME''' - Hold on the last frame of the animation
*4: '''AF_REPOSITION_WHEN_FINISHED''' - When the animation finishes pop the peds physical reprsentation position to match the visual representations position Note that the animator must not unwind the animation and must have an independent mover node
*8: '''AF_NOT_INTERRUPTABLE''' - Can the task not be interupted by extenal events
*16: '''AF_UPPERBODY''' - Only plays the upper body part of the animation. Dampens any motion caused by the lower body animation.Note that the animation should include the root node
*32: '''AF_SECONDARY''' - The task will run in the secondary task slot. This means it can be used aswell as a movement task (for instance)
*64: '''AF_REORIENT_WHEN_FINISHED''' - When the animation finishes pop the peds physical reprsentation direction to match the visual representations direction. Note that the animator must not unwind the animation and must have an independent mover node
*128: '''AF_ABORT_ON_PED_MOVEMENT''' - Ends the animation early if the ped attemps to move e.g. if the player tries to move using the controller. Can also be used to blend out automatically when an ai ped starts moving by combining it with the AF_SECONDARY flag.
*256: '''AF_ADDITIVE''' - Play back the animation additively. Note, this will only produce sensible results on specifically authored additive animations!
*512: '''AF_TURN_OFF_COLLISION''' - Do not react to collision detection whilst this anim is playing
*1024: '''AF_OVERRIDE_PHYSICS''' - Do not apply any physics forces whilst the anim is playing. Automatically turns off collision, extracts any initial offset provided in the clip and uses per frame mover extraction.
*2048: '''AF_IGNORE_GRAVITY''' - Do not apply gravity while the anim is playing
*4096: '''AF_EXTRACT_INITIAL_OFFSET''' - Extract an initial offset from the playback position authored by the animator. Use this flag when playing back anims on different peds which have been authored to sync with each other
*8192: '''AF_EXIT_AFTER_INTERRUPTED''' - Exit the animation task if it is interrupted by another task (ie Natural Motion). Without this flag bing set looped animations will restart ofter the NM task

'''Tag synchronizer flags - sync the anim against ped movement (walking / running / etc)''':
*16384: '''AF_TAG_SYNC_IN''' - Sync the anim whilst blending in (use for seamless transitions from walk / run into a full body anim)
*32768: '''AF_TAG_SYNC_OUT''' - Sync the anim whilst blending out (use for seamless transitions from a full body anim into walking / running behaviour)
*65536: '''AF_TAG_SYNC_CONTINUOUS''' - Sync all the time (Only usefull to synchronize a partial anim e.g. an upper body)

*131072: '''AF_FORCE_START''' - Force the anim task to start even if the ped is falling / ragdolling / etc. Can fix issues with peds not playing their anims immediately after a warp / etc
*262144: '''AF_USE_KINEMATIC_PHYSICS''' - Use the kinematic physics mode on the entity for the duration of the anim (it should push other entities out of the way, and not be pushed around by players / etc
*524288: '''AF_USE_MOVER_EXTRACTION''' - Updates the peds capsule position every frame based on the animation. Use in conjunction with AF_USE_KINEMATIC_PHYSICS to create characters that cannot be pushed off course by other entities / geometry / etc whilst playing the anim.

*1048576: '''AF_HIDE_WEAPON''' - Indicates that the ped's weapon should be hidden while this animation is playing.

*2097152: '''AF_ENDS_IN_DEAD_POSE''' - When the anim ends, kill the ped and use the currently playing anim as the dead pose
*4194304: '''AF_ACTIVATE_RAGDOLL_ON_COLLISION''' - If the peds ragdoll bounds make contact with something physical (that isn't flat ground) activate the ragdoll and fall over.
*8388608: '''AF_DONT_EXIT_ON_DEATH''' - Currently used only on secondary anim tasks. Secondary anim tasks will end automatically when the ped dies. Setting this flag stops that from happening."
*16777216: '''AF_ABORT_ON_WEAPON_DAMAGE''' - Allow aborting from damage events (including non-ragdoll damage events) even when blocking other ai events using AF_NOT_INTERRUPTABLE.
*33554432: '''AF_DISABLE_FORCED_PHYSICS_UPDATE''' - Prevent adjusting the capsule on the enter state (useful if script is doing a sequence of scripted anims and they are known to more or less stand still)
*67108864: '''AF_PROCESS_ATTACHMENTS_ON_START''' - Force the attachments to be processed at the start of the clip
*134217728: '''AF_EXPAND_PED_CAPSULE_FROM_SKELETON''' - Expands the capsule to the extents of the skeleton
*268435456: '''AF_USE_ALTERNATIVE_FP_ANIM''' - Plays an alternative first person version of the clip on the player when in first person mode (the first person clip must be in the same dictionary, and be named the same as the anim you're playing, but with _FP appended on the end)
*536870912: '''AF_BLENDOUT_WRT_LAST_FRAME''' - Start blending out the anim early, so that the blend out duration completes at the end of the animation.
*1073741824 '''AF_USE_FULL_BLENDING''' - Use full blending for this anim and override the heading/position adjustment in CTaskScriptedAnimation::CheckIfClonePlayerNeedsHeadingPositionAdjust(), so that we don't correct errors (special case such as scrip-side implemented AI tasks, i.e. diving)

:''Note:'' You can sum flags together. For example, if you want an upper body controllable animation with last frame you can do 48+2 which is flag 50.

'''Start Offset''':
*Can be used to skip a part of the animation. Values are between 0.0 and 1.0
(doesn't seem to work, use mp.game.entity.setAnimCurrentTime instead)

==Syntax==
<pre>player.taskPlayAnim(animDictionary, animationName, blendInSpeed, blendOutSpeed, duration, flag, startOffset, lockX, lockY, lockZ);</pre>
=== Required Arguments ===
*'''animDictionary:''' String
*'''animationName:''' String
*'''blendInSpeed:''' float
*'''blendOutSpeed:''' float
*'''duration:''' int
*'''flag:''' int
*'''startOffset:''' float
*'''lockX:''' Boolean
*'''lockY:''' Boolean
*'''lockZ:''' Boolean
===Return value===
*'''Undefined'''

==Example==
The example below preloads an animation and applies it into the local player.
<pre>
mp.game.streaming.requestAnimDict("random@shop_robbery");//preload the animation
mp.players.local.taskPlayAnim("random@shop_robbery", "robbery_action_f", 8.0, 1.0, -1, 1, 1.0, false, false, false);
</pre>

==See also==
*'''[[Animations|Animations Dictionary]]'''
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::taskLookAt

2024-02-07T13:22:57Z

Koprawiki: Page update

Method to task player to look at another entity. Client-side tasks are synced.

==Syntax==
<syntaxhighlight lang="javascript">player.taskLookAt(lookAt, duration, flags, priority);</syntaxhighlight>
=== Required Arguments ===
*'''lookAt:''' Entity handle or object
*'''duration:''' int
*'''flags:''' int
*'''priority:''' int

===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
/**
* Function to make local player look at another player
* @param {number} targetRemoteId - Remote(server) id of the player to look at
*/
function localPlayerLookAtPlayer(targetRemoteId) {
// Get target player from the pool by his remote id
const target = mp.players.atRemoteId(targetRemoteId);

// If target player is not found, stop
if (!target || target.handle === 0) return;

// Call the method to look at another entity, in this case player
mp.players.local.taskLookAt(target.handle, -1, 2048, 2);
}
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]

Player::taskLookAt

2024-02-07T12:54:15Z

Koprawiki: /* Syntax */

param3: duration in ms, use -1 to look forever param4: using 2048 is fine param5: using 3 is fine
==Syntax==
<syntaxhighlight lang="javascript">player.taskLookAt(lookAt, duration, flags, priority);</syntaxhighlight>
=== Required Arguments ===
*'''lookAt:''' Entity handle or object
*'''duration:''' int
*'''flags:''' int
*'''priority:''' int

===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::taskLookAt

2024-02-07T12:53:37Z

Koprawiki: /* Required Arguments */

param3: duration in ms, use -1 to look forever param4: using 2048 is fine param5: using 3 is fine
==Syntax==
<syntaxhighlight lang="javascript">player.taskLookAt(lookAt, duration, unknown1, unknown2);</syntaxhighlight>
=== Required Arguments ===
*'''lookAt:''' Entity handle or object
*'''duration:''' int
*'''flags:''' int
*'''priority:''' int

===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]