Game Script Methods (BO2)

From COD Engine Research

Player Methods

Prototype Description
void giveweapon( string weapon, int altModelIndex, int weaponOptions )
void giveweapon( string weapon, int altModelIndex )
void giveweapon( string weapon ) 		Summary:

Gives a weapon to the specified client with an optional argument for camo and attachments. A full list containing all the weapon names can be found here http://pastebin.com/wEq07Yzw

Example:

player giveweapon("mp7_mp", 255, 0);
void updateweaponoptions( string weapon, int weaponOptions ) Summary:



Example:






void setblockweaponpickup( string weapon, int blockWeaponPickup )

Summary:





Example:









int calcweaponoptions( int camo, int lens, int reticle, int tag, int emblem )
int calcweaponoptions( int camo, int lens, int reticle, int tag )
int calcweaponoptions( int camo, int lens, int reticle )
int calcweaponoptions( int slotIndex, int weaponType )

Summary:





Example:









int calcplayeroptions( int )

Summary:





Example:









void setplayerrenderoptions( int )

Summary:





Example:









void nextplayerrenderoption( string )

Summary:





Example:









void bbclasschoice( int, string, string )

Summary:





Example:









void sethighlighted()

Summary:





Example:









void takeweapon( string )

Summary:


Removes the first occurrence of the specified weapon from a client.


Example:




player takeweapon("mp7_mp");





bool isthrowinggrenade()

Summary:


Returns true if the specified client is throwing a grenade.


Example:




if (player isthrowinggrenade())





void forcegrenadethrow()

Summary:


Forces the specified client to throw a grenade.


Example:




player forcegrenadethrow();





bool isfiring()

Summary:


Returns true if the specified client is shooting.


Example:




if (player isfiring())





bool ismeleeing()

Summary:


Returns true if the specified client is meleeing.


Example:




if (player ismeleeing())





bool isswitchingweapons()

Summary:


Returns true if the specified client is switching weapons.


Example:




if (player isswitchingweapons())





bool isreloading()

Summary:


Returns true if the specified client is reloading.


Example:




if (player isreloading())





void takeallweapons()

Summary:


Removes all weapons from the specified client including the default melee knife.


Example:




player takeallweapons();





bool isinmovemode()

Summary:





Example:









string getcurrentweapon()

Summary:


Returns the specified clients currently held weapon.


Example:




currentWeapon = player getcurrentweapon();





float getcurrentweaponspinlerp()

Summary:





Example:









void setcurrentweaponspinlerp( float )

Summary:





Example:









string getcurrentweaponaltweapon()

Summary:





Example:









int isweaponoverheating( int )

Summary:


Returns 1 if the specified client's slot index is overheating.


Example:




if (player isweaponoverheating(0))





void setweaponoverheating( int, float )

Summary:


Sets the specified clients slot index overheat to a percentage.


Example:




player setweaponoverheating(0, 99);





string getcurrentoffhand()

Summary:


Returns the current lethal/tactical or equipment.


Example:




offhandWeapon = player getcurrentoffhand();





bool isusingoffhand()

Summary:


Returns true if the specified client is using their offhand weapon.


Example:




if (player isusingoffhand())





void forceoffhandend()

Summary:


Forces the specified client to use their offhand weapon.


Example:




player forceoffhandend()





bool hasweapon( string )

Summary:


Returns true if the specified client has the specified weapon.


Example:




if (player hasweapon("mp7_mp"))





void switchtoweapon()

Summary:


Forces the specified weapon to switch to the specified weapon.


Example:




player switchtoweapon("mp7_mp");





void switchtoweaponimmediate()

Summary:





Example:









bool switchtooffhand( string )

Summary:


Switch the player's offhand weapon


Example:









void weaponplayejectbrass()

Summary:





Example:









int getlockonradius()

Summary:





Example:









int getlockonspeed()

Summary:





Example:









void givestartammo( string )

Summary:


Sets the specified clients' specified weapon to the starting ammunition amount.


Example:




player givestartammo("mp7_mp");





void givemaxammo( string )

Summary:


Gives the specified clients' specified weapon maximum ammunition.


Example:




player givemaxammo("mp7_mp");





float getfractionstartammo( string )

Summary:


Returns a float of the specified weapons starting ammunition.


Example:




fractionStartAmmo = player getfractionstartammo("mp7_mp");





float getfractionmaxammo( string )

Summary:


Returns a float of the specified weapons maximum ammunition.


Example:




fractionMaxAmmo = player getfractionmaxammo("mp7_mp");





void setweaponheatpercent( string, float )

Summary:





Example:









void setorigin( vector )

Summary:


Teleports the player to a location defined by x, y and z coordinate values.


Example:




player setorigin((900, -78, 2055.1));





void setvelocity( vector )

Summary:


Set the player's velocity


Example:









void setplayerangles( vector )

Summary:


Changes the player's view direction via x and y coordinate values.


Example:




player setplayerangles(anotherplayer.angles);





vector getplayerangles()

Summary:


Get the player's angles


Example:









vector getgunangles()

Summary:





Example:









vector getplayercamerapos()

Summary:





Example:









void cameraactivate( int )

Summary:





Example:









void camerasetposition( vector, vector )

Summary:





Example:









void camerasetlookat( entity, vector )

Summary:





Example:









void gamepadusedlast()

Summary:





Example:









int usebuttonpressed()

Summary:


Returns 1 if the use button is pressed otherwise 0.


Example:




if (player usebuttonpressed())





int changeseatbuttonpressed()

Summary:





Example:









int attackbuttonpressed()

Summary:


Returns 1 if the shooting button is pressed otherwise 0.


Example:




if (player attackbuttonpressed())





int actionslotonebuttonpressed()

Summary:





Example:









int actionslottwobuttonpressed()

Summary:





Example:









int actionslotthreebuttonpressed()

Summary:


1 if the left inventory button is pressed otherwise 0.


Example:




if (player actionslotthreebuttonpressed())





int actionslotfourbuttonpressed()

Summary:





Example:









int adsbuttonpressed()

Summary:


Returns 1 if the aiming down the sights button is pressed otherwise 0.


Example:




if (player adsbuttonpressed())





int throwbuttonpressed()

Summary:





Example:









int meleebuttonpressed()

Summary:


Returns 1 if the melee button is pressed otherwise 0.


Example:




if (player meleebuttonpressed())





int jumpbuttonpressed()

Summary:


Returns 1 if the jumping button is pressed otherwise 0.


Example:




if (player jumpbuttonpressed())





int stancebuttonpressed()

Summary:





Example:









int fragbuttonpressed()

Summary:


Returns 1 if the lethal grenade button is pressed otherwise 0.


Example:




if (player fragbuttonpressed())





int secondaryoffhandbuttonpressed()

Summary:





Example:









int inventorybuttonpressed()

Summary:





Example:









int sprintbuttonpressed()

Summary:





Example:









void sprintuprequired()

Summary:





Example:









float playerads()

Summary:


Return the player's weapon position fraction.


Example:









void pingplayer()

Summary:


Flashes a player on their teammate's compasses


Example:









void setviewmodel( string )

Summary:


Set the player's current view model.


Example:









conststring getviewmodel()

Summary:


Get the viewmodel name for the given player


Example:









void setoffhandsecondaryclass( string )

Summary:


Set whether player can use smoke grenades or flashbangs.


Example:









conststring getoffhandsecondaryclass()

Summary:


Gets the name (either "smoke" or "flash") that toggle is set to.


Example:









string setoffhandprimaryclass( string )

Summary:





Example:









void beginlocationselection()

Summary:


Causes the player to begin selecting a location. A map HUD element should be visible for them to see where they're selecting. Works with endlocationselection(). When the user confirms or cancels, they will recieve a notify "confirm_location" or "cancel_location". The former notify contains the location they selected, as a vector.


Example:









void beginlocationairstrikeselection()

Summary:





Example:









void beginlocationmortarselection()

Summary:





Example:









void beginlocationartilleryselection()

Summary:





Example:









void beginlocationcomlinkselection()

Summary:





Example:









void beginlocationnapalmselection()

Summary:





Example:









void endlocationselection()

Summary:


Causes the player to leave location selection mode. Works with beginlocationselection().


Example:









void clientsyssetstate( int, string )

Summary:





Example:









void weaponlockstart( entity )

Summary:


Begins player's weapon lockon sequence (hud effects, etc).  Will clear any existing hard lock.  Use WeaponLockFinalize() to complete lock.


Example:









void weaponlockfinalize( entity )

Summary:


Locks player's weapon onto an entity.  Implies WeaponLockStart(), so this may be called to jump to a hard lock.


Example:









void weaponlockfree()

Summary:


Clears player's weapon lock.


Example:









void weaponlocktargettooclose( int )

Summary:


When set true, the player will be unable to fire their lockon weapon, and will recieve a hint print telling them that they are too close.


Example:









void weaponlocknoclearance( int )

Summary:


When set true, the player will be unable to fire their lockon weapon, and will recieve a hint print telling them that there is an obstruction.


Example:









void buttonpressed()

Summary:


Check if the host is pressing the button/key, "BUTTON_A", "BUTTON_B", "K


Example:









void giveweaponnextattachment()

Summary:





Example:









void givenextbaseweapon()

Summary:





Example:









void getnormalizedmovement()

Summary:





Example:









void getnormalizedcameramovement()

Summary:





Example:









void sayall()

Summary:


Write a client chat message from this client to everybody


Example:









void sayteam()

