Ped::createNmMessage: Difference between revisions

Latest revision as of 21:29, 6 May 2017

MulleDK19: Creates a new NaturalMotion message.

startImmediately: If set to true, the character will perform the message the moment it receives it by GIVE_PED_NM_MESSAGE. If false, the Ped will get the message but won't perform it yet. While it's a boolean value, if negative, the message will not be initialized.
messageId: The ID of the NaturalMotion message.

If a message already exists, this function does nothing. A message exists until the point it has been successfully dispatched by GIVE_PED_NM_MESSAGE.

Syntax

mp.game.ped.createNmMessage(startImmediately, messageId);

Required Arguments

startImmediately: Boolean
messageId: int

Return value

Undefined

Example

// todo

@@ Line 1: / Line 1: @@
 MulleDK19: Creates a new NaturalMotion message.<br><br>startImmediately: If set to true, the character will perform the message the moment it receives it by GIVE_PED_NM_MESSAGE. If false, the Ped will get the message but won't perform it yet. While it's a boolean value, if negative, the message will not be initialized.<br>messageId: The ID of the NaturalMotion message.<br><br>If a message already exists, this function does nothing. A message exists until the point it has been successfully dispatched by GIVE_PED_NM_MESSAGE.
 ==Syntax==
-<syntaxhighlight lang="javascript">ped.createNmMessage(startImmediately, messageId);</syntaxhighlight>
+<syntaxhighlight lang="javascript">mp.game.ped.createNmMessage(startImmediately, messageId);</syntaxhighlight>
 === Required Arguments ===
 *'''startImmediately:''' Boolean
@@ Line 9: / Line 9: @@
 ==Example==
 <syntaxhighlight lang="javascript">
-todo
+// todo
 </syntaxhighlight>
 ==See also==
-{{Ped_function_c}}
+{{Ped_s_function_c}}
 [[Category:Clientside API]]
 [[Category:TODO: Example]]