Thread: [ANY] Hook Grab Rope (1.1.4)
View Single Post
Author Message
Sheepdude
SourceMod Donor
Sheepdude's Avatar
Join Date: Aug 2012
Location: Chicago
Old 11-17-2012 , 18:36   [ANY] Hook Grab Rope (1.1.4)
Reply With Quote #1
Hook Grab Rope

Version 1.1.4


Table of Contents
----------------------------------------------------
Description
Commands and Cvars
Forwards and Natives
Complementary Plugins
Installation
Dependencies
Credits
Changelog
To Do
Notes
Download


Description
----------------------------------------------------
Allows admins (or all players) to hook on to walls,
grab other players, or swing on a rope.

Example usage: bind q +hook

Youtube Demonstration: http://www.youtube.com/watch?v=4whoHchDdgc


Commands and Cvars
----------------------------------------------------
Commands
+hook Shoot a hook and glide toward where it lands
+grab Grab a player or object and move it around
+rope Attach a rope and swing on it
+push Shoot a hook and push away from it

Spoiler


Forwards and Natives
----------------------------------------------------
Code:
/**
 * Called when a player tries to hook.
 *
 * @param client     Player index.
 * @return           Plugin_Handled; to stop the player from hooking.
 */
forward Action:HGR_OnClientHook(client);

/**
 * Called when a player tries to search for a grab target.
 *
 * @param client     Player index.
 * @return           Plugin_Handled; to stop the player from searching.
 */
forward Action:HGR_OnClientGrabSearch(client);

/**
 * Called when a player tries to grab a valid target.
 *
 * @param client     Player index.
 * @return           Plugin_Handled; to stop the player from grabbing.
 */
forward Action:HGR_OnClientGrab(client);

/**
 * Called when a player tries to rope.
 *
 * @param client     Player index.
 * @return           Plugin_Handled; to stop the player from roping.
 */
forward Action:HGR_OnClientRope(client);

/**
 * Gives or removes group access to hook, grab, or rope.
 * Each client will receive a notification in chat.
 *
 * @param target     Group target [@all/@ct/@t] (String)
 * @param access     0 - Give, 1 - Take (integer)
 * @param action     0 - Hook, 1 - Grab, 2 - Rope (integer)
 * @return           The number of players whose access was set.
 */
native HGR_Access(const String:target[], access, action);

/**
 * Gives or removes client access to hook, grab, or rope.
 * The client will receive a notification in chat.
 *
 * @param client     Player index (integer)
 * @param access     0 - Give, 1 - Take (integer)
 * @param action     0 - Hook, 1 - Grab, 2 - Rope (integer)
 * @return           True if successful, false if client is a bot.
 * @error            Player index is out of bounds.
 */
native bool:HGR_ClientAccess(client, access, action);

/**
 * Returns whether or not a client is using the hook.
 *
 * @param client     Player index (integer)
 * @return           True if player is hooking, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsHooking(client);

/**
 * Returns whether or not a client is using the grab.
 *
 * @param client     Player index (integer)
 * @return           True if player is grabbing, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsGrabbing(client);

/**
 * Returns whether or not a client is being grabbed.
 *
 * @param client     Player index (integer)
 * @return           True if player is being grabbed, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsBeingGrabbed(client);

/**
 * Returns whether or not a client is using the rope.
 *
 * @param client     Player index (integer)
 * @return           True if player is using the rope, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsRoping(client);

/**
 * Returns whether or not a client is hooking backward
 *
 * @param client     Player index (integer)
 * @return           True if player is hooking backward, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsPushing(client);

/**
 * Returns whether or not a client is attracting a grab target
 *
 * @param client     Player index (integer)
 * @return           True if player is attracting grab target, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsAttracting(client);

/**
 * Returns whether or not a client is repelling a grab target
 *
 * @param client     Player index (integer)
 * @return           True if player is repelling grab target, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsRepelling(client);

/**
 * Returns whether or not a client is ascending a rope
 *
 * @param client     Player index (integer)
 * @return           True if player is ascending a rope, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsAscending(client);

/**
 * Returns whether or not a client is descending a rope
 *
 * @param client     Player index (integer)
 * @return           True if player is descending a rope, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_IsDescending(client);

/**
 * Retrieves the location where a client's hook is attached.
 *
 * @param client     Player index (integer)
 * @param buffer     Buffer to store the location in (Float)
 * @return           True if player is hooking, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_GetHookLocation(client, Float:buffer[3]);

/**
 * Retrieves the location where a client's grab is attached.
 *
 * @param client     Player index (integer)
 * @param buffer     Buffer to store the location in (Float)
 * @return           True if player is grabbing, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_GetGrabLocation(client, Float:buffer[3]);

/**
 * Retrieves the location where a client's rope is attached.
 *
 * @param client     Player index (integer)
 * @param buffer     Buffer to store the location in (Float)
 * @return           True if player is using the rope, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_GetRopeLocation(client, Float:buffer[3]);

/**
 * Retrieves the location opposite of where a client's hook is attached.
 *
 * @param client     Player index (integer)
 * @param buffer     Buffer to store the location in (Float)
 * @return           True if player is using the hook, false otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_GetPushLocation(client, Float:buffer[3]);

/**
 * Retrieves the distance between the client and where their hook landed
 *
 * @param client     Player index (integer)
 * @return           Hook distance, or -1 if client is not hooking.
 * @error            Player index is out of bounds.
 */
native Float:HGR_GetHookDistance(client);

