LibAction: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
==Features==
*Single command <source lang="lua" inline> ShootPlayer( pid )</source> and npc starts shooting at the player.
*Aim Pos and Aim Dir for shooting are internally calculated and user has the option to correct it for more accuracy.
*Rich callbacks: just before shooting (for correction of aimpos/dir), target out of range or ran out of ammo/gun.
==Callbacks==
==Callbacks==
1. '''OnTargetCleared'''<source lang="lua">
1. '''OnTargetCleared'''<source lang="lua">

Revision as of 04:39, 20 February 2023

Features

  • Single command ShootPlayer( pid ) and npc starts shooting at the player.
  • Aim Pos and Aim Dir for shooting are internally calculated and user has the option to correct it for more accuracy.
  • Rich callbacks: just before shooting (for correction of aimpos/dir), target out of range or ran out of ammo/gun.

Callbacks

1. OnTargetCleared

OnTargetCleared([integer]targetpid, [integer]reason)

The value of reason can be:

Constant
AMMO_SHORTAGE
PLAYER_STREAMEDOUT
INSTRUCTION_RECEIVED

2. OnTargetOutOfRange

OnTargetOutOfRange([integer]targetid)

Called when target is out of range of the weaponrange of the current weapon of npc. If target is not cleared, npc resumes shooting when target comes in range again.

3. OnPullingTrigger

OnPullingTrigger([integer] keys, [Vector]pos,  [float]angle, [integer]health, [integer]armour, [integer]weapon, [integer]ammo, [Vector]speed, [Vector]aimpos, [Vector]aimdir, [bool]isCrouching, [bool]isReloading )

This event is called just before sending the Aiming Packet( with decreased ammo) to server. The purpose is to manually change the aimpos/aimdir for accuracy.
To manually change, Call SendOnFootSyncDataEx at this point and then return false.
The automatic sending of aim packet depends on the return value of this function:

return value
false will not send packet, assuming the user send it using SendOnFootSyncDataEx or similar functions
0 "
null (or no return value) "

Functions

1. ShootPlayer

ShootPlayer([integer]playerid)

The npc pickup a gun from it's available weapons and starts shooting at the player. To shoot with a specific gun set the weapon of npc prior to the call. From npcscripts this can be done using SetLocalValue with field I_CURWEP
return value: true on success, false on failure (player not streamed in or no proper gun available)

2. ClearTarget

ClearTarget()

Clears the target and calls OnTargetCleared with reason as INSTRUCTION_RECEIVED
return vaue: true (if the npc had a target) or false( if the npc did not had a target)

3. GetTarget

GetTarget()

return value: The player ID of the target or -1 if there is no target.