Summary:


Write a client chat message from this client to everybody on their team


Example:









void setspawnweapon( string )

Summary:


Set the weapon that this player will spawn with


Example:









void initialweaponraise( string )

Summary:





Example:









void seteverhadweaponall( int )

Summary:





Example:









void dropitem( string, constlowercasestring )

Summary:


Drop an item with the given item name


Example:









void dropscavengeritem( string )

Summary:





Example:









int hasagrenadepulledback()

Summary:





Example:









bool finishplayerdamage( entity, entity, int, string, vector, vector, conststring, int, int )

Summary:


Does damage to a player - usually as part of the damage callback


Example:









void finishmeleehit( entity, string, vector, vector, int, int, int )

Summary:





Example:









void reviveplayer()

Summary:





Example:









void undolaststand()

Summary:





Example:









void suicide()

Summary:


Kills the specified player.


Example:




player suicide();





void turnedhuman()

Summary:





Example:









bool isinvehicle()

Summary:





Example:









bool isremotecontrolling()

Summary:





Example:









bool isweaponviewonlylinked()

Summary:





Example:









int allowstand( int )

Summary:


Sets whether the player can stand up


Example:









int allowcrouch( int )

Summary:


Sets whether the player can crouch


Example:









int allowprone( int )

Summary:


Sets whether the player can go prone


Example:









int allowlean( int )

Summary:


Sets whether the player can lean


Example:









entity getvehicleoccupied()

Summary:





Example:









array getfriendlies( int )

Summary:





Example:









array getenemies( int )

Summary:





Example:









int openmenu( string )

Summary:


Open a menu for this player


Example:









int openmenunomouse( string )

Summary:


Open a menu for this player, with no mouse control.


Example:









void closemenu()

Summary:


Close the current player menu


Example:









void closeingamemenu()

Summary:


close the in game menu for this client.


Example:









void freezecontrols( int )

Summary:


Freezes/unfreezes the controls of the specified player


Example:




player freezecontrols(1);
 




void freezecontrolsallowlook( int )

Summary:





Example:









int arecontrolsfrozen()

Summary:





Example:









void disableusability()

Summary:





Example:









void enableusability()

Summary:





Example:









void disableweapons()

Summary:


Disable the player's weapon


Example:









void enableweapons()

Summary:


Enable the player's weapons


Example:









void disabledeathstreak()

Summary:





Example:









void enabledeathstreak()

Summary:





Example:









int deathstreakactive()

Summary:





Example:









void disableoffhandweapons()

Summary:





Example:









void enableoffhandweapons()

Summary:





Example:









void disableweaponcycling()

Summary:





Example:









void enableweaponcycling()

Summary:





Example:









void revive()

Summary:





Example:









void setlaststandprevweap( string )

Summary:





Example:









void setreverb()

Summary:


Set the sound reverberation for the player


Example:









void deactivatereverb()

Summary:


deactivate the sound reverberation for the player on the given priority level


Example:









void setchannelvolumes()

Summary:


Set the channel volumes for the player (a way of fading volumes by type)


Example:









void deactivatechannelvolumes()

Summary:


deactivate the channel volumes for the player on the given priority level


Example:









int setweaponammoclip( string, int )

Summary:


Set the weapon clip ammunition for the given weapon.


Example:









void setweaponammostock( string, int )

Summary:


Set the ammunition stockpile for the given weapon.


Example:









int getweaponammoclip( string )

Summary:


Gets the amount of ammo left in the player's current weapon clip.


Example:









int getweaponammostock( string )

Summary:


Gets the ammunition stockpile for the given weapon.


Example:









int anyammoforweaponmodes( string )

Summary:


Returns true if the player has any ammo available for the weapon or any of it's alt-modes (grenade launcher, etc).


Example:









void iprintln()

Summary:


Prints text for the specified player only in the killfeed.


Example:




player iprintln("Hello, World!");





void iprintlnbold()

Summary:


Prints text for the specified player only in the middle of the screen. If the player entity is omitted, the text will be printed for every player in the lobby.


Example:




player iprintlnBold("Hello, World!");





void spawn( vector, vector )

Summary:


Spawns a new entity and returns a reference to the entity.


Example:




ufo = spawn("script_model", self.origin);





void setentertime( int )

Summary:





Example:









void cloneplayer( int )

Summary:


Creates a clone of the specified player at current position.


Example:




player cloneplayer();
 




void setclientfov( float )

Summary:


Sets the field of view for a player.


Example:




player setclientfov("90");





void setclientthirdperson( int )

Summary:


Enables/disables 3rd person view for the specified player


Example:




player setclientthirdperson(1);





void setclientthirdpersonangle()

Summary:





Example:









void setclientcompass()

Summary:





Example:









void setclientscriptmainmenu()

Summary:





Example:









void setclientcgobjectivetext()

Summary:





Example:









void setclientplayersprinttime()

Summary:





Example:









void setclientnumlives()

Summary:





Example:









void setclientdrawtalk()

Summary:





Example:









void setclientammocounterhide()

Summary:





Example:









void setclientminiscoreboardhide()

Summary:





Example:









void setclienthudhardcore()

Summary:





Example:









void setclientplayerpushamount()

Summary:





Example:









void setclientaimlockonpitchstrength()

Summary:





Example:









void setclientuivisibilityflag( string, int )

Summary:





Example:









void setclientprofilevar( string, string )

Summary:





Example:









void playclientairstrike( vector, int, string, string, int, string, int )

Summary:





Example:









void playclientnapalm( vector, int, string, string, int, string, int )

Summary:





Example:









void setcurrentspectatorclient( entity )

Summary:





Example:









void relinktoturret( entity )

Summary:





Example:









void carryturret( entity, vector, vector )

Summary:





Example:









void stopcarryturret( entity, vector, vector )

Summary:





Example:









bool iscarryingturret()

Summary:





Example:









array canplayerplaceturret( entity )

Summary:





Example:









void setplacementhint( int )

Summary:





Example:









void linkguidedmissilecamera()

Summary:





Example:









void unlinkguidedmissilecamera()

Summary:





Example:









void gpsjammeractive()

Summary:





Example:









void gpsjammerinactive()

Summary:





Example:









void spawnprotectionactive()

Summary:





Example:









void spawnprotectioninactive()

Summary:





Example:









void dualgrenadesactive()

Summary:





Example:









void dualgrenadesinactive()

Summary:





Example:









void linktomissile( entity, int )

Summary:





Example:









void unlinkfrommissile()

Summary:





Example:









array canplaceriotshield( conststring )

Summary:





Example:









void setheldweaponmodel( int )

Summary:





Example:









void setriotshieldfailhint()

Summary:





Example:









array canplayerplacevehicle( float, float, float, float, float, float )

Summary:





Example:









void remotecontrolturret( entity )

Summary:





Example:









void remotecontrolturretoff( entity )

Summary:





Example:









void recordkillstreakevent( int )

Summary:





Example:









void recordkillstreakendevent( int )

Summary:





Example:









void recordgameevent( string )

Summary:





Example:









void recordkillmodifier( string )

Summary:





Example:









void recordmedal( string )

Summary:





Example:









void recordloadoutandperks()

Summary:





Example:









void recordloadoutperksandkillstreaks( string, string, string, string, int, int, int )

Summary:





Example:









void recordmultikill( int )

Summary:





Example:









void incrementlifestat()

Summary:





Example:









void incrementplayerstat( string, int )

Summary:





Example:









void recordplayerdeathzombies()

Summary:





Example:









void recordplayerdownzombies( string )

Summary:





Example:









void recordplayerrevivezombies( entity )

Summary:





Example:









void recordzombiezone( string, string )

Summary:





Example:









int islookingat( entity )

Summary:


Returns true if the entity is the same as the player's lookat entity.


Example:









void playlocalsound( string )

Summary:


Plays a sound locally to the player


Example:









void stoplocalsound( string )

Summary:


Stops all instances of a local soundalias running on a player.


Example:









int istalking()

Summary:


Returns true if the player is talking via voice chat


Example:









void allowspectateteam( team, int )

Summary:


Set whether the player can spectate the given team.


Example:









int getguid()

Summary:





Example:









string getxuid()

Summary:





Example:









int ishost()

Summary:


Returns 1 if the specified player is host, otherwise 0.


Example:




if (player isHost())





int islocaltohost()

Summary:





Example:









int allowads( int )

Summary:


Sets whether the player can switch to ADS


Example:









int allowjump( int )

Summary:


Sets whether the player can jump


Example:









int allowsprint( int )

Summary:


Sets whether the player can sprint


Example:









int allowmelee( int )

Summary:


Sets whether the player can melee


Example:









int forceslick( int )

Summary:





Example:









void setsprintduration( float )

Summary:





Example:









void setsprintcooldown( float )

Summary:





Example:









void setspreadoverride( int )

Summary:


Sets the player fixed spread value


Example:









void resetspreadoverride()

Summary:


Resets the player spread value to the ones of the weapon in use.


Example:









void setactionslot( int, string, string )

Summary:


Sets the option to perform when the player executes (for example) "+actionslot 1".


Example:









string getinventoryweapon()

Summary:





Example:









void setinventoryweapon( string )

Summary:





Example:









array getweaponslist( int )

Summary:


Gets an array of all weapons that the player has.  Includes any alt-mode weapons (ex: m203_m4)


Example:









array getweaponslistprimaries()

Summary:


Gets an array of all primary weapons that the player has.


Example:









void startrevive()

Summary:





