AMX Mod X API Documentation

Forwards
Signature
forward pfn_touch(ptr, ptd);
Description

Called when two entities touch.

Parameters
  • ptr Index of entity being touched
  • ptd Index of entity touching
Returns

PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to block

Signature
forward server_frame();
Description

Called at the start of every server frame.

Notes
  • Using his forward can easily become performance-critical. More specific

    hooks and forwards should be used whenever possible.

No return value
Signature
forward client_kill(id);
Description

Called when a client types kill in console.

Parameters
  • id Client index
Returns

PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to block

Signature
forward client_PreThink(id);
Description

Called at the start of each client think.

Notes
  • Using his forward can easily become performance-critical. More specific

    hooks and forwards should be used whenever possible.

Parameters
  • id Client index
No return value
Signature
forward client_PostThink(id);
Description

Called after each client think.

Notes
  • Using his forward can easily become performance-critical. More specific

    hooks and forwards should be used whenever possible.

Parameters
  • id Client index
No return value
Signature
forward client_impulse(id, impulse);
Description

Called when a client triggers an impulse.

Parameters
  • id Client index
  • impulse Impulse triggered by client
  • PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to

    nullify impulse (CmdStart() is not blocked)

Signature
forward client_cmdStart(id);
Description

Called for CmdStart() on a client.

Notes
  • Use [get|set]_usercmd() to read and modify information in the usercmd

    struct.

Parameters
  • id Client index
Returns

PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to block

Signature
forward pfn_think(entid);
Description

Called when an entity thinks.

Parameters
  • entid Entity index
Returns

PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to block

Signature
forward pfn_playbackevent(flags, entid, eventid, Float:delay, Float:Origin[3], Float:Angles[3], Float:fparam1, Float:fparam2, iparam1, iparam2, bparam1, bparam2);
Description

Called when an event is played.

Parameters
  • flags Event flags
  • entid Index of entity to invoke event on
  • eventid Index of event in the precache table
  • delay Time until the event is played
  • Origin Origin to play event from
  • Angles Angles to play event with
  • fparam1 Float parameter 1 to pass along into/with the event
  • fparam2 Float parameter 2 to pass along into/with the event
  • iparam1 Integer parameter 1 to pass along into/with the event
  • iparam2 Integer parameter 2 to pass along into/with the event
  • bparam1 Boolean parameter 1 to pass along into/with the event
  • bparam2 Boolean parameter 2 to pass along into/with the event
Returns

PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to block

Signature
forward pfn_keyvalue(entid);
Description

Called when a keyvalue pair is sent to an entity.

Notes
  • Use copy_keyvalue() to retrieve the keyvalue information, and

    DispatchKeyVaue() to modify it.

Parameters
  • entid Entity index
Returns

PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to block

Signature
forward pfn_spawn(entid);
Description

Called when an entity is spawned.

Parameters
  • entid Entity index
Returns

PLUGIN_CONTINUE to ignore, PLUGIN_HANDLED or higher to block

Назад
Верх