/**
 * Retrieves the distance between the client and their grab target
 *
 * @param client     Player index (integer)
 * @return           Grab distance, or -1 if client is not hooking.
 * @error            Player index is out of bounds.
 */
native Float:HGR_GetGrabDistance(client);

/**
 * Retrieves the distance between the client and where their rope landed
 *
 * @param client     Player index (integer)
 * @return           Rope distance, or -1 if client is not hooking.
 * @error            Player index is out of bounds.
 */
native Float:HGR_GetRopeDistance(client);

/**
 * Retrieves the distance between the client and the location opposite of where their hook landed
 *
 * @param client     Player index (integer)
 * @return           Push distance, or -1 if client is not hooking.
 * @error            Player index is out of bounds.
 */
native Float:HGR_GetPushDistance(client);

/**
 * Retrieves the entity index of a client's hook target.
 *
 * @param client     Player index (integer)
 * @return           Entity index of hook target, or -1 if client has no target.
 * @error            Player index is out of bounds.
 */
native HGR_GetHookTarget(client);

/**
 * Retrieves the entity index of a client's grab target.
 *
 * @param client     Player index (integer)
 * @return           Entity index of grab target, or -1 if client has no target.
 * @error            Player index is out of bounds.
 */
native HGR_GetGrabTarget(client);

/**
 * Retrieves the entity index of a client's rope target.
 *
 * @param client     Player index (integer)
 * @return           Entity index of rope target, or -1 if client has no target.
 * @error            Player index is out of bounds.
 */
native HGR_GetRopeTarget(client);

/**
 * Retrieves the entity index opposite of a client's hook target.
 *
 * @param client     Player index (integer)
 * @return           Entity index of push target, or -1 if client has no target.
 * @error            Player index is out of bounds.
 */
native HGR_GetPushTarget(client);

/**
 * Forces a client to use their hook.
 *
 * @param client     Player index (integer)
 * @return           False if player is performing an action and unable to hook, true otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_ForceHook(client);

/**
 * Forces a client to use their grab.
 *
 * @param client     Player index (integer)
 * @return           False if player is performing an action and unable to grab, true otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_ForceGrab(client);

/**
 * Forces a client to use their rope.
 *
 * @param client     Player index (integer)
 * @return           False if player is performing an action and unable to rope, true otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_ForceRope(client);

/**
 * Forces a client to use their hook push.
 *
 * @param client     Player index (integer)
 * @return           False if player is performing an action and unable to push, true otherwise.
 * @error            Player index is out of bounds.
 */
native bool:HGR_ForcePush(client);

/**
 * Stops a client hook in progress.
 *
 * @param client     Player index (integer)
 * @return           True if successful, false if player is not hooking.
 * @error            Player index is out of bounds.
 */
native bool:HGR_StopHook(client);

/**
 * Stops a client grab in progress.
 *
 * @param client     Player index (integer)
 * @return           True if successful, false if player is not grabbing.
 * @error            Player index is out of bounds.
 */
native bool:HGR_StopGrab(client);

/**
 * Stops a client rope in progress.
 *
 * @param client     Player index (integer)
 * @return           True if successful, false if player is not roping.
 * @error            Player index is out of bounds.
 */
native bool:HGR_StopRope(client);

/**
 * Stops a client hook push in progress.
 *
 * @param client     Player index (integer)
 * @return           True if successful, false if player is not pushing.
 * @error            Player index is out of bounds.
 */
native bool:HGR_StopPush(client);

Complementary Plugins
----------------------------------------------------
  • [HGRMM 1.0] Hook Grab Rope Minimum/Maximum Distance (29 November 2012)
    -Restricts player actions to a specific distance range.
    -Set convars in /cfg/sourcemod/hgrmm.cfg.

  • [HGRLimit 1.0] Hook Grab Rope Limit Use (20 December 2012)
    -Restricts player actions to a certain number of uses per round and map.
    -Set convars in /cfg/sourcemod/hgrlimit.cfg.


Installation
----------------------------------------------------
Extract the zip file contents into your game directory.
Edit settings in \cfg\sourcemod\hookgrabrope.cfg


Dependencies
----------------------------------------------------
None


Credits
----------------------------------------------------
Changelog
----------------------------------------------------
Spoiler
  • 1.1.4 (21 December 2012)
    -Bug fix: Previously, the plugin was freezing the grabber instead of the grab target.


To Do
----------------------------------------------------
  • None at the moment.

Notes
----------------------------------------------------
  • This plugin is meant to replace the previous HGRSource plugin.
  • If you are using custom UpButton and DownButton convars, keep in mind that some buttons may not function correctly for your mod.
  • Let me know if you find any bugs or have a feature request.
  • Use admin_overrides.cfg to change admin permissions for the plugin commands.
Example admin_overrides.cfg:
Code:
Overrides
{
	"+grab"	"z"
	"+rope"	"cef"
}
In this example, only admins with the "z" flag can use grab, and only admins with all three "cef" flags can use rope. Since hook is not listed, any admin with ADMFLAG_GENERIC ("b") flag can use hook.


Download
----------------------------------------------------
Attached Files
File Type: zip hgrmm_1.0.zip (8.1 KB, 6156 views)
File Type: zip hgrlimit_1.0.zip (8.3 KB, 5889 views)
File Type: zip hookgrabrope_1.1.4.zip (52.1 KB, 23865 views)
__________________
Last edited by Sheepdude; 12-21-2012 at 02:50. Reason: version 1.1.4
Sheepdude is offline