Example:









void stoprevive()

Summary:





Example:









void applyknockback( int, vector )

Summary:





Example:









void setperk( string )

Summary:


Gives the player the specified perk


Example:




player setperk("specialty_fastladderclimb");





bool hasperk( string )

Summary:


Returns true if the player has the specified perk otherwise false


Example:




if (player hasperk("specialty_fastladderclimb"))






array getperks()

Summary:





Example:









void clearperks()

Summary:


Removes all perks from the player


Example:




player clearperks();





void unsetperk( string )

Summary:


Removes a specific perk from the player


Example:




player unsetperk("specialty_fastladderclimb");





void setrank( int, int )

Summary:


Sets the player's rank and prestige level


Example:




player setRank(level.maxRank, level.maxPrestige);





void enableinvulnerability()

Summary:


Enables god mode/invincibility for the specific player


Example:




player enableinvulnerability();
 




void disableinvulnerability()

Summary:


Disables god mode/invincibility for the specific player


Example:




player disableinvulnerability();





void enableafterlife()

Summary:





Example:









void disableafterlife()

Summary:





Example:









bool addgoal( vector, float, int, conststring, conststring )

Summary:





Example:









void cancelgoal( conststring )

Summary:





Example:









bool atgoal( conststring )

Summary:





Example:









bool hasgoal( conststring )

Summary:





Example:









vector getgoal( conststring )

Summary:





Example:









void pressusebutton( float )

Summary:





Example:









void pressattackbutton( int )

Summary:





Example:









void pressdtpbutton()

Summary:





Example:









bool throwgrenade( string, vector )

Summary:


Throw a grenade.  CheckGrenadeThrowPos() or CheckGrenadeThrow() must be called first.


Example:









float getlookaheaddist()

Summary:





Example:









vector getlookaheaddir()

Summary:





Example:









void lookat( vector )

Summary:





Example:









void clearlookat()

Summary:





Example:









void allowattack( int )

Summary:





Example:









void pressads( int )

Summary:





Example:









void pressmelee()

Summary:





Example:









array getthreats( float )

Summary:





Example:









vector predictposition( entity, int )

Summary:





Example:









bool botsighttracepassed( entity, vector )

Summary:





Example:









void botsetfailsa( pathnode )

Summary:





Example:









void botsetdefaultclass( int, string )

Summary:





Example:









void botclassadditem( int, string )

Summary:





Example:









void botclasssetweaponoption( int, int, string, int )

Summary:





Example:









void botclassaddattachment( int, string, string, string )

Summary:





Example:









void botleavegame()

Summary:





Example:









int issplitscreen()

Summary:


Returns true if the game is a splitscreen game


Example:









int isplayeronsamemachine( entity )

Summary:





Example:









void playerknockback( int )

Summary:





Example:









float getplayerviewheight()

Summary:


Get the player's view height


Example:









void ishostforbots()

Summary:





Example:









void murderline( vector, vector, string )

Summary:





Example:









void setoffhandvisible( int )

Summary:





Example:









void fakedamagefrom( vector )

Summary:





Example:









int getsnapshotackindex()

Summary:





Example:









string getleagueteamid()

Summary:





Example:










Script Entity Methods






Prototype

Description




void moveto( vector )

Summary:


Move this entity to the given point.


Example:









void movex( float )

Summary:


Move this entity to the given world x value


Example:









void movey( float )

Summary:


move this entity to the given world y value


Example:









void movez( float )

Summary:


Move this entity to the given world z value


Example:









void movegravity( vector, float )

Summary:


Fling this entity.


Example:









void moveslide( vector, float, vector )

Summary:





Example:









void stopmoveslide()

Summary:





Example:









void rotateto( vector )

Summary:


Rotate this entity to the given world rotation value


Example:









void rotatepitch( float )

Summary:


Rotate this entity to the given pitch


Example:









void rotateyaw( float )

Summary:


Rotate this entity to the given yaw


Example:









void rotateroll( float )

Summary:


Rotate this entity to the given roll angle


Example:









void devaddpitch( float )

Summary:


Add pitch in local space.  This is just for development purposes and doesn't interpolate


Example:









void devaddyaw( float )

Summary:


Add yaw in local space.  This is just for development purposes and doesn't interpolate


Example:









void devaddroll( float )

Summary:


Add yaw in local space.  This is just for development purposes and doesn't interpolate


Example:









void vibrate( vector, float, float, float )

Summary:


Causes a script entity to vibrate, rotating around its origin, along a given vector dir


Example:









void rotatevelocity( vector )

Summary:


Rotate this entity at a particular velocity for a given time


Example:









void solid()

Summary:


Set the solid flag, so that this object is collidable.


Example:









void notsolid()

Summary:


Unsets the solid flag, so that this object is no longer collidable.


Example:









void setcandamage( int )

Summary:


Set the candamage flag for this entity - this means that it can respond to notifies from bullets and grenade hits


Example:









void physicslaunch( vector, vector )

Summary:


Permanently turn this entity into a physics object with an intial force vector at the specified point.


Example:









void setcheapflag( int )

Summary:





Example:









void ignorecheapentityflag( int )

Summary:





Example:










Script Vehicle Methods






Prototype

Description




void attachpath( entityref )

Summary:


Attaches this vehicle to the given path.


Example:









string vehgetmodel()

Summary:





Example:









array getattachpos( entityref )

Summary:


Returns the origin and angles if the vehicle were to be attached to the path.  The origin and angles are returned as a vector array of size 2.  Origin is 1st and angles is 2nd.


Example:









void startpath()

Summary:


Starts the vehicle following this path.


Example:









entitynum drivepath( int )

Summary:





Example:









void pathmove( vector, vector, vector )

Summary:





Example:









void pathmoveclear()

Summary:





Example:









void pathfixedoffset( vector )

Summary:





Example:









void pathfixedoffsetclear()

Summary:





Example:









void pathvariableoffset( vector, float )

Summary:





Example:









void pathvariableoffsetclear()

Summary:





Example:









vector getpathfixedoffset()

Summary:





Example:









vector getpathvariableoffset()

Summary:





Example:









void setdrivepathphysicsscale( float )

Summary:





Example:









void setswitchnode( entityref, entityref )

Summary:


Sets a switch node for this vehicle.


Example:









void setspeed( float, float, float )

Summary:


Sets the speed and acceleration for this vehicle.


Example:









void setspeedimmediate( float, float, float )

Summary:


Sets the speed and acceleration for this vehicle instantaneously. Direction will be toward the goal direction if there is a goal, otherwise the current direction.


Example:









float getspeed()

Summary:


Gets the current speed in inches per second.


Example:









float getspeedmph()

Summary:





Example:









float getgoalspeedmph()

Summary:


Gets the goal speed in miles per hour.


Example:









void setbrake( float )

Summary:





Example:









float getbrake()

Summary:





Example:









float gethandbrake()

Summary:





Example:









float getscriptbrake()

Summary:





Example:









void setacceleration( float )

Summary:


Sets the acceleration for this vehicle.


Example:









void setdeceleration( float )

Summary:


Sets the deceleration for this vehicle.


Example:









void resumespeed( float )

Summary:


Sets the vehicle to resume its path speed.


Example:









void setyawspeed( float, float, float, float )

Summary:


Sets the yaw speed for this vehicle.


Example:









void setmaxpitchroll( float, float )

Summary:


Sets max pitch and roll angle for this vehicle.


Example:









void setturningability( float )

Summary:


If this is higher, helicopters can make sharper turns to match goal positions better.


Example:









void setjitterparams( vector, float, float )

Summary:


Set the jitter parameters. Set everything to 0 to stop jittering. Vehicle ignores jitter parameters when on ground


Example:









void setairresistance( float )

Summary:


Sets the speed at which air resistance maxes out.


Example:









float getsteering()

Summary:





Example:









float getthrottle()

Summary:





Example:









void setphysangles( vector )

Summary:





Example:









void sethoverparams( float, float, float )

Summary:


Set the hovering parameters.


Example:









void joltbody( vector, float, float, float )

Summary:


Jolts the vehicle.


Example:









void freevehicle()

Summary:


Frees this vehicle instance.


Example:









string getwheelsurface( conststring )

Summary:


Returns the surface type of the given wheel as a string.


Example:









entity getvehicleowner()

Summary:


Returns the owner of this particular vehicle.


Example:









int isvehicleusable()

Summary:





Example:









void makevehicleusable()

Summary:


Sets this vehicle to be usable by the player


Example:









void makevehicleunusable()

Summary:


Sets this vehicle to be not usable by the player


Example:









void usevehicle( entity, int, int )

Summary:





Example:









void setviewclamp( entity, float, float, float, float )

Summary:





Example:









void resetviewclamp( entity, entity )

Summary:





Example:









void setvehiclelookattext( conststring, constistring )

Summary:


Set look at text for vehicle.


Example:









void setneargoalnotifydist( float )

Summary:


Set distance near goal at which near_goal notification should be sent once.


Example:









bool setvehgoalpos( vector, int, int, int )

Summary:


Set the target position for this vehicle.


Example:









void clearvehgoalpos()

Summary:





Example:









void setplanegoalpos( float, vector )

Summary:





Example:









void setplanebarrelroll( int, float )

Summary:





Example:









void setgoalyaw( float )

Summary:


Set the goal yaw direction for this vehicle. Goal yaw is ignored if vehicle doesn't stop at goal. Lookat entity has priority over goal yaw


Example:









void cleargoalyaw()

