Player::taskStartScenarioInPlace: Difference between revisions

From RAGE Multiplayer Wiki
mNo edit summary
Line 1: Line 1:
Plays a scenario on a Ped at their current location.<br><br>unkDelay - Usually 0 or -1, doesn't seem to have any effect. Might be a delay between sequences.<br>playEnterAnim - Plays the 'Enter' anim if true, otherwise plays the 'Exit' anim. Scenarios that don't have any 'Enter' anims won't play if this is set to true.<br><br>[[Scenarios|Scenario List]]
Plays a scenario on a Ped at their current location.<br><br>unkDelay - Usually 0 or -1, doesn't seem to have any effect. Might be a delay between sequences.<br>playEnterAnim - Plays the 'Enter' anim if true, otherwise plays the 'Exit' anim. Scenarios that don't have any 'Enter' anims won't play if this is set to true.<br><br>[[Scenarios|Scenario List]]
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">player.taskStartScenarioInPlace(scenarioName, unkDelay, playEnterAnim);</syntaxhighlight>
<pre>player.taskStartScenarioInPlace(scenarioName, unkDelay, playEnterAnim);</pre>
=== Required Arguments ===
=== Required Arguments ===
*'''scenarioName:''' String
*'''scenarioName:''' String
Line 8: Line 8:
===Return value===
===Return value===
*'''Undefined'''
*'''Undefined'''
==Example==
==Example==
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">

Revision as of 17:44, 16 August 2018

Plays a scenario on a Ped at their current location.

unkDelay - Usually 0 or -1, doesn't seem to have any effect. Might be a delay between sequences.
playEnterAnim - Plays the 'Enter' anim if true, otherwise plays the 'Exit' anim. Scenarios that don't have any 'Enter' anims won't play if this is set to true.

Scenario List

Syntax

player.taskStartScenarioInPlace(scenarioName, unkDelay, playEnterAnim);

Required Arguments

  • scenarioName: String
  • unkDelay: int
  • playEnterAnim: Boolean

Return value

  • Undefined

Example

// todo

See also