mirror of
https://github.com/JezuzLizard/t6-fastfile-mods.git
synced 2025-07-08 09:07:56 -05:00
Convert more builtins to use sys namespace. Add pluto_sys builtins and documentation.
This commit is contained in:
JezuzLizard
297
zm_ai_pack/pluto_sys.gsc
Normal file
297
zm_ai_pack/pluto_sys.gsc
Normal file
@ -0,0 +1,297 @@
|
||||
// Plutonium T6 Exclusive Builtins
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Returns a function pointer based on <path> and <func_name>;
|
||||
Does not trigger compilation or resolving of the script, therefore if the script isn't referenced by an include or far call at least once it will fail
|
||||
to find the function and return undefined.;
|
||||
[CALL_TYPE]: function;
|
||||
[USAGE]: func = getfunction( <path>, <func_name> );
|
||||
[PARAMS]: ARG1:<string> ARG2:<string>;
|
||||
[PARAMS_NOTES]: Path must use forward slashes to denote the path;
|
||||
[RETURNS]: <function_pointer> or <undefined>;
|
||||
@/
|
||||
getfunction( path, func_name )
|
||||
{
|
||||
return getfunction( path, func_name );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Used inside a function with a hook applied to it by replacefunc. When called resumes execution of the original function starting at the top.
|
||||
Unlike removedetour the hook is reenabled automatically when the function exits.;
|
||||
[CALL_TYPE]: function;
|
||||
[USAGE]: disabledetouronce();
|
||||
[PARAMS]: NONE;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
[ERRORS]: 1. Must be called inside a function that had a hook applied to it by replacefunc.;
|
||||
@/
|
||||
disabledetouronce()
|
||||
{
|
||||
disabledetouronce();
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Takes in <func> and returns the function pointer it was detoured to or returns undefined if <func> was not hooked
|
||||
at the time of calling getdetour.;
|
||||
[CALL_TYPE]: function;
|
||||
[USAGE]: getdetour( <func> );
|
||||
[PARAMS]: ARG1:<function_pointer>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: <function_pointer> or <undefined>;
|
||||
@/
|
||||
getdetour( func )
|
||||
{
|
||||
return getdetour( func );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Returns an array of pathnodes based on the caller node's path links. Returns an empty array if no links exist for caller node;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self getlinkednodes();
|
||||
[PARAMS]: ARG0:<node>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: <array>;
|
||||
@/
|
||||
getlinkednodes()
|
||||
{
|
||||
return self getlinkednodes();
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Sends a personal chat message to caller player. Applies ^7 and sv_sayName dvar's value to start of message unless sv_sayName dvar's value is blank
|
||||
in which case the message is not modified before being sent to the client.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self tell( <message> );
|
||||
[PARAMS]: ARG0:<entity> ARG1:<string>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
tell( message )
|
||||
{
|
||||
self tell( message );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Sends a chat message to all players. Applies ^7 and sv_sayName dvar's value to start of message unless sv_sayName dvar's value is blank
|
||||
in which case the message is not modified before being sent to the client.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self tell( <message> );
|
||||
[PARAMS]: ARG1:<string>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
say( message )
|
||||
{
|
||||
say( message );
|
||||
}
|
||||
|
||||
// The following are bot specifc builtins
|
||||
/@
|
||||
[BOT_BUTTON_TYPES]:
|
||||
{
|
||||
"attack",
|
||||
"sprint",
|
||||
"melee",
|
||||
"activate",
|
||||
"reload",
|
||||
"usereload",
|
||||
"gostand",
|
||||
"frag",
|
||||
"smoke",
|
||||
"holdbreath",
|
||||
"crouch",
|
||||
"prone",
|
||||
"leanleft",
|
||||
"leanright",
|
||||
"vehicleboost",
|
||||
"stance",
|
||||
"switchseat",
|
||||
"throwback",
|
||||
"throw",
|
||||
"handbrake",
|
||||
"reverse",
|
||||
"jam",
|
||||
"vehiclemovedown",
|
||||
"vehiclemoveup",
|
||||
"vehicleattacksecond",
|
||||
"vehicleattack",
|
||||
"ads",
|
||||
"actionslot 1",
|
||||
"actionslot 2",
|
||||
"actionslot 3",
|
||||
"actionslot 4"
|
||||
};
|
||||
[BOT_BUTTON_VALUES]:
|
||||
{
|
||||
"enable",
|
||||
"disable"
|
||||
};
|
||||
@/
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Allows bot to melee lunge at entity with <ent_num> and <dist> to control the lunge distance when bot activates melee.
|
||||
<dist> is hard capped to values between 0 and 255.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botmeleeparams( <ent_num>, <dist> );
|
||||
[PARAMS]: ARG0:<entity> ARG1:<int> ARG2:<float>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botmeleeparams( ent_num, dist )
|
||||
{
|
||||
self botmeleeparams( ent_num, dist );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Toggles off melee lunging for bot and clears the current dist and ent_num set by botmeleeparams.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearmeleeparams();
|
||||
[PARAMS]: ARG0:<entity>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botclearmeleeparams()
|
||||
{
|
||||
self botclearmeleeparams();
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Overrides caller bot's forward and right movement until botclearmoveoverride is called on caller bot. Values are between -127 for fully backwards and left, and fully 128 for forwards and right.
|
||||
Bot effectively simulates analog movement where max absolute values mean maximum speed and 0 no movement in that direction at all.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botmovementoverride( <forward>, <right> );
|
||||
[PARAMS]: ARG0:<entity> ARG1:<int> ARG2:<int>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botmovementoverride( forward, right )
|
||||
{
|
||||
self botmovementoverride( forward, right );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Toggles off a movement override and resets forward and right values for caller bot.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearmovementoverride();
|
||||
[PARAMS]: ARG0:<entity>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botclearmovementoverride()
|
||||
{
|
||||
self botclearmovementoverride();
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Causes caller bot to press and hold <button> if <toggle> is "enable",
|
||||
otherwise if <toggle> is "disable" will not be able to use <button> automatically.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botbuttonoverride( <button>, <toggle> );
|
||||
[PARAMS]: ARG0:<entity> ARG1:<string> ARG2:<string>;
|
||||
[PARAMS_NOTES]: <button> must be one of [BOT_BUTTON_TYPES] and toggle must be one of [BOT_BUTTON_VALUES];
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botbuttonoverride( button, toggle )
|
||||
{
|
||||
self botbuttonoverride( button, toggle );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Toggles off a button override for caller bot.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearbuttonoverride();
|
||||
[PARAMS]: ARG0:<entity>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botclearbuttonoverride( button )
|
||||
{
|
||||
self botclearbuttonoverride( button );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: If [toggle] is truthy all bot overrides set by the other Plutonium bot builtins will be cleared.
|
||||
Otherwise if [toggle] is falsy or not specified all bot overrides will be enabled and all buttons disabled.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearoverrides();
|
||||
[PARAMS]: ARG0:<entity> ARG1:[int];
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botclearoverrides( toggle )
|
||||
{
|
||||
if ( !isDefined( toggle ) )
|
||||
{
|
||||
self botclearoverrides();
|
||||
}
|
||||
else
|
||||
{
|
||||
self botclearoverrides( toggle );
|
||||
}
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Forces caller bot to use <weapon> from their inventory until botclearweaponoverride is called on caller bot.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botweaponoverride( <weapon> );
|
||||
[PARAMS]: ARG0:<entity> ARG1:<string>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botweaponoverride( weapon )
|
||||
{
|
||||
self botweaponoverride( weapon );
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Toggles off the weapon override applied by botweaponoverride;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearweaponoverride();
|
||||
[PARAMS]: ARG0:<entity>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botclearweaponoverride()
|
||||
{
|
||||
self botclearweaponoverride();
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Clears all button overrides applied to caller bot.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearbuttonoverrides();
|
||||
[PARAMS]: ARG0:<entity>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botclearbuttonoverrides()
|
||||
{
|
||||
self botclearbuttonoverrides();
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Toggles off caller bot's ability to automatically aim until botclearaimoverride is called on caller bot.
|
||||
This allows for setplayerangles to used on caller bot to control their aiming.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearbuttonoverrides();
|
||||
[PARAMS]: ARG0:<entity>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botaimoverride()
|
||||
{
|
||||
self botaimoverride();
|
||||
}
|
||||
|
||||
/@
|
||||
[DESCRIPTION]: Clears the aim override applied by botaimoverride for caller bot.;
|
||||
[CALL_TYPE]: method;
|
||||
[USAGE]: self botclearaimoverride();
|
||||
[PARAMS]: ARG0:<entity>;
|
||||
[PARAMS_NOTES]: NONE;
|
||||
[RETURNS]: NONE;
|
||||
@/
|
||||
botclearaimoverride()
|
||||
{
|
||||
self botclearaimoverride();
|
||||
}
|
||||
Reference in New Issue
Block a user