Summary:


Clear the goal yaw direction for this vehicle.


Example:









void settargetyaw( float )

Summary:


Set the target yaw direction for this vehicle. Goal yaw has priority over target yaw.


Example:









void cleartargetyaw()

Summary:


Clear the target yaw direction for this vehicle.


Example:









void setlookatent( entity )

Summary:


Set the entity this vehicle will orient towards.


Example:









void clearlookatent()

Summary:


Clear the entity the vehicle is orienting towards.


Example:









void takeplayercontrol()

Summary:





Example:









void returnplayercontrol()

Summary:


After controlling a vehicle from script using something like setvehgoalpos(), if the vehicle is being driven by a player, you call this function to return control of the vehicle to the player.


Example:









void setturrettargetvec( vector )

Summary:


Set the target position for this vehicle turret.


Example:









void setturrettargetent( entity, vector )

Summary:


Set the target entity for this vehicle turret.


Example:









void clearturrettarget()

Summary:


Clear the target for the vehicle turret.


Example:









void setgunnertargetvec( vector, int )

Summary:





Example:









vector getgunnertargetvec( int )

Summary:





Example:









void setgunnertargetent( entity, vector, int )

Summary:





Example:









void cleargunnertarget( int )

Summary:





Example:









void setgunnerturretontargetrange( int, float )

Summary:





Example:









entity getgunnertargetent( int )

Summary:





Example:









float getgunneranimpitch( int )

Summary:





Example:









float getgunneranimyaw( int )

Summary:





Example:









void setvehweapon( string )

Summary:


Set the vehicle's weapon


Example:









entity fireweapon( entity, vector )

Summary:


Fire the vehicle's weapon


Example:









entity firegunnerweapon( int, entity )

Summary:





Example:









void stopfireweapon()

Summary:





Example:









int isturretready()

Summary:


Query whether this vehicle's turret is ready for firing


Example:









void setvehmaxspeed( float )

Summary:





Example:









array getvehoccupants()

Summary:





Example:









entity getseatoccupant( int )

Summary:





Example:









int getoccupantseat( entity )

Summary:





Example:









void setseatoccupied( int, int )

Summary:





Example:









string seatgetweapon( int )

Summary:





Example:









vector getseatfiringorigin( int )

Summary:





Example:









vector getseatfiringangles( int )

Summary:





Example:









bool isgunnerfiring( int )

Summary:





Example:









void disablegunnerfiring( int, int )

Summary:





Example:









entity finishvehicledamage( entity, entity, int, string, vector, vector, conststring, int, int, int, conststring, int )

Summary:





Example:









void finishvehicleradiusdamage( entity, entity, float, float, int, string, vector, float, float, vector, int )

Summary:





Example:









bool isvehicleimmunetodamage( int, string, string )

Summary:





Example:









void setdefaultpitch( float )

Summary:





Example:









void cleardefaultpitch()

Summary:





Example:









vector getangularvelocity()

Summary:





Example:









void setangularvelocity( vector )

Summary:





Example:









void setvehvelocity( vector )

Summary:





Example:









void cancelaimove()

Summary:





Example:









void setvehicletype( string )

Summary:





Example:









vector getphysacceleration()

Summary:





Example:









void setphysacceleration( vector )

Summary:





Example:









void drawtrajectory()

Summary:





Example:









void setrotorspeed( float )

Summary:





Example:









float getmaxspeed( int )

Summary:





Example:









void setmantleena( int )

Summary:





Example:









void setvehicleavoidance( int, float, int )

Summary:





Example:









int getvehicleavoidance()

Summary:





Example:









bool vehcansee( entity, int )

Summary:





Example:









bool vehseenrecently( entity, float )

Summary:





Example:









void vehclearenemy()

Summary:





Example:









void vehs( entity, float )

Summary:





Example:









void vehclearentitytarget()

Summary:





Example:









float getturretheatvalue( int )

Summary:





Example:









bool isvehicleturretoverheating( int )

Summary:





Example:









void setpathtransitiontime( float )

Summary:





Example:









array getvehicleavoidancenodes( float )

Summary:





Example:









void makesentient()

Summary:





Example:










Hud Element Methods






Prototype

Description




void settext( string text )

Summary:


Set HUD text for this element.


Example:




hudelem settext( "Hello, World!" );





void clearalltextafterhudelem()

Summary:


Clear the config strings for the unique text set after this string.  This is intended for development use only.


Example:




hudelem clearalltextafterhudelem();





void setshader( string shader, int width, int height )

Summary:


Set the material for this Hud Element


Example:




hudelem setshader( "material", 15, 15 );





void settargetent( entity, entity )

Summary:


Set the entity that this waypoint should target.  In MP, entity should already be a broadcasting entity, as with Objective_OnEntity().


Example:









void cleartargetent()

Summary:


Clear this waypoint from targetting an entity.


Example:




hudelem cleartargetent();





void settimer( float time )

Summary:


Set a timer HUD element to count down


Example:




hudelem settimer( level.counter );





void settimerup( float time )

Summary:


Set a timer HUD element to count up


Example:




hudelem settimerup( level.counter );





void settenthstimer( float time )

Summary:


Set a timer HUD element to count down in tenths of a second


Example:




hudelem settenthstimer( camtime );





void settenthstimerup( float )

Summary:


Set a timer HUD element to count up in tenths of a second


Example:




hudelem settenthstimerup( .1 );





void setclock()

Summary:


Set a clock HUD element to count down over a time period.


Example:









void setclockup()

Summary:


Set a clock HUD element to count up over a time period.


Example:









void setvalue( float )

Summary:


Set a value HUD element to a given value.


Example:









void setwaypoint( int, string, int, int )

Summary:


Sets a hud element to be a waypoint.


Example:









void fadeovertime( float )

Summary:


Set a hud element to transition in color (or alpha) over time.  Normally setting the color (or alpha) of an element causes an immediate visual change. However, if the color (or alpha) gets set within <time> after calling fadeOverTime, then the hud element will transition to the new color over the remaining <time>.


Example:









void scaleovertime( float, int, int )

Summary:


Set a hud element to scale over time.


Example:









void moveovertime( float )

Summary:


Set a hud element to move over time.


Example:









void reset()

Summary:


Reset a HUD element to its default state.


Example:









void destroy()

Summary:


Remove this Hud element altogether.


Example:









void setpulsefx( int, int, int )

Summary:


Set the hudelem string to display with a "Pulse" effect.


Example:









void setcod7decodefx( int, int, int )

Summary:





Example:









void setredactfx( int, int, int, int )

Summary:





Example:









void settypewriterfx( int, int, int )

Summary:





Example:









int gettextwidth()

Summary:





Example:









void setperks( entity, entity )

Summary:





Example:









void setplayernamestring( entity, entity )

Summary:


Set the player name string for a HUD element


Example:









void setmapnamestring( string )

Summary:


Set the map name string


Example:









void setgametypestring( string )

Summary:


Set the game type string for the game


Example:









void setwargamedata()

Summary:





Example:









void changefontscaleovertime( float time )

Summary:


Set a hud element to transition in fontScale over time.  Normally setting the fontScale of an element causes an immediate visual change. However, if the fontScale gets set within <time> after calling ChangeFontScaleOverTime, then the hud element will transition to the new fontScale over the remaining <time>.


Example:










Helicopter Methods






Prototype

Description




void freehelicopter()

Summary:





Example:









void setspeed()

Summary:


Sets the speed and acceleration for this vehicle.


Example:









float getspeed()

Summary:


Gets the current speed in inches per second.


Example:









float getspeedmph()

Summary:





Example:









void resumespeed( float )

Summary:


Sets the vehicle to resume its path speed.


Example:









void setyawspeed( float, float, float, float )

Summary:


Sets the yaw speed for this vehicle.


Example:









void setmaxpitchroll( float, float )

Summary:


Sets max pitch and roll angle for this vehicle.


Example:









void setturningability( float )

Summary:


If this is higher, helicopters can make sharper turns to match goal positions better.


Example:









void setairresistance( float )

Summary:


Sets the speed at which air resistance maxes out.


Example:









void sethoverparams( float, float, float )

Summary:


Set the hovering parameters.


Example:









void setneargoalnotifydist( float )

Summary:


Set distance near goal at which near_goal notification should be sent once.


Example:









bool setvehgoalpos( vector, int, int, int )

Summary:


Set the target position for this vehicle.


Example:









void setgoalyaw( float )

Summary:


Set the goal yaw direction for this vehicle. Goal yaw is ignored if vehicle doesn't stop at goal. Lookat entity has priority over goal yaw


Example:









void cleargoalyaw()

Summary:


Clear the goal yaw direction for this vehicle.


Example:









void settargetyaw( float )

Summary:


Set the target yaw direction for this vehicle. Goal yaw has priority over target yaw.


Example:









void cleartargetyaw()

Summary:


Clear the target yaw direction for this vehicle.


Example:









void setlookatent( entity )

Summary:


Set the entity this vehicle will orient towards.


Example:









void clearlookatent()

Summary:


Clear the entity the vehicle is orienting towards.


Example:









void setvehweapon( string )

Summary:


Set the vehicle's weapon


Example:









entity fireweapon( entity, vector )

Summary:


Fire the vehicle's weapon


Example:









void stopfireweapon()

Summary:





Example:









void setturrettargetvec( vector )

Summary:


Set the target position for this vehicle turret.


Example:









void setturrettargetent( entity, vector )

Summary:


Set the target entity for this vehicle turret.


