Server events

A list of server side events you can use in your scripts.

Core events

These events are part of FiveM and do not require any resource.

<section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function"><a href="#entitycreated" class="tsd-kind-icon">entity<wbr>Created</a></li> <li class="tsd-kind-function"><a href="#entitycreating" class="tsd-kind-icon">entity<wbr>Creating</a></li> <li class="tsd-kind-function"><a href="#entityremoved" class="tsd-kind-icon">entity<wbr>Removed</a></li> <li class="tsd-kind-function"><a href="#onresourcelistrefresh" class="tsd-kind-icon">on<wbr>Resource<wbr>List<wbr>Refresh</a></li> <li class="tsd-kind-function"><a href="#onresourcestart" class="tsd-kind-icon">on<wbr>Resource<wbr>Start</a></li> <li class="tsd-kind-function"><a href="#onresourcestarting" class="tsd-kind-icon">on<wbr>Resource<wbr>Starting</a></li> <li class="tsd-kind-function"><a href="#onresourcestop" class="tsd-kind-icon">on<wbr>Resource<wbr>Stop</a></li> <li class="tsd-kind-function"><a href="#onserverresourcestart" class="tsd-kind-icon">on<wbr>Server<wbr>Resource<wbr>Start</a></li> <li class="tsd-kind-function"><a href="#onserverresourcestop" class="tsd-kind-icon">on<wbr>Server<wbr>Resource<wbr>Stop</a></li> <li class="tsd-kind-function"><a href="#playerconnecting" class="tsd-kind-icon">player<wbr>Connecting</a></li> <li class="tsd-kind-function"><a href="#playerenteredscope" class="tsd-kind-icon">player<wbr>Entered<wbr>Scope</a></li> <li class="tsd-kind-function"><a href="#playerjoining" class="tsd-kind-icon">player<wbr>Joining</a></li> <li class="tsd-kind-function"><a href="#playerleftscope" class="tsd-kind-icon">player<wbr>Left<wbr>Scope</a></li> <li class="tsd-kind-function"><a href="#ptfxevent" class="tsd-kind-icon">pt<wbr>FxEvent</a></li> <li class="tsd-kind-function"><a href="#removeallweaponsevent" class="tsd-kind-icon">remove<wbr>All<wbr>Weapons<wbr>Event</a></li> <li class="tsd-kind-function"><a href="#startprojectileevent" class="tsd-kind-icon">start<wbr>Projectile<wbr>Event</a></li> <li class="tsd-kind-function"><a href="#weapondamageevent" class="tsd-kind-icon">weapon<wbr>Damage<wbr>Event</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="entitycreated" class="tsd-anchor"></a> <h3>entity<wbr>Created</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">entity<wbr>Created<span class="tsd-signature-symbol">(</span>handle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A server-side event that is triggered when an entity has been created.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>handle: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="entitycreating" class="tsd-anchor"></a> <h3>entity<wbr>Creating</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">entity<wbr>Creating<span class="tsd-signature-symbol">(</span>handle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A server-side event that is triggered when an entity is being created.</p> </div> <p>This event <strong>can</strong> be canceled to instantly delete the entity.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>handle: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="entityremoved" class="tsd-anchor"></a> <h3>entity<wbr>Removed</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">entity<wbr>Removed<span class="tsd-signature-symbol">(</span>entity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Triggered when an entity is removed on the server.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>entity: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The handle of the entity that got removed.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="onresourcelistrefresh" class="tsd-anchor"></a> <h3>on<wbr>Resource<wbr>List<wbr>Refresh</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">on<wbr>Resource<wbr>List<wbr>Refresh<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A server-side event triggered when the <code>refresh</code> command completes.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="onresourcestart" class="tsd-anchor"></a> <h3>on<wbr>Resource<wbr>Start</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">on<wbr>Resource<wbr>Start<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An event that is triggered <em>immediately</em> when a resource has started.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The name of the resource that just started.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="onresourcestarting" class="tsd-anchor"></a> <h3>on<wbr>Resource<wbr>Starting</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">on<wbr>Resource<wbr>Starting<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An event that is triggered when a resource is trying to start.</p> </div> <p>This can be canceled to prevent the resource from starting.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The name of the resource that is trying to start.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="onresourcestop" class="tsd-anchor"></a> <h3>on<wbr>Resource<wbr>Stop</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">on<wbr>Resource<wbr>Stop<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An event that is triggered <em>immediately</em> when a resource is stopping.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The name of the resource that is stopping.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="onserverresourcestart" class="tsd-anchor"></a> <h3>on<wbr>Server<wbr>Resource<wbr>Start</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">on<wbr>Server<wbr>Resource<wbr>Start<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An event that is <em>queued</em> after a resource has started.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The name of the resource that has started.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="onserverresourcestop" class="tsd-anchor"></a> <h3>on<wbr>Server<wbr>Resource<wbr>Stop</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">on<wbr>Server<wbr>Resource<wbr>Stop<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An event that is triggered after a resource has stopped.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The name of the resource that has stopped.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="playerconnecting" class="tsd-anchor"></a> <h3>player<wbr>Connecting</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">player<wbr>Connecting<span class="tsd-signature-symbol">(</span>playerName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, setKickReason<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, deferrals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>defer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>done<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>handover<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>presentCard<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span>, source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A server-side event that is triggered when a player is trying to connect.</p> </div> <p>This event can be canceled to reject the player <em>instantly</em>, assuming you haven&#39;t yielded.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>playerName: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The display name of the player connecting.</p> </div> </li> <li> <h5>setKickReason: <span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <div class="tsd-comment tsd-typography"> <p>A function used to set a reason message for when the event is canceled.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>reason<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>reason: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>deferrals: <span class="tsd-signature-symbol">{ </span>defer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>done<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>handover<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>presentCard<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <p>An object to control deferrals.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>defer<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">defer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><code>deferrals.defer</code> will initialize deferrals for the current resource. It is required to wait for at least a tick after calling defer before calling <code>update</code>, <code>presentCard</code> or <code>done</code>.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>done<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">done<span class="tsd-signature-symbol">(</span>failureReason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><code>deferrals.done</code> finalizes a deferral. It is required to wait for at least a tick before calling <code>done</code> after calling a prior deferral method.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> failureReason: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>If specified, the connection will be refused, and the user will see the specified message as a result. If this is not specified, the user will be allowed to connect.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>handover<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">handover<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><code>deferrals.handover</code> adds handover data for the client to be able to use at a later point.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <span class="tsd-signature-symbol">{}</span></h5> <div class="tsd-comment tsd-typography"> <p>Data to pass to the connecting client.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>present<wbr>Card<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">present<wbr>Card<span class="tsd-signature-symbol">(</span>card<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span>, cb<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><code>deferrals.presentCard</code> will send an <a href="https://adaptivecards.io/">Adaptive Card</a> to the client.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>card: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span></h5> <div class="tsd-comment tsd-typography"> <p>An object containing card data, or a serialized JSON string with the card information.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5> <div class="tsd-comment tsd-typography"> <p>If present, will be invoked on an <code>Action.Submit</code> event from the Adaptive Card.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A callback to be invoked for <code>Action.Submit</code>.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>A parsed version of the data sent from the card.</p> </div> </li> <li> <h5>rawData: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A JSON string containing the data sent from the card.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>update<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> <li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><code>deferrals.update</code> will send a progress message to the connecting client.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>message: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The string to send to the client.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>source: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The player&#39;s <em>temporary</em> NetID (a number in Lua/JS), <strong>not a real argument, use [FromSource] or source</strong>.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="playerenteredscope" class="tsd-anchor"></a> <h3>player<wbr>Entered<wbr>Scope</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">player<wbr>Entered<wbr>Scope<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>for<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>player<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A server-side event that is triggered when a player enters another player&#39;s scope.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <span class="tsd-signature-symbol">{ </span>for<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>player<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <p>Data containing the players entering each other&#39;s scope.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>for<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The player for which the scope is being entered.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>player<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The player that is entering the scope.</p> </div> </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="playerjoining" class="tsd-anchor"></a> <h3>player<wbr>Joining</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">player<wbr>Joining<span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, oldID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A server-side event that is triggered when a player has a finally-assigned NetID.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>source: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The player&#39;s NetID (a number in Lua/JS), <strong>not a real argument, use [FromSource] or source</strong>.</p> </div> </li> <li> <h5>oldID: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The original TempID for the connecting player, as specified during playerConnecting.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="playerleftscope" class="tsd-anchor"></a> <h3>player<wbr>Left<wbr>Scope</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">player<wbr>Left<wbr>Scope<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>for<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>player<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A server-side event that is triggered when a player leaves another player&#39;s scope.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <span class="tsd-signature-symbol">{ </span>for<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>player<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <p>Data containing the players leaving each other&#39;s scope.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>for<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The player for which the scope is being left.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>player<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The player that is leaving the scope.</p> </div> </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="ptfxevent" class="tsd-anchor"></a> <h3>pt<wbr>FxEvent</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">pt<wbr>FxEvent<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>assetHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>axisBitset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>effectHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>entityNetId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f100<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f105<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f106<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f107<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f109<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f110<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f111<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f92<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>isOnEntity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>offsetX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offsetY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offsetZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>posX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>posY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>posZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>scale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Triggered when a particle fx (ptFx) is created.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sender: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The ID of the player that triggered the event.</p> </div> </li> <li> <h5>data: <span class="tsd-signature-symbol">{ </span>assetHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>axisBitset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>effectHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>entityNetId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f100<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f105<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f106<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f107<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f109<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f110<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f111<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f92<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>isOnEntity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>offsetX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offsetY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>offsetZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>posX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>posY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>posZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rotZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>scale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <p>The event data.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>asset<wbr>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>axis<wbr>Bitset<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>effect<wbr>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>entity<wbr>Net<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f100<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f105<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f106<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f107<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f109<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>f110<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>f111<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>f92<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>is<wbr>OnEntity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>offsetX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>offsetY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>offsetZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>posX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>posY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>posZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>rotX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>rotY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>rotZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>scale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="removeallweaponsevent" class="tsd-anchor"></a> <h3>remove<wbr>All<wbr>Weapons<wbr>Event</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">remove<wbr>All<wbr>Weapons<wbr>Event<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>pedId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Triggered when a player removes all weapons from a ped owned by another player.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sender: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The ID of the player that triggered the event.</p> </div> </li> <li> <h5>data: <span class="tsd-signature-symbol">{ </span>pedId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <p>The event data.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>ped<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="startprojectileevent" class="tsd-anchor"></a> <h3>start<wbr>Projectile<wbr>Event</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">start<wbr>Projectile<wbr>Event<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>commandFireSingleBullet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>effectGroup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>firePositionX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>firePositionY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>firePositionZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialPositionX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialPositionY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialPositionZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ownerId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>projectileHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>targetEntity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>throwTaskSequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk10<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk11<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk12<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk13<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk14<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk15<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk16<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk4<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk5<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk6<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk7<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk9<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unkX8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unkY8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unkZ8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>weaponHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Triggered when a projectile is created.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sender: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The ID of the player that triggered the event.</p> </div> </li> <li> <h5>data: <span class="tsd-signature-symbol">{ </span>commandFireSingleBullet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>effectGroup<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>firePositionX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>firePositionY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>firePositionZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialPositionX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialPositionY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialPositionZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ownerId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>projectileHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>targetEntity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>throwTaskSequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk10<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk11<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk12<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk13<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk14<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk15<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk16<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk4<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk5<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk6<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk7<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unk9<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unkX8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unkY8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unkZ8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>weaponHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <p>The event data.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>command<wbr>Fire<wbr>Single<wbr>Bullet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>effect<wbr>Group<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>fire<wbr>PositionX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>fire<wbr>PositionY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>fire<wbr>PositionZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>initial<wbr>PositionX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>initial<wbr>PositionY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>initial<wbr>PositionZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>owner<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>projectile<wbr>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>target<wbr>Entity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>throw<wbr>Task<wbr>Sequence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk10<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk11<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk12<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk13<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk14<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk15<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk16<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk4<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk5<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk6<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk7<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk9<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk<wbr>X8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk<wbr>Y8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>unk<wbr>Z8<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>weapon<wbr>Hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="weapondamageevent" class="tsd-anchor"></a> <h3>weapon<wbr>Damage<wbr>Event</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">weapon<wbr>Damage<wbr>Event<span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>actionResultId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>actionResultName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>damageFlags<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>damageTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>damageType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f104<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f112<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f112_1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f120<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f133<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hasActionResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hasImpactDir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hasVehicleData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hitComponent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hitEntityWeapon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hitGlobalId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hitGlobalIds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>hitWeaponAmmoAttachment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>impactDirX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>impactDirY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>impactDirZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>isNetTargetPos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>localPosX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>localPosY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>localPosZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>overrideDefaultDamage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>parentGlobalId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>silenced<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>suspensionIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tyreIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>weaponDamage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>weaponType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>willKill<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Triggered when a client wants to apply damage to a remotely-owned entity. This event can be canceled.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>sender: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The server-side player ID of the player that triggered the event.</p> </div> </li> <li> <h5>data: <span class="tsd-signature-symbol">{ </span>actionResultId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>actionResultName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>damageFlags<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>damageTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>damageType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f104<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f112<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>f112_1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f120<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>f133<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hasActionResult<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hasImpactDir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hasVehicleData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hitComponent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hitEntityWeapon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>hitGlobalId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>hitGlobalIds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>hitWeaponAmmoAttachment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>impactDirX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>impactDirY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>impactDirZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>isNetTargetPos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>localPosX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>localPosY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>localPosZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>overrideDefaultDamage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>parentGlobalId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>silenced<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>suspensionIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tyreIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>weaponDamage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>weaponType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>willKill<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <p>The event data.</p> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>action<wbr>Result<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>action<wbr>Result<wbr>Name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>damage<wbr>Flags<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>damage<wbr>Time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The timestamp the damage was originally inflicted at. This should match the global network timer.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>damage<wbr>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A value (between 0 and 3) containing an internal damage type. Specific values are currently unknown.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>f104<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f112<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>f112_<wbr>1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f120<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>f133<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>has<wbr>Action<wbr>Result<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>has<wbr>Impact<wbr>Dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>has<wbr>Vehicle<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>hit<wbr>Component<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>hit<wbr>Entity<wbr>Weapon<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the damage should be inflicted as if it hit the weapon the entity is carrying. This likely applies to grenades being hit, which should explode, but also normal weapons, which should not harm the player much.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>hit<wbr>Global<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The network ID of the victim entity.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>hit<wbr>Global<wbr>Ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>An array containing network IDs of victim entities. If there is more than one, the first one will be set in <code>hitGlobalId</code>.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>hit<wbr>Weapon<wbr>Ammo<wbr>Attachment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the damage should be inflicted as if it hit an ammo attachment component on the weapon. This applies to players/peds carrying weapons where another player shooting the ammo component makes the weapon explode.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>impact<wbr>DirX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>impact<wbr>DirY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>impact<wbr>DirZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>is<wbr>Net<wbr>Target<wbr>Pos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>local<wbr>PosX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>local<wbr>PosY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>local<wbr>PosZ<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>override<wbr>Default<wbr>Damage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>If set, &#39;weaponDamage&#39; is valid. If unset, the game infers the damage from weapon metadata.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>parent<wbr>Global<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>silenced<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set when the damage is applied using a silenced weapon.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>suspension<wbr>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>tyre<wbr>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5>weapon<wbr>Damage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The amount of damage inflicted, if <code>overrideDefaultDamage</code> is set. If not, this value is set to <code>0</code>.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>weapon<wbr>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The weapon hash for the inflicted damage.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>will<wbr>Kill<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the originating client thinks this should be instantly-lethal damage, such as a critical headshot.</p> </div> </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> </section>