Example:









void clearturrettarget()

Summary:


Clear the target for the vehicle turret.


Example:









void setdamagestage( int )

Summary:





Example:









void setheliheightlock( int )

Summary:





Example:









float getheliheightlockheight( vector )

Summary:





Example:









int isinsideheliheightlock()

Summary:





Example:









void setheightlockoffset()

Summary:





Example:










Actor Methods






Prototype

Description




void startcoverarrival()

Summary:


Runs cover arrival animscript on an actor.


Example:









void starttraversearrival()

Summary:


Runs traverse arrival animscript on an actor.


Example:









entity melee( vector )

Summary:


Makes this actor melee attack. Returns the entity hit, if any.


Example:









bool reacquirestep( float )

Summary:


Do side step move to safe place left or right while facing enemy.


Example:









void findreacquirenode()

Summary:


Finds a reacquire node when exposed.


Example:









pathnode getreacquirenode()

Summary:


Gets the reacquire node of this actor.


Example:









bool usereacquirenode( pathnode )

Summary:


Use the given reacquire node.


Example:









void findreacquiredirectpath( int )

Summary:


Finds a path directly to the enemy. Call ReacquireMove to use the path.


Example:









bool trimpathtoattack()

Summary:


Trims the path to attack.


Example:









bool reacquiremove()

Summary:


Start the reaquire move


Example:









void findreacquireproximatepath( int )

Summary:


Finds a path to a point that can see the enemy without leaving goal. Call ReacquireMove to use the path.


Example:









void flagenemyunattackable()

Summary:


Set this actor not to attack its current enemy.


Example:









void clearpitchorient()

Summary:


Clear pitch orientation


Example:









void setpitchorient()

Summary:





Example:









void setlookatanimnodes( anim, anim, anim )

Summary:


Set the animation nodes for this actor for looking at things to the left and right.


Example:









void setlookat( vector, float )

Summary:


Set the actor to exit the prone position.


Example:









void setlookatyawlimits( float, float, float )

Summary:


Set the limits of what this actor can look at.


Example:









void stoplookat( float )

Summary:


Make this actor stop looking at its current look at target.


Example:









bool cansee( entity, int )

Summary:


Check to see if the actor can see the given entity.


Example:









bool seerecently( entity, float )

Summary:





Example:









int lastknowntime( entity )

Summary:





Example:









vector lastknownpos( entity )

Summary:





Example:









int maymovetopoint( vector, int )

Summary:


Check whether the actor can move to a given point.


Example:









int maymovefrompointtopoint( vector, vector, int )

Summary:


Check whether the actor can move from a given point to a given point. Does not check friendly fire and in goal radius unlike maymovetopoint


Example:









int teleport( vector, vector )

Summary:


Teleport the actor to a new position with the given origin and angles.


Example:









float withinapproxpathdist( float )

Summary:


Check whether the actor is within an approximate distance to his path


Example:









int ispathdirect()

Summary:


Check whether the actor's current path is direct


Example:









void allowedstances( conststring, conststring, conststring )

Summary:


Sets the list of the actor's allowed stances.


Example:









int isstanceallowed( conststring )

Summary:


Checks whether this actor can go to the given stance.


Example:









void traversemode( conststring )

Summary:


Set the traverse mode of this actor.


Example:









void animmode( conststring, int )

Summary:


Set the way that animation deltas are interpreted by the game engine


Example:









void orientmode( conststring, vector, int )

Summary:


Set the orient mode of this actor.


Example:









conststring getorientmode( string )

Summary:





Example:









float getmotionangle()

Summary:


Get the motion angle in degrees for this actor.


Example:









bool shouldfacemotion()

Summary:





Example:









void clearmovehistory()

Summary:





Example:









vector getmovehistoryaverage()

Summary:





Example:









vector getanglestolikelyenemypath()

Summary:


Get the angles towards the direction an enemy is most likely to appear. Returns undefined if a good guess can't be made.


Example:









void lerpposition( vector, vector )

Summary:


Interpolate an actor's position, and angles.


Example:









void predictoriginandangles()

Summary:


Use physics to predict the actor's origin and angles


Example:









void predictanim()

Summary:





Example:









void gethitenttype()

Summary:


Get the type of entity that the actor has hit. Can be 'hit', 'obstacle' or 'world'.


Example:









float gethityaw()

Summary:


Get the direction in degrees that the player has hit an obstacle at. Returns an error if nothing was hit.


Example:









void getgroundenttype()

Summary:


Get the entity type of the 'ground' that the actor is on.


Example:









int isdeflected()

Summary:


Check if the actor has been deflected.


Example:









void animcustom( func, func )

Summary:


Sets the anim script for this actor.


Example:









int canattackenemynode()

Summary:


Checks if this actor can attack its enemies node.


Example:









int getpathlength()

Summary:





Example:









int calcpathlength( vector )

Summary:





Example:









pathnode getnegotiationstartnode()

Summary:


Gets the next negotiation node for this actor


Example:









pathnode getnegotiationendnode()

Summary:


Gets the end negotiation node for this actor


Example:









int canseepathgoal()

Summary:





Example:









bool checkprone( vector, float, int )

Summary:


Returns true when a character can go prone at the specified position. Specifically setup for use by AI characters.


Example:









void pushplayer( int )

Summary:


Set whether this character can push the player


Example:









void setgoalnode( pathnode )

Summary:


Set this actor's goal node.


Example:









void setgoalpos( vector, vector )

Summary:


Set this actor's goal position.


Example:









void setgoalentity( entity )

Summary:





Example:









void setgoalvolume( entity )

Summary:


Set this actor's goal volume.  This cannot be set if a goal entity is set.


Example:









void setgoalvolumeauto( entity )

Summary:





Example:









entity getgoalvolume()

Summary:


Get this actor's goal volume.


Example:









void cleargoalvolume()

Summary:


Clears this actor's goal volume.


Example:









void setfixednodesafevolume( entity )

Summary:


Set this actor's fixed node safe volume.


Example:









entity getfixednodesafevolume()

Summary:


Get this actor's fixed node safe volume.


Example:









void clearfixednodesafevolume()

Summary:


Clears this actor's fixed node safe volume.


Example:









bool isingoal( vector )

Summary:


Determine whether a given point is in the actor's current goal area


Example:









void setruntopos( vector )

Summary:


Override where the actor should run to.  This overrides the goal pos and the claimed node.


Example:









void clearruntopos()

Summary:





Example:









bool nearnode( pathnode )

Summary:


Determine whether this actor is near to a given path node.


Example:









bool nearclaimnode()

Summary:





Example:









bool nearclaimnodeandangle()

Summary:





Example:









bool atdangerousnode()

Summary:





Example:









void getenemyinfo( entity )

Summary:





Example:









void clearenemy()

Summary:


Clear the actor's current enemy entity.


Example:









void setentitytarget( entity, float )

Summary:


Set an entity as the AI's target. This is for special cases only. Do not set AI or player targets with this.


Example:









void clearentitytarget()

Summary:


Clears an AI's entity target.


Example:









void setpotentialthreat( float )

Summary:


In non-combat situations.  This is mostly useful for friendlies.


Example:









void clearpotentialthreat()

Summary:


Clear the potential threat direction.  See SetPotentialThreat for more info on potential threats


Example:









void getperfectinfo( entity )

Summary:





Example:









void setflashbangimmunity( int )

Summary:


Sets whether an actor is succeptable to flashbangs.


Example:









void setflashbanged( int )

Summary:


Sets whether an actor is under a flashbang effect.


Example:









float getflashbangedstrength()

Summary:


Retrieves how strongly the actor was initially hit by a flashbang.  1.0 is full strength, 0.0 is none at all.


Example:









int isknownenemyinradius( vector, float )

Summary:


Checks if there is a known enemy in a radius for an AI.


Example:









int isknownenemyinvolume( entity )

Summary:


Checks if there is a known enemy in a volume for an AI.


Example:









void settalktospecies( conststring )

Summary:


Sets the species this AI can share enemy information with.


Example:









void allowpitchangle( int )

Summary:





Example:









void knockback( int )

Summary:





Example:









float getdeltaturnyaw()

Summary:





Example:









entity finishactordamage( entity, entity, int, string, vector, vector, conststring, int, int )

Summary:





Example:









array calclookaheadpos( vector, int )

Summary:





Example:









void setengagementmindist()

Summary:


Sets the min engagement distances used when selecting cover nodes.


Example:









void setengagementmaxdist()

Summary:


Sets the max engagement distances used when selecting cover nodes.


Example:









bool isinscriptedstate()

Summary:





Example:









entity meleewithoffset( vector )

Summary:





Example:









int forceteleport( vector, vector )

Summary:





Example:









void setentityowner( entity )

Summary:





Example:









void clearentityowner()

Summary:





Example:









void setanimstate( conststring, int )

Summary:





Example:









void setaimanimweights( float, float )

Summary:





Example:









void startscriptedanim()

Summary:


Runs an animscript on an actor.


Example:









void popaistate()

Summary:





Example:









int setanimstatefromasd( conststring, conststring, int )

Summary:





Example:









bool hasanimstatefromasd( conststring )

Summary:





Example:









conststring getanimstatefromasd()

Summary:





Example:









int getanimsubstatefromasd( conststring, conststring )

Summary:





Example:









int getanimsubstatecountfromasd( conststring )

Summary:





Example:









anim getanimfromasd( conststring, animsindex, animsindex, int )

Summary:





Example:









float getanimlengthfromasd( conststring, int )

Summary:





Example:









bool getanimhasnotetrackfromasd( conststring, int, conststring )

Summary:





Example:









void setfreecameralockonallowed( int )

Summary:





Example:










Builtin Common Methods






Prototype

Description




void forceyellowdot( int )

Summary:





Example:









void disableyellowdot( int )

Summary:





Example:









void allowcamerarotation( int )

Summary:





Example:









bool reloadonnunchuk()

Summary:





Example:









bool reloadonwiiumote()

Summary:





Example:









void attach( string, constlowercasestring, int )

Summary:


Attach a model to an entity.


Example:









void detach( string, constlowercasestring )

Summary:


Detaches an attached model from an entity.


Example:









void detachall()

Summary:


detaches all attached models from an entity


Example:









int getattachsize()

Summary:


Returns the number of attached models for this entity.


Example:









conststring getattachmodelname( int )

Summary:


Returns the name of the attached model at the given attachment slot


Example:









conststring getattachtagname( int )

Summary:


Returns the tagname of the attached model at the given attachment slot


Example:









bool getattachignorecollision( int )

Summary:


Returns the ignore collision flag of the attached model at the given attachment slot


Example:









void hidepart( constlowercasestring, string )

Summary:


Hide part of an entity.


Example:









void runscriptonent()

Summary:





Example:









void sendaiscriptvals( string, string )

Summary:





Example:









void showpart( constlowercasestring, string )

Summary:


Show part of an entity.


Example:









void showallparts()

Summary:


Show all parts of an entity.


Example:









void playsoundtoplayer( string )

Summary:


Play the sound alias as if coming from the entity, so that only one player can hear it


Example:









vector getlightcolor()

Summary:


Gets the current color of the light, as an RGB vector.


Example:









void setlightcolor( vector )

Summary:


Sets the current color of the light, as an RGB vector.


Example:









float getlightintensity()

Summary:


Gets the current intensity of the light.


Example:









void setlightintensity( float )

Summary:


Sets the current intensity of the light.


Example:









float getlightradius()

Summary:


Gets the current radius of the light.


Example:









void setlightradius( float )

Summary:


Sets the current radius of the light.


Example:









float getlightfovinner()

Summary:


Gets the current inner fov of a spot light.


Example:









float getlightfovouter()

Summary:


Gets the current outer fov of a spot light.


Example:









void setlightfovrange( float, float )

Summary:


Sets the current radius of the light.


Example:









int getlightexponent()

Summary:


Gets the current exponent of the light.


Example:









void setlightexponent( int )

Summary:


Sets the current exponent of the light.


Example:









bool areallmissionsatscore( int )

Summary:





Example:









void isstartingclassdefault()

Summary:





Example:









void isstartingclasseraappropriate()

Summary:





Example:









int getnumchallengescomplete( string )

Summary:





Example:









bool hascompletedallgamechallenges()

Summary:





Example:









void hasallintel()

Summary:





Example:









string getdstat()

Summary:





Example:









int getdstatarraycount()

Summary:





Example:









void setdstat( string, string, int, int, float, float )

Summary:





Example:









void adddstat()

Summary:





Example:









void addweaponstat( string, string, int )

Summary:


Adds to a weapon's statistic. The first parameter is the weapon name, the second one the challenge category and the last one the increment.


Example:




player addWeaponStat("flash_grenade_mp", "used", 1);





void addbonuscardstat( int, string, int )

Summary:





Example:









void getsessstat()

Summary:





Example:









void getsessstatarraycount()

Summary:





Example:









void setsessstat()

Summary:





Example:









void addsessstat()

Summary:





Example:









void addplayerstat( string )

Summary:





Example:









void addplayerstatwithgametype()

Summary:





Example:









void addgametypestat()

Summary:





Example:









void trackweaponfirenative( string, int, int, int )

Summary:





Example:









void updatestatratio( string, string, string )

Summary:





Example:









int addrankxp( string, int )

Summary:





Example:









void addrankxpvalue(string, int)

Summary:


Gives the player rank experience. The first parameter is the event type and the second one the experience reward.


Example:




player addRankXPValue("contract", 60000);





bool hasseasonpass()

Summary:





Example:









void setempjammed( int )

Summary:





Example:









bool isempjammed()

Summary:





Example:









void setspawnerteam( team )

Summary:


Set the team for this spawner


Example:









void luinotifyevent()

Summary:





Example:









void launch( vector, vector )

Summary:


Launch an object that interacts with the world, using an initial velocity. From this point on this object will no longer block either missiles or bullets.


Example:









void setmovingplatformenabled( int )

Summary:





Example:









bool ismovingplatform()

Summary:





Example:









void setviewmodelrenderflag( int )

Summary:





Example:









void setdrawinfrared( int )

Summary:





Example:









void setgpr()

Summary:





Example:









void gamehistorystartmatch( int )

Summary:





Example:









void gamehistoryfinishmatch( int, int, int, int, int, float )

Summary:





Example:









void unlink()

Summary:


Unlinks a linked entity from another entity


Example:









void linkto()

Summary:


Attaches one entity to another


Example:









void linktoblendtotag()

Summary:





Example:









void enablelinkto()

Summary:


enables linkto for an entity


Example:









void linktoupdateoffset( vector, vector )

Summary:





Example:









void playerlinkto()

Summary:


Attaches the player to an entity.  Any entity rotation is added to the player's view, allow the player to look around.  Rotating the parent entity/tag will not move the player's eye position, but only the player's view angles.  Thus, the player's eye position is locked in place, always directly above the parent tag.


Example:









void playerlinktoblend( entity, constlowercasestring, float, float, float, float, float, float )

Summary:





Example:









void playerlinktodelta()

Summary:


Attaches the player to an entity.  Any entity rotation is added to the player's view, allow the player to look around.  The player's eye position will remain fixed relative to the parent entity/tag.  Thus, pitching and rolling will cause the player's eye position to move. (But the player entity always remains vertical)


Example:









void playerlinkweaponviewtodelta()

Summary:





Example:









void playerlinktoabsolute( entity, constlowercasestring )

Summary:


Attaches the player to an entity.  No view movement is allowed.    The player's eye position will remain fixed relative to the parent entity/tag.  Thus, pitching and rolling will cause the player's eye position to move. (But the player entity always remains vertical)


Example:









void playercamlinkto( entity, string )

Summary:





Example:









void playercamunlink()

Summary:





Example:









void lerpviewangleclamp( float, float, float, float, float, float, float )

Summary:





Example:









void setviewangleresistance()

Summary:





Example:









void playerlinkedoffsetenable()

Summary:





Example:









void playerlinkedoffsetdisable()

Summary:





Example:









void playerlinkedsetusebaseangleforviewclamp( int )

Summary:





Example:









void dontinterpolate()

Summary:


pop the entity's position instantaneously to where it moves this time step, rather than smoothly moving there from the previous position


Example:









entity magicgrenadetype( string, vector, vector, float )

Summary:





Example:









void startfadingblur( float, float )

Summary:





Example:









vector localtoworldcoords( vector )

Summary:


Transform the given local coordinate point to a world coordinate point


Example:









vector worldtolocalcoords( vector )

Summary:





Example:









void setturretspinning( int )

Summary:





Example:









void attachshieldmodel()

Summary:





Example:









void detachshieldmodel()

Summary:





Example:









void setscriptmoverflag( int )

Summary:





Example:









void refreshshieldattachment()

Summary:





Example:









void setcharacterindex( int )

Summary:





Example:









void useplayerfootsteptable()

Summary:





Example:









void setvisionsetforplayer( string, float )

Summary:





Example:









void useservervisionset( int )

Summary:





Example:









void setinfraredvision( int )

Summary:





Example:









string getcontrollertype()

Summary:





Example:









void setactorweapon( string, int )

Summary:





Example:









void resetfov()

Summary:





Example:










Builtin Methods






Prototype

Description




void setstowedweapon( string )

Summary:





Example:









string getstowedweapon()

Summary:





Example:









void clearstowedweapon()

Summary:





Example:









int getammocount( string )

Summary:


Get the remaining ammo


Example:









void setvisibletoplayer( entity )

Summary:





Example:









void setinvisibletoplayer( entity, int )

Summary:





Example:









void setvisibletoall()

Summary:





Example:









void setinvisibletoall()

Summary:





Example:









void setvisibletoteam( team )

Summary:





Example:









void setvisibletoallexceptteam( team )

Summary:





Example:









void setforcenocull()

Summary:





Example:









void removeforcenocull()

Summary:





Example:









int islinkedto( entity )

Summary:





Example:









void allowtacticalinsertion( int )

Summary:





Example:









void allowbottargetting( int )

Summary:





Example:









entity getlinkedent()

Summary:





Example:









vector getorigin()

Summary:


Gets the origin of an entity


Example:









vector getangles()

Summary:





Example:









vector getmins()

Summary:





Example:









vector getmaxs()

Summary:





Example:









vector getabsmins()

Summary:





Example:









vector getabsmaxs()

Summary:





Example:









vector getpointinbounds( float, float, float )

Summary:





Example:









vector geteye()

Summary:


Gets the position of the eye for an AI or Player


Example:









vector geteyeapprox()

Summary:





Example:









entity useby( entity )

Summary:


Uses the entity with the passed in entity as the activator


Example:









void setstablemissile( int )

Summary:


This entity will shoot missiles that do not destabilize. Only applicable to vehicles, players and AI


Example:









int istouching( entity, vector )

Summary:





Example:









int istouchingswept( entity, float, float )

Summary:





Example:









int istouchingvolume( vector, vector, vector )

Summary:





Example:









void playsound( string )

Summary:


Play's the specified sound which can be heard by other nearby players as well


Example:




player playsound("zmb_cha_ching");





void playsoundwithnotify( string, conststring )

Summary:





Example:









void playsoundontag( string, string )

Summary:





Example:









void playsoundasmaster( string )

Summary:


Play the sound alias as if coming from the entity, as a master sound


Example:









void playsoundtoteam( string, entity )

Summary:


Play the sound alias as if coming from the entity, so that only one team can hear it


Example:









void playbattlechattertoteam( string, string, team, entity )

Summary:





Example:









void playsoundtoplayer( string )

Summary:


Play the sound alias as if coming from the entity, so that only one player can hear it


Example:









void playloopsound( string, float )

Summary:


Play a sound as a loop


Example:









void stoploopsound( float )

Summary:


Stop a looping sound


Example:









void stopsounds()

Summary:


Stop all sounds on an entity.  *WARNING*, You must have a wait between StopSounds() and delete() or the sound will not stop.


Example:









void playrumbleonentity()

Summary:


Plays a rumble on the given entity.


Example:









void playrumblelooponentity()

Summary:


Plays a looping controller rumble on the given player.


Example:









void stoprumble( string )

Summary:


Quits the playing of a particular rumble on a player.


Example:









void delete()

Summary:


Removes an entity from the game in the same manner as a trigger_kill"


Example:









void setmodel( string )

Summary:


Changes an entity's appearance


Example:




player setmodel("german_shepherd_vest");





void setzombieshrink( int )

Summary:





Example:









void setenemymodel( string )

Summary:





Example:









void dodamage( float, vector, entity, entity )

Summary:


Does damage to this entity


Example:









float getnormalhealth()

Summary:


Gets the normal health of this entity


Example:









void setnormalhealth( float )

Summary:


Sets the normal health of this entity


Example:









void setmaxhealth( int )

Summary:





Example:









void show()

Summary:


Turns the player visible (default)


Example:




player show();





void hide()

Summary:


Turns the player invisible


Example:




player hide();





void ghost()

Summary:





Example:









void ghostindemo()

Summary:





Example:









void showindemo()

Summary:





Example:









void laseron()

Summary:


Turns on entity's laser sight.


Example:









void laseroff()

Summary:


Turns off entity's laser sight.


Example:









void showtoplayer( entity )

Summary:


Show the entity to a given client


Example:









int setcontents( int )

Summary:


Sets the contents of an entity. Returns the old contents.


Example:









void startfiring()

Summary:


Starts a turret firing


Example:









void stopfiring()

Summary:


Stops a turret firing


Example:









void shootturret()

Summary:


Shoots a turret


Example:









void stopshootturret()

Summary:





Example:









void setmode( conststring )

Summary:


Set the mode of a turret.


Example:









entity getturretowner()

Summary:


Gets the "owner" of this turret


Example:









void settargetentity( entity )

Summary:


Sets the target of this turret


Example:









array getturretarclimits()

Summary:





Example:









void setplayerspread( float )

Summary:


Sets the spread of this turret when used by the player


Example:









void setaispread( float )

Summary:


Sets the spread of this turret when used by an AI


Example:









void setconvergencetime( float )

Summary:


Sets the time that a turret takes to converge to its target, on either the pitch or yay planes.


Example:









void setsuppressiontime( float )

Summary:


Sets the time that a turret uses supressing fire after losing sight of an enemy


Example:









void cleartargetentity()

Summary:


Clears the current target for this turret.


Example:









void setturretteam( team )

Summary:


Sets the team of a turret


Example:









void maketurretusable()

Summary:


Sets a turret able to be used


Example:









void maketurretunusable()

Summary:


Sets a turret to be unable to be used


Example:









void setturretaccuracy()

Summary:





Example:









void setturretignoregoals( int )

Summary:


Sets the ignoreGoals flag for the turret.


Example:









entity getturrettarget()

Summary:


Gets the current target of this turret


Example:









void disconnectpaths()

Summary:


Disconnects the paths that intersect with the entity. If the entity is a script_brushmodel then it must have DYNAMICPATH set to disconnect paths.


Example:









void connectpaths()

Summary:


Connects the paths that intersect with the entity. If the entity is a script_brushmodel then it must have DYNAMICPATH set to connect paths.


Example:









conststring getstance()

Summary:


Returns the current stance by the player. The returned value is either prone, stand or crouch


Example:




currentstance = player getstance();





void setstance( conststring )

Summary:


Changes the stance for a specific player. Possible values are prone, stand and crouch


Example:




player setstance("prone");





void setcursorhint( string, entity )

Summary:


Sets a visible cursor near to an objective


Example:









void setrevivehintstring( string, team )

Summary:





Example:









void sethintstringforperk( string, string )

Summary:





Example:









void sethintstring( string )

Summary:


Sets the hint string for a usable entity


Example:









void setfovforkillcam( int )

Summary:





Example:









void sethintlowpriority( int )

Summary:





Example:









void usetriggerrequirelookat()

Summary:


Modifies the use trigger so that it requires the user to be looking at it


Example:









void triggerignoreteam()

Summary:





Example:









void shellshock( string, float, int )

Summary:


Start a shell shock sequence for the player. The shell shock must be precached, otherwise calling this script will cause a script error.


Example:









vector getweaponforwarddir()

Summary:





Example:









vector getweaponmuzzlepoint()

Summary:





Example:









vector gettagorigin( constlowercasestring )

Summary:


Gets the origin of a particular tag on this model


Example:









vector gettagangles( constlowercasestring )

Summary:


Gets the angles of a particular tag on this model


Example:









void getentnum()

Summary:


Get the entity number for this entity


Example:









void stopshellshock()

Summary:


Stop a shell shock sequence for the player


Example:









void setdepthoffield( float, float, float, float, float, float )

Summary:


Set the depth of field values for a player.  If start >= end for near or far, depth of field is disabled for that region.


Example:









void setburn( float )

Summary:





Example:









void setelectrified( float )

Summary:





Example:









void spawnnapalmgroundflame( vector, string, vector, int )

Summary:





Example:









void needsrevive( int )

Summary:





Example:









bool isinsecondchance()

Summary:





Example:









float depthinwater()

Summary:





Example:









void shootup( float )

Summary:





Example:









int depthofplayerinwater()

Summary:





Example:









void useweaponhidetags( string )

Summary:





Example:









void useweaponmodel( string, string, int )

Summary:





Example:









void starttanning()

Summary:





Example:









void stopburning()

Summary:





Example:









void setwaterdrops( int )

Summary:





Example:









void restoredefaultdroppitch()

Summary:


Use this if you move a turret and need to reconfigure.


Example:









bool isfiringturret()

Summary:


Checks whether this turret is firing. The entity must be a turret


Example:









bool isturretlockedon()

Summary:





Example:









void setviewmodeldepthoffield( float, float )

Summary:


Set the depth of field values for the player's viewmodel when at hip.  If start >= end, depth of field is disabled.


Example:









void viewkick( float, vector )

Summary:


Damage the player, and throw the screen around


Example:









vector localtoworldcoords( vector )

Summary:


Transform the given local coordinate point to a world coordinate point


Example:









void setrightarc( float )

Summary:


Set the amount that the turret can move to the right


Example:









void setleftarc( float )

Summary:


Set the amount that the turret can move to the left


Example:









void settoparc( float )

Summary:


Set the amount that the turret can pivot up


Example:









void setbottomarc( float )

Summary:


Set the amount that the turret can pivot down


Example:









void radiusdamage()

Summary:


Does damage to all damageable objects within a given radius. The amount of damage is linear according to how close the object is to the radius. See also Entity/radiusdamage to specify an entity the damage is coming from.


Example:









void detonate( entity )

Summary:


Causes a grenade to explode. Must be called on a grenade.


Example:









void damageconetrace()

Summary:


Determines how much the entity can be damaged from the given position, using the same check that is used by grenades. Performs multiple damage traces and returns an approximation to how much of the entity is damageable from the given point (between 0 and 1). In SinglePlayer this will always be 1 if the entity is partially damageable.


Example:









void sightconetrace()

Summary:


Determines how much the entity can be seen from the given position, using the same check that is used by grenades. Performs multiple sight traces and returns an approximation to how much of the entity is visible from the given point (between 0 and 1). In SinglePlayer this will always be 1 if the entity is partially visible.


Example:









int heliturretsighttrace( vector, entity, int )

Summary:





Example:









int heliturretdogtrace( vector, entity, int )

Summary:





Example:









int playersighttrace( vector, int, int )

Summary:





Example:









void visionsetlerpratio( float )

Summary:





Example:









float docowardswayanims()

Summary:





Example:









void startpoisoning()

Summary:





Example:









void stoppoisoning()

Summary:





Example:









void startbinocs()

Summary:





Example:









void stopbinocs()

Summary:





Example:









bool isflared()

Summary:





Example:









bool ispoisoned()

Summary:





Example:









void setcameraspikeactive( int )

Summary:





Example:









int isinsideheightlock()

Summary:





Example:









int ismissileinsideheightlock()

Summary:





Example:









int isonground( int )

Summary:


Returns true if the player is on the ground.


Example:









entity getgroundent()

Summary:





Example:









entity getmoverent()

Summary:





Example:









int issprinting()

Summary:





Example:









void setanim()

Summary:


"Restart": These functions cause the animation to restart. If they had been previously playing, without this they would continue from their current time.


Example:









void useanimtree( animtree )

Summary:


Set the animation tree of an entity


Example:









void animscripted()

Summary:


Runs an animscript on an entity.


Example:









void animscriptedskiprestart()

Summary:





Example:









void animrelative()

Summary:


Runs an animscript on an entity.


Example:









void stopanimscripted()

Summary:


Halts animscript on this entity.


Example:









void clearanim( anim, float )

Summary:


Sets an animation's goal weight (and the goal weights of all of its descendents) to zero over the specified time.


Example:









void setentityanimrate( float )

Summary:





Example:









float getentityanimrate()

Summary:





Example:









vector getcentroid()

Summary:


Gets the centroid of an entity


Example:









bool ismartyrdomgrenade()

Summary:





Example:









int getentitynumber()

Summary:


Get the entity number of this entity


Example:









int getentitytype()

Summary:





Example:









void enablegrenadetouchdamage()

Summary:


enable grenade damage for damage triggers


Example:









void disablegrenadetouchdamage()

Summary:


Disable grenade damage for damage triggers


Example:









void enableaimassist()

Summary:


Enables aim assist on an entity.  The entity must have a brush model


Example:









void disableaimassist()

Summary:


Disables aim assist on an entity.  The entity must have a brush model


Example:









void placespawnpoint()

Summary:


Raises the spawn point up to make sure it's not in the ground, then drops it back down into the ground.


Example:









void setspawnclientflag( string )

Summary:





Example:









void directionalhitindicator( int, int )

Summary:





Example:









void sendkillstreakdamageevent( int )

Summary:





Example:









void setplayergravity( int )

Summary:





Example:









void clearplayergravity()

Summary:





Example:









void sendfaceevent( conststring )

Summary:





Example:









void setteamfortrigger( team )

Summary:


Set the team that this trigger will react to


Example:









void setexcludeteamfortrigger( team )

Summary:





Example:









void setperkfortrigger( string )

Summary:





Example:









void setignoreentfortrigger( entity )

Summary:





Example:









void clientclaimtrigger( entity )

Summary:


Claim a single user trigger.


Example:









void clientreleasetrigger( entity )

Summary:


Release a single user trigger.


Example:









void releaseclaimedtrigger()

Summary:


Release a currently claimed trigger


Example:









int isitemlocked( int )

Summary:





Example:









int isitempurchased( int )

Summary:





Example:









void uploadleaderboards()

Summary:





Example:









void setnemesisxuid( string )

Summary:





Example:









int getloadoutitem()

Summary:





Example:









int isbonuscardactive( int, int )

Summary:





Example:









string getloadoutitemref()

Summary:





Example:









string getloadoutweapon( int, string )

Summary:





Example:









array getloadoutperks( int )

Summary:





Example:









int getloadoutallocation( int )

Summary:





Example:









void setmovespeedscale( float )

Summary:


Sets the multiplier for the player's movement speed


Example:




player setmovespeedscale(2);





float getmovespeedscale()

Summary:





Example:









void logstring()

Summary:





Example:









void missile_settarget( entity, vector )

Summary:


Sets the target entity for a guided missile


Example:









void missile_dronesetvisible( int )

Summary:





Example:









bool isonladder()

Summary:


Return true if the player is on a ladder, false otherwise.


Example:









bool ismantling()

Summary:


Return true if the player is mantling, false otherwise.


Example:









bool isonslide()

Summary:





Example:









void startdoorbreach()

Summary:





Example:









void stopdoorbreach()

Summary:





Example:









void startragdoll( int )

Summary:


Begin ragdoll physics for this entity.  Does nothing if the entity is already a ragdoll.


Example:









int isragdoll()

Summary:


Return true if the entity is a ragdoll body, false otherwise.


Example:









void launchragdoll( vector, constlowercasestring )

Summary:





Example:









void launchvehicle( vector, vector )

Summary:





Example:









void setblur( float, float )

Summary:


Blur the screen over a period of time.


Example:









void resetmissiledetonationtime( float )

Summary:





Example:









void giveachievement()

Summary:





Example:









void setzombiename( string )

Summary:





Example:









void setentgravitytrajectory( int )

Summary:





Example:









void setvehicleteam( team )

Summary:


Set which team a vehicle is on.


Example:









void setteam( team )

Summary:





Example:









team getteam()

Summary:





Example:









void setowner( entity )

Summary:





Example:









void setmissileowner( entity )

Summary:





Example:









void setentityweapon( string )

Summary:





Example:









void setturretowner( entity )

Summary:





Example:









void setturrettype( string )

Summary:





Example:









anim getcorpseanim( animsindex )

Summary:





Example:









void itemweaponsetammo( int, int, int )

Summary:


Sets the ammo ammount for a weapon item entity (lying on the ground)


Example:









void setturretcarried( int )

Summary:





Example:









void setturretminimapvisible( int )

Summary:





Example:









void setmissilecoasting( int )

Summary:





Example:









void setweapon( string )

Summary:





Example:









void gib( conststring, object )

Summary:





Example:









void setphysparams( float, float, float )

Summary:





Example:









void setplayercollision( int )

Summary:





Example:









void reportuser( string )

Summary:





Example:









void setplayercurrentobjective()

Summary:





Example:









void setplayercurrentstreak( int )

Summary:





Example:









vector getvelocity()

Summary:


Gets the player's velocity


Example:









entity spawnactor( int, conststring )

Summary:





Example:









vector getshootatpos()

Summary:


Gets the position an attacker would shoot at to hit this entity.For AI or player this is the eye position.For other entities it's the tag_eye if there is one else the center of the entity bounding box.


Example:









void predictspawnpoint( vector, vector )

Summary:





Example:









void setdefaultdroppitch( float )

Summary:


Set the default drop pitch that the turret attempts to return to when it is not in use.


Example:









void setscanningpitch( float )

Summary:





Example:









entity launchbomb( string, vector, vector )

Summary:





Example:









entity magicgrenade( string, vector, vector )

Summary:


Creates a "Magic" grenade from an actor.


Example:









void makegrenadedud()

Summary:





Example:









void setclientflag( int )

Summary:





Example:









int getclientflag( int )

Summary:





Example:









void clearclientflag( int )

Summary:





Example:









void setscriptmoverflag( int )

Summary:





Example:









void setmovingplatformenabled()

Summary:





Example:









void fakefire( entity, vector, string, int )

Summary:





Example:









void makeusable( team )

Summary:





Example:









void makeunusable()

Summary:





Example:









vector predictgrenade()

Summary:





Example:









void setdangerous( team, int )

Summary:





Example:









bool isdangerous( team )

Summary:





Example:









void getindexforactivecontract()

Summary:





Example:









void getactivecontractprogress()

Summary:





Example:









void incrementactivecontractprogress()

Summary:





Example:









void incrementactivecontracttime()

Summary:





Example:









void isactivecontractcomplete()

Summary:





Example:









void hasactivecontractexpired()

Summary:





Example:









void getactivecontracttimepassed()

Summary:





Example:









void resetactivecontractprogress()

Summary:





Example:









void getpregameclass()

Summary:





Example:









void getpregameteam()

Summary:





Example:









void setpregameclass()

Summary:





Example:









void setpregameteam()

Summary:





Example:









void recordleaguepreloser()

Summary:





Example:









void luinotifyeventtospectators()

Summary:





Example:









bool istestclient()

Summary:





Example:









void setworldfogactivebank( int )

Summary:





Example:









bool iszbarrier()

Summary:





Example:









int getnumzbarrierpieces()

Summary:





Example:









conststring getzbarrierpiecestate( int )

Summary:





Example:









void setzbarrierpiecestate( int, constlowercasestring, float )

Summary:





Example:









bool iszbarrieropen()

Summary:





Example:









bool iszbarrierclosed()

Summary:





Example:









void hidezbarrierpiece( int )

Summary:





Example:









void showzbarrierpiece( int )

Summary:





Example:









void zbarrierpieceusedefaultmodel( int )

Summary:





Example:









void zbarrierpieceusealternatemodel( int )

Summary:





Example:









void zbarrierpieceuseupgradedmodel( int )

Summary:





Example:









void zbarrierpieceuseboxriselogic( int )

Summary:





Example:









int getupgradedpiecenumlives( int )

Summary:





Example:









array getzbarrierpieceindicesinstate( constlowercasestring )

Summary:





Example:









float getzbarrierpieceanimlengthforstate( int, constlowercasestring, float )

Summary:





Example:









conststring getzbarrierpieceanimstate( int )

Summary:





Example:









conststring getzbarrierpieceanimsubstate( int )

Summary:





Example:









int zbarriersupportszombietaunts()

Summary:





Example:









int zbarriersupportszombiereachthroughattacks()

Summary:





Example:









conststring getzbarriertauntanimstate()

Summary:





Example:









conststring getzbarrierreachthroughattackanimstate()

Summary:





Example:









int getzbarriernumattackslots()

Summary:





Example:









float getzbarrierattackslothorzoffset()

Summary:





Example:









void setzbarriercolmodel( string )

Summary:





Example:









string getweaponoptic( string )

Summary:





Example:









void setaltusetrigger()

Summary:





Example:









bool isaltusetrigger()

Summary:





Example:
















Retrieved from "https://codresearch.dev/index.php?title=Game_Script_Methods_(BO2)&oldid=1026"