{"api":[{"name":"ActivateClientExploder","description":"Activates a client-side exploder.","remarks":["This is sent as a reliable command and will not work with killcam or demos."],"example":"ActivateClientExploder( 101 )","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":null,"parameters":[{"name":"exploderId","description":"ID of exploder to activate.","type":{"dataType":"int","isArray":false},"mandatory":true}],"returns":{"void":true}}]},{"name":"ActivateClientRadiantExploder","description":"Activates a client side radiant exploder","example":"ActivateClientRadiantExploder( \"light_switch\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"string id of exploder to activate","mandatory":true}]}]},{"name":"ActorIKEnabled","description":"Determines whether this actor can use IK functions. Returns true if IK is available, otherwise false.","example":"if (guy ActorIKEnabled()) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"AddBonusCardStat","description":"Sets the indicated stat for that bonus card","example":"self AddBonusCardStat( BONUSCARD_OVERKILL, \"kills\", 1, self.class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bonuscard","description":"Bonus Card define from _bonuscards.gsh","mandatory":true},{"name":"statname","description":"The name of the stat you wish to set","mandatory":true},{"name":"statincrease","description":"The amount you would like to increase the stat","mandatory":true},{"name":"currentclassnum","description":"The loadout the player is using","mandatory":true}]}]},{"name":"AddDemoBookmark","description":"adds the information to the demo bookmarking system","example":"AddDemoBookmark( bookmark_string, gettime(), self GetEntityNumber(), 255, 0, inflictorEntNum, inflictorEntType, inflictorBirthTime, false, self.grenade_multiattack_ent GetEntityNumber() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"type","description":"the type of bookmark","mandatory":true},{"name":"time","description":"the time of recording the bookmark","mandatory":true},{"name":"client1","description":"the client related to the bookmark","mandatory":true},{"name":"client2","description":"other client which is associated with the bookmark","mandatory":true},{},{"name":"entityNumber","description":"The entity number","mandatory":true},{"name":"eType","description":"Entity type","mandatory":true},{"name":"birthTime","description":"Birth Time","mandatory":true},{"name":"overrideEntityCamera","description":"Whether to override Entity Camera","mandatory":true},{}]}]},{"name":"AddEntityInfluencer","description":"Adds a new influencer of attached to ","example":"influencer_id = AddEntityInfluencer( name, player, allies_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true},{"name":"entity","description":"Attached to entity. Goes away when entity is deleted. Unless a time is set.","mandatory":true},{"name":"team mask","description":"teams that this influencer will affect","mandatory":true}]}]},{"name":"AddInfluencer","description":"Adds a new influencer of at ","example":"influencer_id = AddInfluencer( name, origin, allies_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true},{"name":"origin","description":"center point of the influencer","mandatory":true},{"name":"team mask","description":"teams that this influencer will affect","mandatory":true}]}]},{"name":"AddOrientedInfluencer","description":"Adds a new influencer of at and ","example":"influencer_id = AddOrientedInfluencer( name, origin, angles, allies_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true},{"name":"origin","description":"center point of the influencer","mandatory":true},{"name":"angles","description":"angles of entity","mandatory":true},{"name":"team mask","description":"teams that this influencer will affect","mandatory":true}]}]},{"name":"AddSpawnPoints","description":"Adds spawnpoints to the spawn system","example":"AddSpawnPoints( \"allies\", \"mp_tdm_spawn\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The team","mandatory":true},{}]}]},{"name":"AddTestClient","description":"Adds a test client (bot) to the map and returns a reference to that client.","example":"ent[i] = AddTestClient()","flags":["verified"],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[],"returns":{"name":"client","description":"Reference to the test client.","type":{"dataType":"struct","instanceType":"player"}}}]},{"name":"AddToInterestPool","description":"Add a script event to the sentient's interest pool.","example":"point = self AddToInterestPool( 500, 10, 5, ai.origin, ai )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"Amount the event adds to the pool. (integer)","mandatory":true},{"name":"priority","description":"How important is the event. (integer)","mandatory":true},{"name":"lifespan","description":"Time the event stays in the pool. (float)","mandatory":true},{"name":"point of interest","description":"Position the AI will investigate. (vector3)","mandatory":true},{"name":"originator","description":"Entity that caused the event.","mandatory":true},{"name":"unique","description":"Only one of this type can exist in the pool. (integer)","mandatory":false}]}]},{"name":"AimAtEntityIK","description":"Set this actor to aim at the specified entity. Call this function without any entity specified to turn it off.","example":"guy AimAtEntityIK( otherguy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"otherguy","description":"the other guy to aim at","mandatory":false}]}]},{"name":"AimAtPosIK","description":"Set this actor to aim at the specified position. Call this function without any position specified to turn it off.","example":"guy AimAtPosIK( pos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"pos","description":"the position to aim at","mandatory":false}]}]},{"name":"AllClientsPrint","description":"Cause all clients to print the localized version of this string.","example":"AllClientsPrint( \"Game Complete\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"the string to print","mandatory":true}]}]},{"name":"AllowedStances","description":"Sets the list of the actor's allowed stances.","example":"self AllowedStances( \"crouch\", \"prone\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor_or_player","description":null},"parameters":[{"name":"stance","description":"(string) A stance, can be 'prone', 'crouch', 'stand'. Any number of stances may be added.","mandatory":true}]}]},{"name":"AllowTacticalInsertion","description":"Sets whether tactical insertions can be placed within the bounding area of a given entity.","example":"my_trigger AllowTacticalInsertion( false )","flags":["verified"],"overloads":[{"calledOn":{"name":"target","description":"The target entity, such as a trigger.","type":{"dataType":"struct","instanceType":"entity"}},"parameters":[{"name":"allow","description":"Whether tactical insertions can be placed inside this entity.","mandatory":true,"type":{"dataType":"bool"}}],"returns":{"void":true}}],"verifiedInRevision":5},{"name":"AllWeaponAttachmentsUnlocked","description":"Are all the weapon attachments unlocked for this weapon?","example":"player AllWeaponAttachmentsUnlocked( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon","mandatory":true}]}]},{"name":"AnimHasNotetrack","description":"queries the given animation for a note track","example":"if ( IsDefined( facialanim ) && AnimHasNotetrack( facialanim, \"dialogue\" ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"an animation","mandatory":true},{"name":"note track","description":"a constant string with the name of the note track","mandatory":true}]}]},{"name":"AnimMappingSearch","description":"Searches animation mapping table to return a animation name when given a animation mapping alias name.","example":"self AnimMappingSearch(\"anim_arrive_cover_left_crouch\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{}]}]},{"name":"AnimRelative","description":"Runs an animscript on an entity.","example":"driver AnimRelative( \"germantruck_driver_closedoor\", org , angles, driver.closedooranim )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"notify","description":"The notify to send","mandatory":true},{"name":"origin","description":"The starting position of the anim script","mandatory":true},{"name":"angles","description":"The starting angle of the anim script","mandatory":true},{"name":"animation","description":"The animation","mandatory":true},{"name":"mode","description":"Valid modes are \"normal\" and \"deathplant\"","mandatory":false},{"name":"root","description":"The root animation","mandatory":false}]}]},{"name":"AnimScripted","description":"Runs an animscript on an entity.","example":"driver AnimScripted( \"germantruck_driver_closedoor\", org , angles, driver.closedooranim )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"notify","description":"The notify to send","mandatory":true},{"name":"origin","description":"The starting position of the anim script","mandatory":true},{"name":"angles","description":"The starting angle of the anim script","mandatory":true},{"name":"animation","description":"The animation","mandatory":true},{"name":"mode","description":"Valid modes are \"normal\" and \"deathplant\"","mandatory":false},{"name":"root","description":"The root animation","mandatory":false},{"name":"rate","description":"The playback rate of animation","mandatory":false},{"name":"blend","description":"The blend time for the animation","mandatory":false},{"name":"lerp","description":"The lerp time for an aligned animation","mandatory":false},{"name":"animation time","description":"The starting animation time in 0-1 range","mandatory":false},{"name":"is_scene_animation","description":"Should be true for player scene animations or scripted animations where the player has no control, can be ignored for non-players","mandatory":false},{"name":"showPlayerWeaponInFirstPerson","description":"determines if the first person player should have his weapon during cinematics","mandatory":false}]}]},{"name":"Announcement","description":"Sends an announcement to all clients.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The announcement.","mandatory":true},{"name":"duration","description":"How long, in seconds, to display the announcement.","mandatory":true}]}]},{"name":"ApplyBallisticTarget","description":"Launch a vehicle with just enough force at a target.","example":"dropRaps ApplyBallisticTarget( (50,50,10) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"targetPos","description":"The position to launch the vehicle towards","mandatory":true}]}]},{"name":"AreAllMissionsAtScore","description":"Returns true if all missions are at the score specified","example":"is_score_achieved = self AreAllMissionsAtScore( 10000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"score","description":"A score that all missions must be at to return true (integer)","mandatory":true}]}]},{"name":"arenagetcurrentseason","description":"Returns the current arena season","example":"ArenaGetCurrentSeason()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ArenaGetSlot","description":"Returns the current arena slot","example":"ArenaGetSlot()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"AreTexturesLoaded","description":"Check to see if start-of-level textures are loaded - if they're not, the streamer forces a black screen.","example":"while( !areTexturesLoaded() ) { wait(0.05); }","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ArraySort","description":"Returns a sorted array of entities by closest or farthest distance from ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to sort","mandatory":true},{"name":"origin","description":"the origin from which to compare","mandatory":true},{"name":"closest","description":"if set to true the array will be sorted by distance closest to , if false by distance farthest from ","mandatory":false},{"name":"max","description":"if set then only the first count of entities will be returned","mandatory":false},{"name":"range","description":"if set then only the entities within will be considered","mandatory":false}]}]},{"name":"ArraySortClosest","description":"Returns a sorted array of entities by closest from ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to sort","mandatory":true},{"name":"origin","description":"the origin from which to compare","mandatory":true},{"name":" count of entities will be returned","mandatory":false},{"name":"minDist","description":"if set then only the entities further than will be considered","mandatory":false},{"name":"maxDist","description":"if set then only the entities closer then 0, the bad place will automatically delete itself after this time. If duration <= 0, the bad place must have a name and will last until manually deleted.","mandatory":true},{"name":"origin","description":"The origin of the box.","mandatory":true},{"name":"halfSize","description":"The halfSize of the box.","mandatory":true},{"name":"team","description":"You must specify at least one team for which this place is bad, but can give several. The allowed teams are 'axis', 'allies', and 'neutral'.","mandatory":true}]}]},{"name":"BadPlace_Cylinder","description":"Creates a bad place cylinder. AI will flee this position if they can, and will not go into it if they can avoid it.","example":"BadPlace_Cylinder( \"moody\", -1, level.moodyfall_mn, level.moodyfall_radius, \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The name of the bad place. If name is not \"\", the bad place can be moved or deleted by using the unique name.","mandatory":true},{"name":"duration","description":"If duration > 0, the bad place will automatically delete itself after this time. If duration <= 0, the bad place must have a name and will last until manually deleted.","mandatory":true},{"name":"origin","description":"The origin of the cylinder.","mandatory":true},{"name":"radius","description":"The radius of the cylinder.","mandatory":true},{"name":"height","description":"The height of the cylinder.","mandatory":true},{"name":"team","description":"You must specify at least one team for which this place is bad, but can give several. The allowed teams are 'axis', 'allies', and 'neutral'.","mandatory":true}]}]},{"name":"BadPlace_Delete","description":"Deletes a bad place. It is okay to delete a bad place name that doesn't exist. It is not okay to delete the special name \"\".","example":"BadPlace_Delete( \"bpFlak1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"bad place identifier","description":"The bad place to delete","mandatory":true}]}]},{"name":"BallSetTarget","description":"Sets the target of the ball to the given entity, and resets if no entity is specified.","example":"self BallSetTarget( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ball","description":null},"parameters":[{"name":"target","description":"The target of the missile","mandatory":true},{"name":"targetOffset","description":"Offset to the target location (vector3)","mandatory":false}]}]},{"name":"Ban","description":"Bans the specified player.","example":"Ban( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"clientnum","description":"The client number of the player to ban.","mandatory":true}]}]},{"name":"BeamTrace","description":"Performs a bullet trace between two points and returns an array of information about the trace result.","example":"a_trace = BeamTrace( org1, org2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start_pos","description":"(point) The start position for the trace.","mandatory":true},{"name":"end_pos","description":"(point) The end position for the trace.","mandatory":true},{"name":"hit_characters","description":"(bool) Tell the trace to hit characters or not.","mandatory":true},{"name":"ignore_ent","description":"(entity) Entity to ingore for trace.","mandatory":true},{"name":"ignore_water","description":"(bool) Ignore water - defaults to false.","mandatory":false},{"name":"ignore_glass","description":"(bool) Ignore glass - defaults to false.","mandatory":false},{"name":"ignore_ent2","description":"(entity) Second entity to ingore for trace.","mandatory":false}]}]},{"name":"BloodImpact","description":"Sets the blood impact type on the character","example":"guy BloodImpact ( \"none\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"value","description":"Has to be one of: \"none\", \"hero\" or \"normal\"","mandatory":true}]}]},{"name":"Bobbing","description":"Causes a script entity to bob around its origin, along a given vector dir","example":"self Bobbing( directionVir, 0.3, 0.4, 0.0f )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"direction vector","description":"The direction of the bobbing","mandatory":true},{"name":"amplitude","description":"The amount of the bobbing in units","mandatory":true},{"name":"period","description":"The period of the bobbing in seconds","mandatory":true},{"name":"phase","description":"The phase offset of the bobbing","mandatory":false}]}]},{"name":"BonusCardActiveCount","description":"Returns how many bonus cards are active, cannot be called on a larry","example":"cardCount = self BonusCardActiveCount( self.class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"classnum","description":"The current class num of the player","mandatory":true}]}]},{"name":"BoundsWouldTelefrag","description":"Returns true if the passed in bounding box would telefrag a player if another player was spawned there.","example":"if ( BoundsWouldTelefrag( vehicle GetAbsMins(), vehicle GetAbsmaxs() ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mins","description":"Mins of bounding box","mandatory":true},{"name":"maxs","description":"Maxs of bounding box","mandatory":true}]}]},{"name":"BulletSpread","description":"uses spread to return a new end position","example":"endpos = BulletSpread( self.origin, target.origin, 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet starting point","mandatory":true},{"name":"end","description":"The bullet ending point","mandatory":true},{"name":"spread","description":"Amount of spread","mandatory":true}]}]},{"name":"BulletTrace","description":"Performs a bullet trace between two points and returns a map array of information about the trace result.","example":"a_trace = BulletTrace( org1, org2, true, undefined )","flags":["verified"],"verifiedInRevision":5,"overloads":[{"calledOn":null,"parameters":[{"name":"startPos","description":"The starting position of the trace.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"endPos","description":"The ending position for the trace.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"hitCharacters","description":"Whether the trace should hit characters.","mandatory":true,"type":{"dataType":"bool"}},{"name":"ignoreEnt","description":"An entity that should be ignored by the trace, which can be `undefined`.","mandatory":true,"type":{"dataType":"struct","instanceType":"entity","nullable":true}},{"name":"ignoreWater","description":"Whether the trace should ignore water surfaces. Defaults to `false`.","mandatory":false,"type":{"dataType":"bool"}},{"name":"ignoreGlass","description":"Whether the trace should ignore glass surfaces. Defaults to `false`.","mandatory":false,"type":{"dataType":"bool"}},{"name":"ignoreEnt2","description":"If specified, a second entity that the trace should ignore.","mandatory":false,"type":{"dataType":"struct","instanceType":"entity","nullable":true}}],"returns":{"name":"result","description":"A map of information about the bullet trace result.","type":{"dataType":"map"}}}]},{"name":"BulletTracePassed","description":"Allows script to do a bullet point trace with ( MASK_SHOT & ~CONTENTS_SKY ) returns true if the trace does not hit anything","example":"passed = BulletTracePassed( grenade.origin, self.origin + (0,0,TROPHY_TRACE_Z), false, self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"hit characters","description":"An entity to ignore","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true},{"name":"ignore entity 2","description":"An entity to ignore","mandatory":false},{"name":"fx vis","description":"check against fx visibility also","mandatory":false},{"name":"ignore water","description":"mask contents_water","mandatory":false}]}]},{"name":"CamAnimScripted","description":"Plays the camera script on a player.","example":"CamAnimScripted( player, \"proto_melee_cam\", gettime(), origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to play animation on","mandatory":true},{"name":"cam_anim","description":"The animation to play","mandatory":true},{"name":"start_time","description":"The start time of the animation","mandatory":true},{"name":"align_origin","description":"The origin to align to","mandatory":true},{"name":"align_angles","description":"The angles to align to","mandatory":true},{"name":"lerp_duration","description":"The lerp duration","mandatory":false},{"name":"camera_name","description":"The camera name","mandatory":false},{"name":"ignoreProcessingInitialNoteTracks","description":"Ignores processing the initial notetracks if the camera time starts earlier","mandatory":false}]}]},{"name":"CanClaimNode","description":"Returns true if the node is unclaimed, false otherwise.","example":"if ( CanClaimNode( cover, team ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"pathnode to check","mandatory":true},{}]}]},{"name":"CanPath","description":"Check if a path can be found between these positions.","example":"if ( self CanPath( self.origin, targetpos ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"ChangeAdvertisedStatus","description":"Changes the advertised status","example":"changeAdvertisedStatus( onOff )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"onOff","description":"(boolean)","mandatory":true}]}]},{"name":"CheckIfSongUnlocked","description":null,"example":"self CheckIfSongUnlocked( \"frag_out\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string)","mandatory":true}]}]},{"name":"CheckNavMeshDirection","description":"Run a trace on NavMesh to get the furthest position a character can move in that direction","example":"pos = CheckNavMeshDirection( (10,20,30), ( 1, 1, 0 ), 25 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"start of the trace","mandatory":true},{"name":"dir","description":"direction to trace","mandatory":true},{"name":"dist","description":"distance to trace","mandatory":true},{"name":"characterRadius","description":"the radius of the capsule used in trace. default to 0.","mandatory":false},{"name":"materialFlags","description":"the flags marking whether a face type can be used","mandatory":false}]}]},{"name":"ClearAnim","description":"Sets an animation's goal weight (and the goal weights of all of its descendents) to zero over the specified time.","example":"self ClearAnim( %root, 0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to clear","mandatory":true},{"name":"time","description":"The blending time for the clear","mandatory":true}]}]},{"name":"ClearAnimLimited","description":"Sets an animation's goal weight to zero over the specified time.","example":"self ClearAnimLimited( %root, 0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to clear","mandatory":true},{"name":"time","description":"The blending time for the clear","mandatory":true}]}]},{"name":"ClearPlayerCorpses","description":"Removes all player corpses from the level","example":"ClearPlayerCorpses( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ClearPlayerGravity","description":"Clears the gravity override for the player.","example":"player ClearPlayerGravity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ClearSpawnPoints","description":"Clears all spawnpoints out of the system","example":"ClearSpawnPoints()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"list","description":"which list of spawnpoints to clear","mandatory":false}]}]},{"name":"ClearSpawnPointsBaseWeight","description":"Clears the objective base weights set in the spawn points","example":"ClearSpawnPointsBaseWeight( team_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team mask","description":"teams that this command will affect","mandatory":true}]}]},{"name":"ClearStowedWeapon","description":"Clears the stowed weapon for the player","example":"self ClearStowedWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ClearTargetEntity","description":"Clears the current target for this vehicle or turret.","example":"roof_turret ClearTargetEntity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"ClearTopScorers","description":"Clears the top scorer for the end game screen.","example":"ClearTopScorers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ClientAnnouncement","description":"Sends an announcement to a single client.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"clientnum","description":"The client number that the announcement is sent to.","mandatory":true},{"name":"string","description":"The announcement.","mandatory":true},{"name":"duration","description":"How long, in seconds, to display the announcement.","mandatory":true}]}]},{"name":"ClientClaimTrigger","description":"Claim a single user trigger.","example":"other ClientClaimTrigger( self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"trigger","description":"A trigger entity.","mandatory":true}]}]},{"name":"ClientPrint","description":"Print a localized version of this string for a given client","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"A client entity.","mandatory":true},{"name":"string","description":"A message to print.","mandatory":true}]}]},{"name":"ClientReleaseTrigger","description":"Release a single user trigger.","example":"other ClientReleaseTrigger( self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"trigger","description":"A trigger entity.","mandatory":true}]}]},{"name":"ClientSysRegister","description":"Declares a system who's state will be communicated over to the client script system when it changes. Takes a unique name, and returns the id of the system.","example":"index = ClientSysRegister(\"FakeFire\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The unique name of the system to be registered","mandatory":true}]}]},{"name":"ClientSysSetState","description":"Sets the state of a pre registered client system for all clients. The state will be communicated to the client script system.","example":"ClientSysSetState(level._ClientSys[\"FakeFire\"], \"Event1Phase1\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"id","description":"The integer id of the client system. Returned from call to ClientSysRegister.","mandatory":true},{"name":"state","description":"Arbitrary string state. Will be sent to the client script system.","mandatory":true}]}]},{"name":"CloneAndRemoveEntity","description":"Creates a new entity at the position/orientation/pose of the original, and kills the original","example":"CloneAndRemoveEntity( ent )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"entity field","mandatory":true}]}]},{"name":"CodeGetClientField","description":"Gets the value for a given client field.","example":"val = CodeGetClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity to search the name in","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeGetPlayerStateClientField","description":"Gets the value for a given player state client field.","example":"val = CodeGetPlayerStateClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeGetUIModelClientField","description":"Gets the value for a given player uimodel client field.","example":"val = CodeGetUIModelClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeGetWorldClientField","description":"Gets the value for a given client field.","example":"val = CodeGetWorldClientField(\"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementClientField","description":"Increments the value for a given client field.","example":"CodeIncrementClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementPlayerStateClientField","description":"Increments the value for a given player state client field.","example":"CodeIncrementPlayerStateClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementUIModelClientField","description":"Increments the value for a given client field.","example":"CodeIncrementUIModelClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementWorldClientField","description":"Increments the value for a given world client field.","example":"CodeIncrementWorldClientField(\"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeSetClientField","description":"Sets the value for a given client field.","example":"CodeSetClientField(ent, \"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CodeSetPlayerStateClientField","description":"Sets the value for a given player state client field.","example":"CodeSetPlayerStateClientField(ent, \"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CodeSetUIModelClientField","description":"Sets the value for a given player uimodel client field.","example":"CodeSetUIModelClientField(ent, \"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CodeSetWorldClientField","description":"Sets the value for a given world client field.","example":"CodeSetWorldClientField(\"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CollisionTestPointsInBox","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInCone","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInCylinder","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInPill","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInSphere","description":"Returns an array of collision result structures","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ConnectPaths","description":"Connects the paths that intersect with the entity.","remarks":["If the entity is a `script_brushmodel` then it must have `DYNAMICPATH` set to connect paths."],"example":"vehicle ConnectPaths()","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":{"name":"target","description":"The entity to connect the paths on.","type":{"dataType":"struct","instanceType":"entity","isArray":false}},"parameters":[],"returns":{"void":true}}]},{"name":"ConsumableDecrement","description":"Decrement a specified consumable for the player by the specified amount","example":"self ConsumableDecrement( \"blackjack\", \"awarded\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ConsumableGet","description":"Returns the value of the specified consumable for the player","example":"self ConsumableGet( \"blackjack\", \"awarded\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ConsumableIncrement","description":"Increment a specified consumable for the player by the specified amount","example":"self ConsumableIncrement( \"blackjack\", \"awarded\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ConsumableSet","description":"Set a specified consumable for the player to the specified amount","example":"self ConsumableSet( \"blackjack\", \"awarded\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CountPlayers","description":"Returns a count of the current players, even if they are still connecting to the game.","example":"count = CountPlayers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"- if specifed, returns lists of players on different teams, in team based game modes. Valid values \"allies\", \"axis\", \"neutral\" & \"all\"","mandatory":false}]}]},{"name":"CreateDynEntAndLaunch","description":"Creates and launches a dynent.","example":"CreateDynEntAndLaunch( spawn_models[i], origin, angles, origin, velocity, anim._effect[\"animscript_gibtrail_fx\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{"name":"pos","description":"position to spawn at.","mandatory":true},{"name":"angles","description":"angles to spawn at.","mandatory":true},{"name":"hitpos","description":"the hit position","mandatory":true},{"name":"force","description":"The force of the launch","mandatory":true},{"name":"fx","description":"particle effects to play on this dynent","mandatory":false}]}]},{"name":"CreateStreamerHint","description":"Allows scripter to create a streamer hint entity viewpoint to the player's viewpoint.","example":"streamHintEnt = createStreamerHint( level.player.origin, 0.333 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Location at which to spawn the streamer hint.","mandatory":true},{"name":"factor","description":"The relative importance of this entity's viewpoint to the main viewpoint.","mandatory":true},{"name":"lightingState","description":"The lighting state to stream","mandatory":false}]}]},{"name":"CurrentSessionMode","description":"Returns the current session mode index","example":"sessionMode = CurrentSessionMode()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CylinderDamage","description":"cylinder_dir_vector should contains the direction and the length of the cylinder relative to the base origin","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cylinder_vec","description":"contains the direction and the length of the cylinder relative to the base origin","mandatory":true},{"name":"origin","description":"Origin of damage","mandatory":true},{"name":"near_radius","description":"Radius of the damage at the near end","mandatory":true},{"name":"far_radius","description":"Radius of the damage at the far end","mandatory":true},{"name":"max_damage","description":"Max damage, this is the damage at the origin","mandatory":true},{"name":"min_damage","description":"Max damage, this is the damage at the edge of the radius","mandatory":true},{"name":"attacker","description":"Attacker the dealt the damage","mandatory":false},{"name":"means_of_death","description":"Means of death of the damage","mandatory":false},{"name":"weapon","description":"Weapon used to damage","mandatory":false}]}]},{"name":"DamageConeTrace","description":"Determines how much the entity can be seen from the given position. Performs multiple 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":"turretDamageFraction = entity damageConeTrace( turret.origin + (0,0,40), turret )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"damage position","description":"The point the sight starts at","mandatory":true},{"name":"ignore entity","description":"An entity to ignore when doing the traces","mandatory":false},{"name":"damage angles","description":"The forward direction of the cone, whose base is at the . Must be normalized.","mandatory":false},{"name":"cone angle","description":"Angle in degrees from the line of sight to the edge of the cone. Defaults to 65.","mandatory":false}]}]},{"name":"DeactivateClientExploder","description":"Deactivates a client side exploder","example":"DeactivateClientExploder( 101 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"id of exploder to deactivate","mandatory":true}]}]},{"name":"DeactivateClientRadiantExploder","description":"Deactivates a client side radiant exploder","example":"DeactivateClientRadiantExploder( \"light_switch\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"string id of exploder to deactivate","mandatory":true}]}]},{"name":"Delete","description":"Removes an entity from the game in the same manner as a trigger_kill","example":"self Delete()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DeletePathNode","description":"Delete a dynamically created path node or cover node","example":"DeletePathNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to delete","mandatory":true}]}]},{"name":"DeployRiotShield","description":"Gets the index in a particular class","example":"DeployRiotShield( owner, shield )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"DepthInWater","description":"Returns the depth (in inches) that the entity is in water. Returns depth in inches, or 0 if the entity isn't in water. Will work for all water types.","example":"depth = get_players()[0] DepthInWater()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DepthOfPlayerInWater","description":"Returns the depth (in inches) that the player is in water. Returns depth in inches, or 0 if the entity isn't in water. Will work for all water types. More effecient than depthinwater but will only work for players","example":"depth = get_players()[0] DepthOfPlayerInWater()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"Detach","description":"detaches an attached model from an entity","example":"self Detach( \"explosivepack\", \"tag_weapon_right\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelname","description":"The model name to detach (string)","mandatory":true},{"name":"tagname","description":"The tag to detach the model from (string)","mandatory":false}]}]},{"name":"DetachAll","description":"detaches all attached models from an entity","example":"self DetachAll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DetachShieldModel","description":"Detaches an attached shield model from a player.","example":"self DetachShieldModel( \"weapon_riot_shield\", \"tag_weapon_left\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"modelname","description":"The model name to detach (string)","mandatory":true},{"name":"tagname","description":"The tag to detach the model from (string)","mandatory":false}]}]},{"name":"Detonate","description":"Detonate the entity and set the owner to the player which is specified.","example":"self Detonate( attacker )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"player","description":"The player who owns the entity","mandatory":false}]}]},{"name":"DirectionalHitIndicator","description":"Create a directional hit indicator","example":"attacker DirectionalHitIndicator( victimArray0, victimArray1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"victims0","description":"A bit array of entities 0-31 that got hit","mandatory":true},{"name":"victims1","description":"A bit array of entities 32-63 that got hit","mandatory":false}]}]},{"name":"DisableAimAssist","description":"Disables Aim assist on the entity. Entity has to be either a brush model or an actor or a vehicle or a script_model.","example":"player DisableAimAssist()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DisableDestructiblePieces","description":"Disables all destructible pieces that have this label set in the destructible gdt","example":"DisableDestructiblePieces( \"heavy_armor\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"label","description":"the name of the field listed in the destructible gdt to disable","mandatory":true}]}]},{"name":"DisableGrenadeSuicide","description":"Stops cooked grenades from killing the player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"DisableGrenadeTouchDamage","description":"Resets the grenade touch damage flag of the entity","example":"self DisableGrenadeTouchDamage()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DisableOffhandSpecial","description":"Disable the ability to activate a player's special offhand weapons","example":"player DisableOffhandSpecial()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableSpawnPointList","description":"disables spawn point list for a the team_mask","example":"DisableSpawnPointList()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"list","description":"list to disable","mandatory":true},{"name":"team mask","description":"teams that this command will affect","mandatory":true}]}]},{"name":"DisconnectPaths","description":"Disconnects the paths that intersect with the entity.","remarks":["If the entity is a `script_brushmodel` then it must have `DYNAMICPATH` set to disconnect paths."],"example":"level.ArmoredCar DisconnectPaths()","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":{"name":"target","description":"The entity to disconnect the paths on.","type":{"dataType":"struct","instanceType":"entity","isArray":false}},"parameters":[{"name":"detailLevel","description":"How detailed the cut part matches the entity. 0 or omitted: Box. 1: Convex hull fitting rough shape. 2: [SUPER EXPENSIVE] Use collision shape directly.","type":{"dataType":"int","isArray":false},"mandatory":false},{"name":"moveAllowed","description":"Sets whether the silhouette moves with the entity (defaults to true).","type":{"dataType":"bool","isArray":false},"mandatory":false}],"returns":{"void":true}}]},{"name":"DoDamage","description":"Does damage to this entity","example":"player DoDamage(25, gasEffectArea.origin, player.lastPoisonedBy, grenade_obj, 0, \"MOD_EXPLOSIVE\", 0, GetWeapon(\"tabun_gas_mp\"), -1, false)","flags":["verified"],"verifiedInRevision":5,"overloads":[{"calledOn":{"name":"target","description":"The entity that the damage should be dealt upon.","mandatory":true,"type":{"dataType":"struct","instanceType":"entity"}},"parameters":[{"name":"health","description":"The amount of damage to do.","mandatory":true,"type":{"dataType":"int"}},{"name":"sourcePosition","description":"The source location that the damage comes from.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"attacker","description":"The entity that dealt the damage (such as an AI or player).","mandatory":false,"type":{"dataType":"struct","instanceType":"entity"}},{"name":"inflictor","description":"The entity that the damage came from (such as a grenade or turret).","mandatory":false,"type":{"dataType":"struct","instanceType":"entity"}},{"name":"hitLoc","description":"The location of the damage, which defaults to `none`.","mandatory":false,"type":{"dataType":"enum","instanceType":"HitLocation"}},{"name":"mod","description":"The means of death string. If not specified, the means of death will be `MOD_UNKNOWN`.","mandatory":false,"type":{"dataType":"enum","instanceType":"MeansOfDeath"}},{"name":"dFlags","description":"Any flags associated with the damage being dealt. Defaults to 0 (no flags).","mandatory":false,"type":{"dataType":"int"}},{"name":"weapon","description":"The weapon used to deal the damage.","mandatory":false,"type":{"dataType":"struct","instanceType":"weapon"}},{"name":"destructiblePieceIndex","description":"The destructible piece index from the destructible def GDT.","mandatory":false,"type":{"dataType":"int"}},{"name":"forcePain","description":"When set to `true`, the target entity's pain time is reset to zero, forcing them to produce a pain reaction to the damage.","mandatory":false,"type":{"dataType":"bool"}}],"returns":{"void":true}}],"remarks":["For the `dFlags` parameter, each flag corresponds to a particular bit position, allowing them to be combined. These are defined in `shared.gsh`."]},{"name":"DoesWeaponReplaceSpawnWeapon","description":"Returns true if the new weapon is an alt mode of the spawn weapon. Only certain alt variations are valid (not-gl)","example":"if ( DoesWeaponReplaceSpawnWeapon( self.spawnWeapon, newWeapon ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"DontInterpolate","description":"pop the entity's position instantaneously to where it moves this time step, rather than smoothly moving there from the previous position","example":"entity DontInterpolate()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DoubleXPTimerFired","description":"Used to decrement consumable double xp promotions","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DrawNode","description":"Draws a node","example":"DrawNode( self.node)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"pathnode","mandatory":true}]}]},{"name":"DropNodEToFloor","description":"Drop the node to the floor.","example":"DropNodeToFloor( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"node to drop","mandatory":true}]}]},{"name":"EACPathSet","description":"Sets the value of a eac path drone.","example":"SetEACPATH( origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vec3","description":"The value.","mandatory":true}]}]},{"name":"Earthquake","description":"Create an earthquake shaking effect at the given location.","example":"Earthquake( 0.22, 7, player.origin, 150 )","flags":["verified"],"overloads":[{"calledOn":{"name":"target","description":"When specified, the earthquake is shown only to the target player.","mandatory":false,"type":{"dataType":"struct","instanceType":"player"}},"parameters":[{"name":"scale","description":"Magnitude scalar of the earthquake. Must be greater than 0.","mandatory":true,"type":{"dataType":"number"}},{"name":"duration","description":"The duration of the earthquake. Must be greater than 0.","mandatory":true,"type":{"dataType":"number"}},{"name":"origin","description":"The source location of the earthquake.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"radius","description":"The radius of the earthquake. Must be greater than 0.","mandatory":true,"type":{"dataType":"number"}}],"returns":{"void":true}}],"verifiedInRevision":5},{"name":"EnableAimAssist","description":"Enables Aim assist on the entity. Entity has to be either a brush model or an actor or a vehicle or a script_model.","example":"player EnableAimAssist()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"EnableAllDestructiblePieces","description":"Enables all destructible pieces that were previously disabled","example":"EnableAllDestructiblePieces()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"EnableGrenadeSuicide","description":"Enables cooked grenades killing the player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"EnableGrenadeTouchDamage","description":"Sets the grenade touch damage flag of the entity","example":"self EnableGrenadeTouchDamage()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"EnableInfluencer","description":"Enables or disables the given influencer","example":"EnableInfluencer( influencer_id, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer to enable/disable","mandatory":true},{"name":"enable","description":"True to enable. False to disable","mandatory":true}]}]},{"name":"EnableLinkTo","description":"enables linkto for an entity","example":"self.bombtrigger EnableLinkTo()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"EnableNavMeshTrigger","description":"Enables/disables a given navmesh trigger","example":"EnableNavMeshTrigger( \"some_trigger\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"The targetname of the trigger entity.","mandatory":true},{"name":"enable","description":"Whether to enable disable the given volume for pathfinding.","mandatory":true}]}]},{"name":"EnableObstacle","description":"Enables or disables the hkai obstacle associated with a given entity.","example":"ent EnableObstacle( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"enable","description":"Whether to enable or disable the obstacle","mandatory":true}]}]},{"name":"EnableOffhandSpecial","description":"Enable the ability to activate a player's special offhand weapons","example":"player EnableOffhandSpecial()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableSpawnPointList","description":"enables spawn point list for a the team_mask","example":"EnableSpawnPointList()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"list","description":"list to enable","mandatory":true},{"name":"team mask","description":"teams that this command will affect","mandatory":true}]}]},{"name":"EndCamAnimScripted","description":"Ends the camera script on a player.","example":"EndCamAnimScripted( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{}]}]},{"name":"EndExtraCamAnimScripted","description":"Ends the extracam camera script on a player.","example":"EndExtraCamAnimScripted( player, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player","description":"The player to play animation on","mandatory":true},{"name":"extra_cam_index","description":"The extra camera index","mandatory":true}]}]},{"name":"ExitLevel","description":"exits the current level","example":"ExitLevel( false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"save persistent","description":"if true then player info is retained","mandatory":false}]}]},{"name":"ExperimentsGetVariant","description":"Gets the variant for a user for an experiment","example":"variant = player ExperimentsGetVariant( experimentName )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ExtraCamAnimScripted","description":"Plays the camera script on an extracam player.","example":"ExtraCamAnimScripted( player, 0, \"proto_melee_cam\", gettime(), origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to play animation on","mandatory":true},{"name":"extra_cam_index","description":"The extra camera index","mandatory":true},{"name":"cam_anim","description":"The animation to play","mandatory":true},{"name":"start_time","description":"The start time of the animation","mandatory":true},{"name":"align_origin","description":"The origin to align to","mandatory":true},{"name":"align_angles","description":"The angles to align to","mandatory":true},{"name":"lerp_duration","description":"The lerp duration","mandatory":false},{"name":"camera_name","description":"The camera name","mandatory":false},{"name":"ignoreProcessingInitialNoteTracks","description":"Ignores processing the initial notetracks if the camera time starts earlier","mandatory":false}]}]},{"name":"FakeFire","description":"Simulates gun fire. Sound and radar blip.","example":"decoy FakeFire( player, position, \"turret_mp\", 20 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"owner","description":"The player who fakes fire","mandatory":true},{"name":"origin","description":"the origin of the fake fire","mandatory":true},{"name":"weapon","description":"The weapon used","mandatory":true},{"name":"shot count","description":"Number of shots fired","mandatory":true}]}]},{"name":"FindAnimByName","description":"Find specified animation( using animation name ) in a specified animtree( using atr name).","example":"animnamehash = FindAnimByName(\"generic_human\", \"chicken_dance\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"tree","description":"Anim tree name","mandatory":true},{"name":"anim","description":"Name of anim","mandatory":true}]}]},{"name":"FindPath","description":"Check if a path can be found between these positions.","example":"if ( self FindPath( self.origin, potentialpos ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":".","mandatory":true},{"name":"end","description":".","mandatory":true}]}]},{"name":"FlashbackFinish","description":"Finishes the flashback","example":"self FlashbackFinish()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"FlashbackStart","description":"Starts the flashback and returns the new origin","example":"newpos = self FlashbackStart( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon in the player loadout.","mandatory":true}]}]},{"name":"ForcePainOn","description":"toggles pain.forcePain to true; next damage reaction guarenteed","example":"ai ForcePainOn()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"FXBlockSight","description":"Uses a general entity and a radius to set a line of sight blocker on the server for some AI. Destroyed when the entity is freed.","example":"FXBlockSight( fxent, 64 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"the entity to use for the origin for tje line of sight blocker","mandatory":true},{"name":"radius","description":"the radius of the 'smoke screen' blocker","mandatory":true}]}]},{"name":"GadgetActivate","description":"turns gadget on in slot.","example":"self GadgetActivate( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to activate. (integer)","mandatory":true},{"name":"weapon","description":"The gadget weapon","mandatory":true}]}]},{"name":"GadgetCharging","description":"Sets the gadget charging state.","example":"self GadgetCharging( slot, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot. (integer)","mandatory":true},{"name":"value","description":"undefined to get current state, true to set or false to unset. (boolean)","mandatory":false}]}]},{"name":"GadgetDeactivate","description":"turns gadget off in slot.","example":"self GadgetDeactivate( slot, weapon, GADGET_OFF_PENALTY_SHUT_OFF )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to deactivate. (integer)","mandatory":true},{"name":"weapon","description":"The gadget weapon","mandatory":true},{"name":"penalty","description":"The power penalty type","mandatory":false}]}]},{"name":"GadgetFlickering","description":"Tests a gadget is flickering and can optionally set flickering.","example":"self GadgetFlickering( slot, true, 200 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test or apply flickering state. (integer)","mandatory":true},{"name":"flicker","description":"Set gadget to flickering state if true (boolean)","mandatory":false},{"name":"length","description":"Set gadget flickering length (integer)","mandatory":false}]}]},{"name":"GadgetGetSlot","description":"Get gadget slot for weapon.","example":"self GadgetGetSlot( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon in the player loadout.","mandatory":true}]}]},{"name":"GadgetIsActive","description":"Returns true if the gadget is active.","example":"self GadgetIsActive( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test. (integer)","mandatory":true}]}]},{"name":"GadgetIsPrimed","description":"Returns true if the gadget is primed.","example":"self GadgetIsPrimed( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test. (integer)","mandatory":true}]}]},{"name":"GadgetIsReady","description":"Returns true if the gadget is ready.","example":"self GadgetIsReady( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test. (integer)","mandatory":true}]}]},{"name":"GadgetPowerChange","description":"Applies a power change to the gadget power.","example":"self GadgetPowerChange( slot, -20 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot apply the power change. (integer)","mandatory":true},{"name":"change","description":"The amount to change the power by. (float)","mandatory":true}]}]},{"name":"GadgetPowerGet","description":"Gets the power remaining for gadget.","example":"power = self GadgetPowerGet( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot (integer)","mandatory":true}]}]},{"name":"GadgetPowerReset","description":"Applies a power reset.","example":"self GadgetPowerReset( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot apply the power reset. (integer)","mandatory":true}]}]},{"name":"GadgetPowerSet","description":"Sets the power override to value. Works always.","example":"self GadgetPowerSet( slot, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot apply the power change. (integer)","mandatory":true},{"name":"value","description":"The amount to set power to. (float)","mandatory":true}]}]},{"name":"GadgetSetActivateTime","description":"Set the activation time of this gadget.","example":"self GadgetSetActivateTime( slot, time )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot. (integer)","mandatory":true},{"name":"time","description":"The activation time. (integer)","mandatory":true}]}]},{"name":"GadgetSetEntity","description":"Set the entity used by this gadget.","example":"self GadgetSetEntity( slot, ent )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot.","mandatory":true},{"name":"entity","description":"The entity used by the gadget.","mandatory":true}]}]},{"name":"GadgetStateChange","description":"changes the gadget state in a slot.","example":"self GadgetStateChange( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to activate. (integer)","mandatory":true},{"name":"weapon","description":"The gadget weapon","mandatory":true},{"name":"state","description":"The state to change it to","mandatory":true}]}]},{"name":"GadgetTargetResult","description":null,"example":"GadgetTargetResult(true)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"hit_miss","description":"hit or miss","mandatory":true}]}]},{"name":"GameModeIsMode","description":"Returns true/false if the current game mode is the given mode","example":"if ( GameModeIsMode( level.GAMEMODE_WAGER_MATCH ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gamemode","description":"(int)","mandatory":true}]}]},{"name":"GeneratePointsAroundCenter","description":"generate uniformly distributed points around a center in 2D (XY) plane","example":"array = GeneratePointsAroundCenter( enemy.origin, 500, 80, 100, 40, (-0.3,0,0) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Position to start the search around.","mandatory":true},{"name":"maxSearchRadius","description":"the maximum radius away from origin.","mandatory":true},{"name":"innerSpacing","description":"the distance between points at the minRadius.","mandatory":true},{"name":"minRadius","description":"the minimum radius away from origin. should be between 0 and maxRadius (both inclusive).","mandatory":false},{"name":"outerSpacing","description":"if defined, the distance between points will be Lerped from to [outerSpacing], to create a gradual distribution from minRadius to maxRadius.","mandatory":false},{"name":"distributionBias","description":"(vec2) if defined, the density of the points will be changed gradually along the direction of this vector. the magnitude will be use as scalar, with 1 being the norm scale.","mandatory":false}]}]},{"name":"GenerateScriptEvent","description":"Creates a script event at the actor's origin, with default radius","example":"self GenerateScriptEvent()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"Source position of the event.","mandatory":false},{"name":"radius","description":"Size of the event.","mandatory":false},{"name":"name","description":"Name of the event.","mandatory":false}]}]},{"name":"GetAbsMaxs","description":"Get absolute maximum bounds of the entity in world space.","example":"absMaxs = wallModel GetAbsMaxs()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAbsMins","description":"Get absolute minimum bounds of the entity in world space.","example":"absMins = wallModel GetAbsMins()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetActorArray","description":"Returns an array of the human AI","example":"aiarray = GetActorArray( \"ralph\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetActorSpawnerArray","description":"Returns an array of all of the actor spawners in a level.","example":"spawners = GetSpawnerArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetActorSpawnerTeamArray","description":"Returns an array of all of the spawners in a level","example":"enemies = GetActorSpawnerTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetActorTeamArray","description":"Returns an array of the human AI","example":"aiarray = GetActorTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetActorTeamCountRadius","description":"Returns number of human actor AI within a sphere on a given set of teams","example":"nearbyOthersCount = GetActorTeamCountRadius( self.origin, 500, \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Center of sphere","mandatory":true},{"name":"radius","description":"Radius of sphere","mandatory":true},{"name":"team","description":"any number of team names may be added, either 'axis', 'allies', or 'neutral' (no team implies all teams)","mandatory":false}]}]},{"name":"GetActorWeaponOptions","description":"Return's the actors current weapon options, ex: weapon camo option.","example":"self GetActorWeaponOptions()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAIArchetypeArray","description":"Returns an array of the AI for the given archetype and optionally given team","example":"aiarray = GetAIArchetypeArray( \"human\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', 'neutral', or 'all'. Defaults to 'all'.","mandatory":false}]}]},{"name":"GetAIArray","description":"Returns an array of the human AI","example":"aiarray = GetAIArray( \"my_ai\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetAICount","description":"Returns the current ai count.","example":"aicount = GetAICount()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAILimit","description":"Returns the max ai count set by script.","example":"ailimit = GetAILimit()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAimAngles","description":"Returns an array with the angles of the aimTag and the relative aiming delta angles from this orientation.","example":"aim_angles = ent GetAimAngles( shootPos, \"tag_aim\", (0, 30, 0), (15, 10, 0), (60, 60, 0), (5, 5, 0), 11 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{},{},{},{},{},{},{}]}]},{"name":"GetAISpeciesArray","description":"Returns an array of the AI","example":"aiarray = GetAISpeciesArray( \"axis\", \"all\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', 'neutral', or 'all'. Defaults to 'all'.","mandatory":false},{"name":"species","description":"species of AI to get, 'human', 'dog', 'robot' or 'all'. Defaults to 'human'.","mandatory":false}]}]},{"name":"GetAITeamArray","description":"Returns an array of the human AI and vehicle AI","example":"aiarray = GetAITeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetAITriggerFlags","description":"Returns the spawn flags that will allow AI to activate triggers","example":"spawn(\"trigger_radius\", (0,0,0), GetAITriggerFlags())","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAllCharacterBodies","description":"Returns all character indices, even disabled ones, for the current session mode (or specified session mode)","example":"heroIndices = GetAllCharacterBodies()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sessionMode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetAllCharacterHeads","description":"Returns all character indices, even disabled ones, for the current session mode (or specified session mode)","example":"heroIndices = GetAllCharacterHeads()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetAllNodes","description":"Gets all of the nodes in a level","example":"nodes = GetAllNodes()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAmmoCount","description":"Returns the count of ammo left","example":"n_ammo = self GetAmmoCount( w_weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon for which we need ammo count","mandatory":true}]}]},{"name":"GetAngleDelta","description":"Get the angle delta of the animation","example":"angleDelta = getAngleDelta( arrivalAnim, 0, normalizedLength )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation name","description":"Name of the animation","mandatory":true},{"name":"start time","description":"Start time of the animation","mandatory":false},{"name":"end time","description":"End time of the animation","mandatory":false}]}]},{"name":"GetAngleFromBits","description":"Gets the angle (0 - 360) from the (compressed) bits","example":"yaw = GetAngleFromBits( bits, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAngles","description":"Get the rotation of the entity","example":"angles = self GetAngles()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAnimForCharacter","description":"Returns the name of the animation to use for the character pose in the frontend","example":"frontendVignetteAnim = GetAnimForCharacter( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetAnimFrameCount","description":"Get total number of frames for the given animation.","example":"FrameNum = GetAnimFrameCount(climbAnim)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"a primitive animation: calling this function on a non-primitive animation will fail","mandatory":true}]}]},{"name":"GetAnimLength","description":"Gets the length of an animation","example":"cycleTime = GetAnimLength( climbAnim )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"a primitive animation: calling this function on a non-primitive animation will fail","mandatory":true}]}]},{"name":"GetAnimTagOrigin","description":"Returns the local tag position within the animation at the specified normalized time, has no consideration to bone hierarchy.","example":"tagPosition = GetAnimTagOrigin( arrivalAnim, 0, \"tag_sync\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation name","description":"Name of the animation.","mandatory":true},{"name":"normalized time","description":"0.0 to 1.0 time within the animation.","mandatory":true},{"name":"tag name","description":"Name of the tag to look up within the animation.","mandatory":true}]}]},{"name":"GetAnimTime","description":"Get the normalized animation time for the given animation.","example":"if ( (self GetAnimTime( %walk_and_run_loops ) ) < 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"animation to manipulate","mandatory":true}]}]},{"name":"GetAnyNodeArray","description":"Gets an array of nodes within given radius","example":"node = GetCoverNodeArray( self.origin, 256 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"search origin","mandatory":true},{"name":"radius","description":"radius to search within","mandatory":true}]}]},{"name":"GetArchetypeFromClassname","description":"Given classname, returns archetype name if its an AITYPE or VEHICLE.","example":"GetArchetypeFromClassname(\"spawner_enemy_54i_human_sniper_sniperrifle\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAssignedTeam","description":"returns the player's team as assigned by matchmaking. 0 = No Team, 1 = OpFor, 2 = Allies, 3 = Spectator.","example":"team = GetAssignedTeam( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player","mandatory":true}]}]},{"name":"GetAssignedTeamName","description":"returns the player's team as assigned by matchmaking. 0 = No Team, 1 = OpFor, 2 = Allies, 3 = Spectator.","example":"team = GetAssignedTeam( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player","mandatory":true}]}]},{"name":"GetAtrLoaded","description":"return an array of anim tree name loaded onto the server.","example":"trees = GetAtrLoaded()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAttachIgnoreCollision","description":"Returns the ignore collision flag of the attached model at the given attachment slot","example":"model_ignore_collision = self GetAttachIgnoreCollision( index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelindex","description":"The index of the model attached to the entity, starting at 0, so for instance 3 will get the fourth model attached. (integer)","mandatory":true}]}]},{"name":"GetAttachmentCosmeticVariantForWeapon","description":"Get the AttachmentCosmeticVariantIndexes data to be passed in to GetWeapon","example":"acvi = self GetAttachmentCosmeticVariantForWeapon( class_num, \"primary\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot (primary or secondary)","mandatory":true}]}]},{"name":"GetAttachmentCosmeticVariantIndexes","description":"Get the AttachmentCosmeticVariantIndexes data to be passed in to GetWeapon","example":"GetAttachmentCosmeticVariantIndexes( \"mp7_mp\", \"acog\", 2, \"grip\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponname","description":"the name of the base weapon to return","mandatory":true},{"name":"attachmentname_1","description":"the name of the first attachment","mandatory":false},{"name":"variantindex_1","description":"the index of the cosmetic variant to use for the first attachment","mandatory":false},{"name":"attachmentname_2","description":"the name of the second attachment","mandatory":false},{"name":"variantindex_2","description":"the index of the cosmetic variant to use for the second attachment","mandatory":false},{"name":"attachmentname_3","description":"the name of the third attachment","mandatory":false},{"name":"variantindex_3","description":"the index of the cosmetic variant to use for the third attachment","mandatory":false},{"name":"attachmentname_4","description":"the name of the fourth attachment","mandatory":false},{"name":"variantindex_4","description":"the index of the cosmetic variant to use for the fourth attachment","mandatory":false},{"name":"attachmentname_5","description":"the name of the fifth attachment","mandatory":false},{"name":"variantindex_5","description":"the index of the cosmetic variant to use for the fifth attachment","mandatory":false},{"name":"attachmentname_6","description":"the name of the sixth attachment","mandatory":false},{"name":"variantindex_6","description":"the index of the cosmetic variant to use for the sixth attachment","mandatory":false},{"name":"attachmentname_7","description":"the name of the seventh attachment","mandatory":false},{"name":"variantindex_7","description":"the index of the cosmetic variant to use for the seventh attachment","mandatory":false},{"name":"attachmentname_8","description":"the name of the eighth attachment","mandatory":false},{"name":"variantindex_8","description":"the index of the cosmetic variant to use for the eighth attachment","mandatory":false}]}]},{"name":"GetAttachmentNames","description":"Returns array containing the names for each type of attachment.","example":"attachmentNames = GetAttachmentNames()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAttachModelName","description":"Returns the name of the attached model at the given attachment slot","example":"model_name = self GetAttachModelName( index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelindex","description":"The index of the model attached to the entity, starting at 0, so for instance 3 will get the fourth model attached. (integer)","mandatory":true}]}]},{"name":"GetAttachSize","description":"Returns the number of attached models for this entity.","example":"size = self GetAttachSize()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAttachTagName","description":"Returns the tagname of the attached model at the given attachment slot","example":"tag_name = self GetAttachTagName( index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelindex","description":"The index of the model attached to the entity, starting at 0, so for instance 3 will get the fourth model attached. (integer)","mandatory":true}]}]},{"name":"GetBaseWeaponItemIndex","description":"Returns the base weapon item index from the statstable","example":"baseWeaponName = GetBaseWeaponItemIndex( \"m16_acog_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"full weapon name e.g. m16_acog_mp.","mandatory":true}]}]},{"name":"GetBestInfluencepos","description":"returns the influence map position for ai, this is custom logic to return the closest posistion between the passed in thresholds","example":"dir = self GetBestInfluencePos( index, low, high)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"index","description":"which influence map to use","mandatory":true},{"name":"low","description":"the low threshold value to check against","mandatory":true},{"name":"high","description":"the high threshold value to check against","mandatory":true}]}]},{"name":"GetBestSpawnPoint","description":"Returns a sorted array of spawnpoints in order from best to worst for the given team","example":"GetSortedSpawnPoints()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point team","description":"Team that we need the points for","mandatory":true},{"name":"influencer team","description":"Influencer teams to compare the points against","mandatory":true},{"name":"vis team","description":"Team mask to use for enemy vis tests","mandatory":true},{"name":"player","description":"Player that we want the points for. The first parameter will still be used for the team.","mandatory":false},{"name":"predictedSpawn","description":"true if this is a predicted spawn request (used by texture streaming).","mandatory":false},{"name":"array of lists","description":"if provided, the spawn point will be chosen from one of these lists. If a list is disabled already for a given team, it will not be considered.","mandatory":false}]}]},{"name":"GetBitsForAngle","description":"Gets the compressed bits for an angle with granularity","example":"bits = GetBitsForAngle( angle, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetBrushModelCenter","description":"Get the center of the Brush Model entity","example":"center = GetBrushModelCenter( self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The brush model entity","mandatory":true}]}]},{"name":"GetBuildKitAttachmentCosmeticVariantIndexes","description":"Get attachment cosmetic variant indexes for the weapon from the player's build kit","example":"acvi = self GetBuildKitAttachmentCosmeticVariantIndexes( ar_standard )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"weapon object","mandatory":true},{"name":"upgraded","description":"bool whether this should be the upgraded version. If so extclip and fmj will be added","mandatory":false}]}]},{"name":"GetBuildKitWeapon","description":"Get weapon object (including attachments) for the weapon from the player's build kit","example":"weapon = self GetBuildKitWeapon( ar_standard )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"weapon object","mandatory":true},{"name":"upgraded","description":"bool whether this should be the upgraded version. If so extclip and fmj will be added","mandatory":false}]}]},{"name":"GetBuildKitWeaponOptions","description":"Get weapon options for the weapon from the player's build kit","example":"weapon_options = self GetBuildKitWeaponOptions( ar_standard, packapunch_camo_index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"weapon object","mandatory":true},{"name":"camo_index","description":"camo index to override the one from the build kit, typically a packapunch camo index","mandatory":false}]}]},{"name":"GetCamAnimTime","description":"Gets the duration of an xcam in milliseconds.","example":"GetCamAnimTime( \"proto_melee_cam\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cam_anim","description":"The animation to play","mandatory":true}]}]},{"name":"GetCentroid","description":"Gets the centroid of an entity","example":"centroid = self GetCentroid()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetCharacterAssetName","description":"Returns the asset name for a character for the current session mode","example":"heroName = GetCharacterAssetName( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterBodyModelColorCount","description":"Returns the body model count for a character for the current session mode","example":"heroBodyModelCount = GetCharacterBodyModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"bodyStyleIndex","description":"The index of the body style in the character","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterBodyModelCount","description":"Returns the body model count for a character for the current session mode","example":"heroBodyModelCount = GetCharacterBodyModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionMode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterBodyStyleIndex","description":"Returns the index of the body style designated by the given display name","example":"bodyStyleIndex = GetCharacterBodyStyleIndex( true, \"Technomancer\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gender","description":"Whether or not to use the male bodytype","mandatory":true},{"name":"bodyStyleDisplayName","description":"The name of the body style","mandatory":true}]}]},{"name":"GetCharacterDisplayName","description":"Returns the display name for a character for the current session mode","example":"heroName = GetCharacterDisplayName( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterFields","description":"Returns info for the character pose playerbodytype","example":"heroFields = GetCharacterFields( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterHeadRenderOptions","description":"Calculates the packed helmet render option - to be passed to SetBodyRenderOptions()","example":"helmetRenderOptions = GetCharacterHeadRenderOptions( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"headIndex","description":"The index of the character in the current game-mode's character table","mandatory":true}]}]},{"name":"GetCharacterHelmetHidesHead","description":"Returns whether or not the characters head should be hidden based on the helmet","example":"hideHead = GetCharacterHelmetHidesHead( 0, 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"helmetIndex","description":"The index of the helmet belonging to that character","mandatory":true},{"name":"sessionMode","description":"The session mode ( mp cp zm )","mandatory":true}]}]},{"name":"GetCharacterHelmetModelColorCount","description":"Returns the helmet model count for a character for the current session mode","example":"heroHelmetModelCount = GetCharacterHelmetModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"helmetStyleIndex","description":"The index of the helmet style in the character","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterHelmetModelCount","description":"Returns the helmet model count for a character for the current session mode","example":"heroHelmetModelCount = GetCharacterHelmetModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterHelmetRenderOptions","description":"Calculates the packed helmet render option - to be passed to SetBodyRenderOptions()","example":"helmetRenderOptions = GetCharacterHelmetRenderOptions( 0, 1, 1, 2, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"helmetIndex","description":"The index of the helmet belonging to that character","mandatory":true},{"name":"colorIndex1","description":"The index of accent color 1","mandatory":true},{"name":"colorIndex2","description":"The index of accent color 2","mandatory":true},{"name":"colorIndex3","description":"The index of accent color 3","mandatory":true}]}]},{"name":"GetCharacterModeRenderOptions","description":"Calculates the packed mode render option - to be passed to SetBodyRenderOptions()","example":"modeRenderOptions = GetCharacterModeRenderOptions( SESSIONMODE_MULTIPLAYER )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"session_mode","description":"Session Mode enum index","mandatory":true}]}]},{"name":"GetClassIndexFromName","description":"Gets the index in a particular class","example":"GScr_GetClassIndexFromName( \"CLASS_SMG\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetClientFieldVersion","description":"Returns the version of the specifiec client field, in the specified client field set - or 0 if the field isn't registered.","example":"if(GetClientFieldVersion( \"world\", \"fog_volume_active\" ))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetClosestPointOnNavMesh","description":"Get a point on NavMesh that's closest to the given position within radius. Returns the adjusted position if found one, or undefined if not found. If distFromBoundary is defined, the point found on NavMesh will then be moved again to get it away from boundary","example":"posOnNavMesh = GetClosestPointOnNavMesh( (10,20,30), 25, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to start the search around.","mandatory":true},{"name":"searchRadius","description":"Radius to search within. If not provided, a default value proximately equal to player size will be used.","mandatory":false},{"name":"distFromBoundary","description":"Distance to keep away from NavMesh boundary. This distance can NOT be guaranteed. If not provided, it will be treated as 15 (AI default radius).","mandatory":false},{"name":"materialFlags","description":"the flags marking whether a face type can be used","mandatory":false}]}]},{"name":"GetClosestPointOnNavVolume","description":"Get a point on nav volume that's closest to the given position within radius. Returns the adjusted position if found one, or undefined if not found.","example":"posOnNavVolume = self GetClosestPointOnNavVolume( (10,20,30), 25 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"flying_ai","description":null},"parameters":[{"name":"position","description":"Position to start the search around.","mandatory":true},{"name":"searchRadius","description":"Radius to search within. If not provided, a default value proximately equal to player size will be used.","mandatory":false}]}]},{"name":"GetContractName","description":"Gets the name of the specified contract","example":"contractName = GetContractName( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"Contract ID","mandatory":true}]}]},{"name":"GetContractRequiredCount","description":"Gets the required count for the specified contract","example":"contractName = GetContractRequiredCount( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"Contract ID","mandatory":true}]}]},{"name":"GetContractRequirements","description":"Returns an array of contract requirements. Each requirement takes up two indices, 'reqType' and 'reqData'.","example":"mapNames = GetContractRequirements( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"The index of the contract","mandatory":true}]}]},{"name":"GetContractResetConditions","description":"Gets the reset conditions of the specified contract","example":"resetConditions = GetContractResetConditions( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"Contract ID","mandatory":true}]}]},{"name":"GetControllerType","description":"returns the controller type of the player","example":"player GetControllerType()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetCorpseAnim","description":"Get the animation that the corpse will play","example":"deathAnim = self GetCorpseAnim()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCorpseArray","description":"Returns an array of all of the items in a level.","example":"origins = GetCorpseArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetCounterTotal","description":"Gets the counter count for the given counter","example":"count = GetCounterTotal( \"global_comebacks\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"counterType","description":"The counter type","mandatory":true}]}]},{"name":"GetCoverNodeArray","description":"Gets an array of cover nodes within given radius","example":"node = GetCoverNodeArray( self.origin, 256 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"search origin","mandatory":true},{"name":"radius","description":"radius to search within","mandatory":true}]}]},{"name":"GetCrateHeadObjective","description":"Returns the equipment head objective as described in the grenadeweapon gdt.","example":"crateObjective = GetCrateHeadObjective( uav )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetCurrentEventId","description":"Gets the id from the current event.","example":"eventId = self GetCurrentEventId()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventName","description":"Gets the name of the current event.","example":"eventId = self GetCurrentEventName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventOriginator","description":"Gets the originator from the current event if any","example":"target = self GetCurrentEventOriginator()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventType","description":"Gets the type from the current event.","example":"type = self GetCurrentEventType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventTypeName","description":"Gets the type string name from the current event.","example":"type = self GetCurrentEventTypeName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentGunRank","description":"Get the gun current rank","example":"rank - GetCurrentGunRank(0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"index","description":"the index of the gun to get","mandatory":true}]}]},{"name":"GetCustomTeamName","description":"Get the team name","example":"name = GetCustomTeamName( teamid )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"teamid","description":"TeamID","mandatory":true}]}]},{"name":"GetCyberComAbilityName","description":"Gets the cybercom ability name given the flag, type","example":"GetCyberComAbilityName( flag, type )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"flag field","mandatory":true}]}]},{"name":"GetCyberComWeapon","description":"Gets the cybercom gadget weapon given the flag, type, and if upgraded","example":"GetCyberComWeapon( flag, type, upgraded )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"flag field","mandatory":true},{"name":"type","description":"type of weapon","mandatory":true},{"name":"upgraded","description":"true if the weapon is upgraded","mandatory":true}]}]},{"name":"GetDamageableEntArray","description":"Returns the entities that can be damaged. Can optionally take an origin, radius, and a flag to check 3D.","example":"entities = GetDamageableEntArray( maxDist, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"origin to check against","mandatory":false},{"name":"radius","description":"max distance to origin","mandatory":false},{"name":"checkZ","description":"if true then check distance in 3d","mandatory":false}]}]},{"name":"GetDebugEye","description":"Gets the debug position of the eye for an AI or Player","example":"eyePos = player GetDebugEye()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player or actor","description":null},"parameters":[]}]},{"name":"GetDecorations","description":"Gets an array of booleans that represents all the decorations the player has earned","example":"medals = e_player GetDecorationsEarned()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":" only_decorations_earned ","description":"Only get the decorations that the player has earned","mandatory":false}]}]},{"name":"GetDefaultClassSlot","description":"Gets the item in a particular default class slot","example":"GetDefaultClassSlot( \"cqb\", \"primary\" ); // Returns primary weapon reference","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"classname","description":"the classname of the item","mandatory":true},{"name":"slotname","description":"The slot to check","mandatory":true}]}]},{"name":"GetDroppedWeapons","description":"Returns an array containing all the dropped weapons in the level","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetEnemies","description":"Returns an array of enemies.","example":"enemies = self GetEnemies()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEnt","description":"Looks up entities by key and name","example":"spawner = GetEnt( \"doorguy1\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true},{"name":"ignore spawners","description":"if true then you won't get a spawner back","mandatory":false}]}]},{"name":"GetEntArray","description":"Looks up entities by key and name and a return an array of the matched entities","example":"spawners = GetEntArray( \"doorguy1\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":false},{"name":"key","description":"key that name goes with","mandatory":false},{"name":"ignore spawners","description":"if true then you won't get a spawner back","mandatory":false}]}]},{"name":"GetEntArrayFromArray","description":"Searches given array entities by key and name and a return an array of the matched entities","example":"spawners = GetEntArrayFromArray( array, \"doorguy1\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array of entities","mandatory":true},{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true}]}]},{"name":"GetEntByNum","description":"Gets an entity from its entity number","example":"entity = GetEntByNum( entnum )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity number","description":"(integer) The number of the entity to get","mandatory":true}]}]},{"name":"getEnterButton","description":"Gets the enter button.","example":"getEnterButton()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetEntityAnimRate","description":"get the entity animation rate - ZOMBIES ONLY","example":"rate = self GetEntityAnimRate()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEntityNumber","description":"Get the entity number of the entity","example":"hitEntNum = hitEnt getEntityNumber()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEntityType","description":"Get the type of entity","example":"inflictorEntType = grenade getEntityType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEntNavMaterial","description":"get NavMesh material at where the entity stands","example":"material = GetEntNavMaterial( ai_actor )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"ai_or_vehicle","description":"An AI character or an AI vehicle","mandatory":true}]}]},{"name":"GetEntNum","description":"Get the entity number for this entity","example":"self GetEntNum()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEquipmentHeadObjective","description":"Returns the equipment head objective as described in the grenadeweapon gdt.","example":"headObjective = GetEquipmentHeadObjective( bouncingbettty )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetEventPointOfInterest","description":"Gets the point of interest from the current event.","example":"point = self GetEventPointOfInterest()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetEye","description":"Get the eye position of the entity.","example":"eye_pos = self GetEye()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEyeApprox","description":"Get the eye position of the entity with some added offset.","example":"approx_eye_pos = self GetEyeGetEyeApprox()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetFirstTouchFraction","description":"Returns the trace fraction of a capsule trace against the other entity","example":"fraction = GetFirstTouchFraction( player, trigger, old_origin, current_origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other entity","description":"Entity to check against","mandatory":true},{"name":"start","description":"Starting point of the trace","mandatory":true},{"name":"end","description":"Ending point of the trace","mandatory":true}]}]},{"name":"GetFlowGraphDef","description":"returns a struct representing the flow graph definition asset","example":"flowGraphDef = GetFlowGraphDef( \"my_flow_graph\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The name of the flow graph asset","mandatory":true}]}]},{"name":"GetFogSettings","description":"Get the current fog settings as an array.","example":"fogsettings = getfogsettings()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetFreeActorCount","description":"Get number of free actors.","example":"GetFreeActorCount()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetFreerunTrackIndex","description":"Returns the unique id for this mission","example":"level.index = GetFreerunTrackIndex( \"mp_Freerun_01\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetGameTypeEnumFromName","description":"Returns the enum value corresponding to the current game type from global leaderboard gametype entries.","example":"gameTypeEnum = GetGameTypeEnumFromName( \"tdm\", false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gameTypeName","description":"game type name e.g. \"tdm\".","mandatory":true},{"name":"isHardcore","description":"True if the hardcore mode is on","mandatory":true}]}]},{"name":"GetGametypeSetting","description":"Gets the value of a gametype setting.","example":"GetGametypeSetting( \"scoreLimit\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"setting","description":"The setting name as a string.","mandatory":true}]}]},{"name":"GetGrappleTargetArray","description":"Returns an array of all of the grapple targets","example":"enemies = GetGrappleTargetArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetGroundEnt","description":"Gets the entity beneath the calling entity","example":"ground_ent = self GetGroundEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetInfluenceAt","description":"Returns the influence value at the origin position on the influence map, undefined if no value can be found.","example":"GetInfluenceAt(influenceMapIndex, origin)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influenceMapIndex","description":"Index of the influence map","mandatory":true},{"name":"origin","description":"The location to check for influence value","mandatory":true}]}]},{"name":"GetInfluenceFacePos","description":"Returns the faces pos on the influence map","example":"pos = GetInfluenceFacePos( faceIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetInfluenceNumFaces","description":"Returns the number faces on the influence","example":"numFaces = GetInfluenceNumFaces()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetInfluencerPreset","description":"Adds a new influencer of at and ","example":"preset_array = GetInfluencerPreset( name )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true}]}]},{"name":"GetInfluencerTimeoutRemaining","description":"Gets the remaining influencer timeout in milliseconds. Returns a negative number if no timeout.","example":"GetInfluencerTimeout( influencer_id )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer id","mandatory":true}]}]},{"name":"GetInterestPoolAwareness","description":"Gets the current interest pool awareness level regardless of actual awareness level.","example":"interestAwareness = self GetInterestPoolAwareness()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[]}]},{"name":"GetInterestPoolValue","description":"Gets the sentient's interest pool value.","example":"value = self GetInterestPoolValue()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetItemArray","description":"Returns an array of all of the items in a level.","example":"origins = GetItemArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetItemAttachment","description":"Gets the attachment for a particular item","example":"GetItemAttachment( 10, 1 ); // returns attachment 1 for item 10","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"The item index","mandatory":true},{"name":"attachmentNum","description":"The attachment number for the index","mandatory":true}]}]},{"name":"GetItemAttachmentAllocationCost","description":"Gets the allocation cost of an attachment for a particular item","example":"GetItemAttachmentAllocationCost( 10, 1 ); // returns allocation cost of attachment 1 for item 10","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"The item index","mandatory":true},{"name":"attachmentNum","description":"The attachment number for the index","mandatory":true}]}]},{"name":"GetItemGroupFromItemIndex","description":"Returns the ref for a specified item index","example":"ref = GetItemGroupFromItemIndex( itemIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"Item index","mandatory":true}]}]},{"name":"GetLastOutWaterTime","description":"Returns the last time the player was not completely submerged","example":"time = player GetLastOutWaterTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLightColor","description":"Gets the current color of the light, as an RGB vector.","example":"color = self GetLightColor()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightExponent","description":"Gets the current exponent of the light.","example":"exponent = self GetLightExponent()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightFovOuter","description":"Gets the current outer fov of a spot light.","example":"fov = self GetLightFovOuter()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightIntensity","description":"Gets the current intensity of the light.","example":"intensity = self GetLightIntensity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightRadius","description":"Gets the current radius of the light.","example":"radius = self GetLightRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLinkedEnt","description":"Get the entity that the calling entity is linked to","example":"linked_ent = self GetLinkedEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetLoadoutAllocation","description":"Get how many allocation points are spent in the custom class","example":"allocationSpent = self GetLoadoutAllocation( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"GetLoadoutGunSmithVariantIndex","description":"Get the GunSmith Variant index of the primary weapon, pass 1 as an option to get the secondary","example":"gunSmithPrimaryIndex = self GetLoadoutGunSmithVariantIndex( 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"getSecondary","description":"defaults to false, if set will get you the variant index of the secondary","mandatory":false}]}]},{"name":"GetLoadoutItem","description":"Get the index of the item in the custom class","example":"primary = self GetLoadoutItem( 0, primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot","mandatory":true}]}]},{"name":"GetLoadoutItemRef","description":"Get the reference of the item in the custom class","example":"primary = self GetLoadoutItemRef( 0, primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot","mandatory":true}]}]},{"name":"GetLoadoutPerks","description":"Get the list of specialties in the custom class","example":"primary = self GetLoadoutPerks( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"GetLoadoutWeapon","description":"Get the full weapon name (including attachments) of the item in the custom class","example":"primary = self GetLoadoutWeapon( 0, primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot (primary or secondary)","mandatory":true}]}]},{"name":"GetLobbyClientCount","description":"Returns the number of connected or connecting clients","example":"clientCount = GetClientCount()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMapAtIndex","description":"Get the name of the map at the given index in a mode's maptable. Returns undefined if the given index doesn't index the given maptable","example":"GetMapAtIndex( \"cp_mi_sing_blackstation\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"index","description":"the index of the map you're looking for.","mandatory":true},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapFields","description":"Get the outro movie of the current map in the maptable. Returns undefined if currentmap wasn't found","example":"fields = GetMapFields( GetNextMap(\"cp_mi_sing_blackstation\") )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapIntroMovie","description":"Get the intro movie of the current map in the maptable. Returns undefined if currentmap wasn't found","example":"world.nextIntroMovie = GetMapIntroMovie( GetNextMap(\"cp_mi_sing_blackstation\") )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapOrder","description":"Get the index of the current map in the maptable. Returns -1 if currentmap wasn't found","example":"if( GetMapOrder( \"cp_mi_sing_blackstation\" ) > GetMapOrder( world.highestMapCompletion ) { world.highestMapCompletion = \"cp_mi_sing_blackstation\"; }","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapOutroMovie","description":"Get the outro movie of the current map in the maptable. Returns undefined if currentmap wasn't found","example":"world.nextOutroMovie = GetMapIntroMovie( GetNextMap(\"cp_mi_sing_blackstation\") )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMaxs","description":"Get maximum bounds of the entity","example":"maxs = wallModel GetMaxs()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetMaxVehicles","description":"Return the maximum number of vehicles that can be instantiated simultaneously. This is platform-specific.","example":"vehicleSlotsFree = GetMaxVehicles() - level.vehicles_list.size","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMeleeChainCount","description":"Gets the number of melee kills achieved by the player within their current streak.","example":"entity GetMeleeChainCount( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"getmicrosecondsraw","description":"Gets raw system microseconds; used for profiling, only gives lower 32 bits as script doesn't support uint64_t properly right now","example":"start_time = GetMicrosecondsRaw()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMillisecondsRaw","description":"Gets raw system milliseconds; use for profiling long routines as it is only an integer","example":"start_time = GetMillisecondsRaw()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMins","description":"Get minimum bounds of the entity","example":"mins = wallModel GetMins()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetMissileOwner","description":"Returns the entity that owns this missile","example":"javelinOwner = GetMissileOwner( thisMissile )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[]}]},{"name":"GetMissionName","description":"Returns the name of the mission this map is part of","example":"level.mission = GetMissionName( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetMissionUniqueID","description":"Returns the unique id for this mission","example":"level.unique_id = GetMissionUniqueID( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetMissionVersion","description":"Returns the unique id for this mission","example":"level.unique_id = GetMissionVersion( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetMoveDelta","description":"Gets the move delta for the animation","example":"localDeltaVector = GetMoveDelta( animation, 0, 1, entity )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation name","description":"Name of the animation","mandatory":true},{"name":"start time","description":"Normalized start time of the animation","mandatory":false},{"name":"end time","description":"Normalized end time of the animation","mandatory":false},{"name":"entity","description":"The entity should be passed if the animation name is a string to look up the animation from the entity's anim tree","mandatory":false}]}]},{"name":"GetMoverEnt","description":"Gets the moving entity the player is sitting on .","example":"if(player GetMoverEnt())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetMoveSpeedScale","description":"Gets the speed scale multiplier for the entity","example":"speed_modifier = self GetMoveSpeedScale()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetNavMeshFaceNormal","description":"Returns the face normal vector of the closest navmesh point to the passed in position, within the search radius.","example":"navmeshNormal = GetNavMeshFaceNormal( (10,20,30), 25 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to start the search around.","mandatory":true},{"name":"searchRadius","description":"Radius to search within.","mandatory":true}]}]},{"name":"GetNavMeshTriggersForPoint","description":"Returns a list of the names of navmesh triggers that a given point resides in","example":"targetNames = GetNavMeshTriggersForPoint( pos )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"The test position.","mandatory":true}]}]},{"name":"GetNearestNode","description":"Returns the node nearest to this origin or undefined if no close node exists.","example":"node = GetNearestNode( guy.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"location to search for the nearest node","mandatory":true}]}]},{"name":"GetNearestPathPoint","description":"Returns the nearest point on the navmesh for the given origin and radius or undefined if no point can be found.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The point from which to search from","mandatory":true},{"name":"radius","description":"The maximum radius in which to search","mandatory":true}]}]},{"name":"GetNextMap","description":"Get the name of the next map in the maptable. Returns \"\" if this is the last map, undefined if currentmap wasn't found","example":"GetNextMap( \"cp_mi_sing_blackstation\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetNextTraversalNodeOnPath","description":null,"example":"GetNextTraversalNodeOnPath(1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"the index for the starting node","mandatory":true}]}]},{"name":"GetNode","description":"Gets a node with the given name, key pair","example":"node = GetNode( self.target, \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true}]}]},{"name":"GetNodeArray","description":"Gets an array of nodes that have the given name, key pair","example":"node = GetNodeArray( self.target, \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true}]}]},{"name":"GetNodeArraySorted","description":"Gets an array of nodes that have the given name, key pair, within given radius, sorts them","example":"nodes = GetNodeArraySorted(self.target, \"targetname\", self.origin, 256 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true},{"name":"pos","description":"search origin","mandatory":true},{"name":"r","description":"the radius to sort in","mandatory":true}]}]},{"name":"GetNodeEdge","description":"Returns an array of points which corresponds to the node volume's traversal edge. The traversal edge is represented as a piecewise linear function.","example":"points = GetNodeEdge( myNode )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"node volume","mandatory":true}]}]},{"name":"GetNodeIndexOnPath","description":null,"example":"GetNodeIndexOnPath(node)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to get the other node for","mandatory":true}]}]},{"name":"GetNodeOwner","description":"Get the owner of the node.","example":"node_owner = GetNodeOwner( node ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"which node to get the owner of.","mandatory":true}]}]},{"name":"GetNodeRegion","description":"Returns the region of the give node, if there is one. Returns undefined otherwise.","example":"if ( GetNodeRegion( myNode ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"pathnode to check","mandatory":true}]}]},{"name":"GetNodesInRadius","description":"Gets all of the nodes (max of 256) within a cylinder, in unsorted order","example":"nodes = GetNodesInRadius( guy.origin, 512, 0, 128, \"Path\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"location to search for nodes at","mandatory":true},{"name":"max radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"min radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"max height","description":"maximum height difference to origin. Defaults to 512","mandatory":false},{"name":"node type","description":"node type to search for, if not specified, returns all node types. 'Cover' will return all cover nodes","mandatory":false},{"name":"max nodes","description":"the maximum number of nodes to return up to 256","mandatory":false},{"name":"region index","description":"the region index the nodes should belong to","mandatory":false}]}]},{"name":"GetNodesInRadiusSorted","description":"Gets all of the nodes (max of 256) within a cylinder, sorted by closest to ","example":"nodes = GetNodesInRadiusSorted( guy.origin, 512, 0, 128, \"Path\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"location to search for nodes at","mandatory":true},{"name":"max radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"min radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"max height","description":"maximum height difference to origin. Defaults to 512","mandatory":false},{"name":"node type","description":"node type to search for, if not specified, returns all node types. 'Cover' will return all cover nodes","mandatory":false},{"name":"max nodes","description":"the maximum number of nodes to return up to 256","mandatory":false}]}]},{"name":"GetNormalHealth","description":"Get health in a normalized range of 0 to 1","example":"normal_health = self GetNormalHealth()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetNorthYaw","description":"Get North Yaw","example":"northvector = (cos(getnorthyaw()), sin(getnorthyaw()), 0)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetNotetracksInDelta","description":"Get a list of notetracks and times within a specific time delta of a specific time in an animation","example":"notetrackArray = GetNotetracksInDelta( anim, 0.4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"the animation for which notetrack information is needed","mandatory":true},{"name":"time","description":"The time in the animation around which notetrack information is needed in the range 0-1","mandatory":true},{"name":"time_delta","description":"The amount of time around the time provided to check for notetracks in seconds defaults to 0.15","mandatory":false}]}]},{"name":"GetNotetrackTimes","description":"Gets an array of the times during an animation that the given notetrack occurs. The times returned are fractional (0 to 1).","example":"exitAlignTimes = GetNotetrackTimes( exitAnim, \"exit_align\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"an animation","mandatory":true},{"name":"note track","description":"a constant string with the name of the note track","mandatory":true}]}]},{"name":"GetNumberOfCollectiblesForLevel","description":"Returns the number of collectibles for the given level","example":"collectibleCount = GetNumberOfCollectiblesForLevel( GetRootMapName() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetNumChallengesComplete","description":"Returns the number of challenges completed in a given mission","example":"is_default = self GetNumChallengesComplete( \"angola\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"mission_name","description":"(string) The name of the mission to check completed challenges in","mandatory":true}]}]},{"name":"GetNumConnectedPlayers","description":"Returns the number of players that are connected to our game. Ignores bots by default.","example":"num_players_and_bots = GetNumConnectedPlayers( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"include bots","description":"The optional check to include test clients (bots). (bool)","mandatory":false}]}]},{"name":"GetNumExpectedPlayers","description":"Returns the number of players that we're expecting to join our game.","example":"num_players = GetNumExpectedPlayers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetNumParts","description":"Return number of bones in the model","example":"numParts = GetNumParts( model )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"model","description":"The model to get parts for","mandatory":true}]}]},{"name":"GetNumZBarrierPieces","description":"Returns number of pieces in specified zbarrier ent.","example":"numPieces = ent GetNumZBarrierPieces())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetOrigin","description":"Get the origin of the entity.","example":"origin = self GetOrigin()","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":{"name":"entity","description":"The entity to get the origin of.","type":{"dataType":"struct","instanceType":"entity","isArray":false}},"parameters":[],"returns":{"name":"origin","type":{"dataType":"vec3","instanceType":null,"isArray":false},"description":"The origin of the entity as a 3D vector."}}]},{"name":"GetOtherNodeInNegotiationPair","description":"Returns the other node of the passed in negotiation node. Returns the begin node if end is passed and vice versa.","example":"end_node = GetOtherNodeInNegotiationPair( begin_node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to get the other node for","mandatory":true}]}]},{"name":"GetPartName","description":"Get the bone name for the model and index","example":"boneName = GetPartName( model, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"model","description":"The model to get parts for","mandatory":true},{"name":"index","description":"The bone index","mandatory":true}]}]},{"name":"GetPathfindingRadius","description":"Returns the radius used for pathfinding operations.","example":"radius = ent GetPathfindingRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetPathMetric","description":"Get path metric for the path from the ai to origin","example":"path_metric = level.ai_for_pathing GetPathMetric( dropPos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"origin","description":"the goal for the path","mandatory":true}]}]},{"name":"GetPlayerGravity","description":"Gets the gravity or gravity override value for the player.","example":"player GetPlayerGravity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayers","description":"Returns an array of the currently connected players.","example":"players = GetPlayers()","flags":["verified"],"remarks":["When used without the team parameter, this function is analogous to the variable `level._players` and can be used interchangeably."],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"If specified, returns a list of players on a specific team. Valid values: `allies`, `axis`, `neutral`, and `all`.","mandatory":false,"type":{"dataType":"string"}}],"returns":{"name":"players","type":{"dataType":"struct","instanceType":"player","isArray":true},"description":"A list of connected players."}}]},{"name":"GetPlayerSelectedGestureName","description":"Get the equipped gesture animation name","example":"gesture = player GetPlayerSelectedGestureName( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"gestureType","description":"The type of gesture to get","mandatory":true}]}]},{"name":"GetPlayerSelectedTauntName","description":"Get the equipped taunt animation name","example":"taunt = player GetPlayerSelectedTauntName( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"tauntType","description":"The type of taunt to get","mandatory":true}]}]},{"name":"GetPlayerSpawnId","description":"Returns the current spawn id for the player (used for debugging purposes only)","example":"spawnId = GetPlayerSpawnId( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player that we are spawning in","mandatory":true}]}]},{"name":"GetPlayerSpeed","description":"Gets the speed value for the player.","example":"player GetPlayerSpeed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPointInBounds","description":"Returns a point within an entity's bounds.","example":"targetForwardPnt = helo GetPointInBounds( 1.0, 0.0, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"ratio_ForwardBack","description":"1.0 is full forward, -1.0 is full backwards.","mandatory":true},{"name":"ratio_LeftRight","description":"1.0 is full left, -1.0 is full right.","mandatory":true},{"name":"ratio_UpDown","description":"1.0 is full up, -1.0 is full down.","mandatory":true}]}]},{"name":"GetRandomCompatibleAttachmentsForWeapon","description":"Returns an array of compatible attachments. If num desired attachments are specified then that many attachments will be returned if possible","example":"GetRandomCompatibleAttachmentsForWeapon( weaponObject, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon name.","mandatory":true},{"name":"num desired attachments","description":"Max number of compatible attachments desired. If the number is more than available attachments for the weapon, it will just not return that many.","mandatory":false}]}]},{"name":"GetRandomPointOnNavVolume","description":"Get a random point on nav volume. Returns the position if found one, or undefined if not found.","example":"random = self GetRandomPointOnNavVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"flying_ai","description":null},"parameters":[]}]},{"name":"GetRefFromItemIndex","description":"Returns the ref for a specified item index","example":"ref = GetRefFromItemIndex( itemIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"Item index","mandatory":true}]}]},{"name":"GetReflectionLocs","description":"Gets array of the locations of all of the reflection_probes in the level","example":"reflection_locs = GetReflectionLocs()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetReflectionOrigin","description":"Given a position, returns the position of the reflection probe in use there","example":"probe_pos = GetReflectionOrigin( camera_pos )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetRetrievableWeapons","description":"Returns an array of weapons that need watchers so they can be retrieved by the player.","example":"retrievableWeapons = GetRetrievableWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetRootMapName","description":"Returns the root map of a mission","example":"level.rootMap = GetRootMapName( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetRoundsPlayed","description":"Get rounds played in match state","example":"GetRoundsPlayed( game[\"roundsplayed\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"The number of rounds played","mandatory":true}]}]},{"name":"GetScriptBundle","description":"Returns the script bundle struct.","example":"settings = GetScriptBundle( \"doorsettings\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptBundleList","description":"Returns the script bundle list array.","example":"settings = GetScriptBundleList( \"doorsettings\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptBundleNames","description":"Returns all the names of the script bundles of the specified type in an array.","example":"settings = GetScriptBundleNames( \"scene\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptBundles","description":"Returns a list of script bundles based on the type.","example":"settings = GetScriptBundles( \"scenes\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptMoverArray","description":"Returns an array of all of the script_origins in a level.","example":"origins = GetScriptMoverArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetShootAtPos","description":"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":"targetPos = self.enemy GetShootAtPos(self)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"attacker","description":"The entity that will be shooting","mandatory":false}]}]},{"name":"GetSkiptoName","description":"Get the skip to name with the given index","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetSkipTos","description":"Get all skip tos for the level","example":"skiptos = GetSkipTos()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetSnapshotIndexArray","description":"Returns an array of the indices of current snapshots for all connected clients.","example":"snapindices = GetSnapshotIndexArray( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetSpawnerArray","description":"Returns an array of all of the spawners in a level.","example":"spawners = GetSpawnerArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetSpawnerTeamArray","description":"Returns an array of all of the spawners in a level","example":"enemies = GetSpawnerTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetSpawnStructForCharacter","description":"Returns the targetname of the script_struct to use for the character pose in the frontend","example":"frontendVignetteAnim = GetSpawnStructForCharacter( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetSpecialistIndex","description":"Returns the specialist index for the player","example":"specialistIndex = player GetSpecialistIndex()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetStance","description":"Gets the stance of the player. It only works for the player.","example":"stance = player GetStance()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetStartAngles","description":"Get the starting angles for an animation, in world coordinates, given its current position, and angles","example":"org1 = GetStartAngles( climborg, climbang, buddyanim1, [0.5] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The current origin of the animation in world coordinates","mandatory":true},{"name":"angle","description":"The current angle set of the animation in world coordinates","mandatory":true},{"name":"animation","description":"The currently running animation","mandatory":true},{"name":"animation time","description":"The animation time in 0-1 range","mandatory":false}]}]},{"name":"GetStartOrigin","description":"Get the starting origin for an animation, in world coordinates, given its current position, and angles","example":"org1 = GetStartOrigin( climborg, climbang, buddyanim1, [0.5] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The current origin of the animation in world coordinates","mandatory":true},{"name":"angle","description":"The current angle set of the animation in world coordinates","mandatory":true},{"name":"animation","description":"The currently running animation","mandatory":true},{"name":"animation time","description":"The starting animation time in 0-1 range","mandatory":false}]}]},{"name":"GetStartTime","description":"Returns the start time for the current round.","example":"GetStartTime()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetStowedWeapon","description":"Gets the stowed weapon for the player","example":"stowed = self GetStowedWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTagAngles","description":"Gets the angles of the tag","example":"angles = self GetTagAngles( \"tag\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTagOrigin","description":"Gets the origin of the tag","example":"origin = self GetTagOrigin( \"tag\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTargetEntity","description":"Gets the target entity of this turret or vehicle weapon","example":"target = roof_turret GetTargetEntity( ); target = tank GetTargetEntity( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"gunnerIndex","description":"the gunner index if called on a vehicle","mandatory":false}]}]},{"name":"GetTargetOrigin","description":"Gets the target origin of this turret or vehicle weapon","example":"origin = roof_turret GetTargetOrigin( ); origin = tank GetTargetOrigin( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"gunnerIndex","description":"the gunner index if called on a vehicle (integer)","mandatory":false}]}]},{"name":"GetTeam","description":"Return true if the team of an entity if it can be found, undefined otherwise.","example":"orig_team = self GetTeam()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTeamPlayersAlive","description":"Returns the number of players still alive on a given team","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"A string value, either 'axis' or 'allies' or 'team3'","mandatory":true}]}]},{"name":"GetTeamSatellite","description":"Gets whether a team has Satellite or not","example":"GetTeamSatellite( \"allies\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true}]}]},{"name":"GetTeamScore","description":"Get a team's score","example":"if ( GetTeamScore( \"allies\" ) > getTeamScore(\"axis\") ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true}]}]},{"name":"GetTeamSpyplane","description":"Gets whether a team has Spyplane or not","example":"GetTeamSpyplane( \"allies\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true}]}]},{"name":"GetTime","description":"Gets the level time in Milliseconds from the start of the level.","example":"nextNodeTime = GetTime() + 500","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetTotalServerPauseTime","description":"Gets the total time the server has been paused since the map started.","example":"val = GetTotalServerPauseTime()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"gettotalunlockedweaponattachments","description":"Get total number of attachments that are unlocked for the weapon specified","example":"player GetTotalUnlockedWeaponAttachements( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon","mandatory":true}]}]},{"name":"GetTouchingVolume","description":"Get the entities that are inside the bounds given","example":"entities = GetTouchingVolume( self.origin, mins, maxs )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Position of bounding box","mandatory":true},{"name":"mins","description":"The minimum extents of the bounding box","mandatory":true},{"name":"maxs","description":"The maximum extents of the bounding box","mandatory":true}]}]},{"name":"GetTriggerAccumulate","description":"Returns the accumulate value from the trigger","example":"self GetTriggerAccumulate()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"GetTurretArcLimits","description":"Return turret info for arc mins and maxs","example":"limits turret GetTurretArcLimits()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"GetTurretOwner","description":"Gets the \"owner\" of this turret","example":"turret_user = roof_turret GetTurretOwner()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"GetTurretTarget","description":"Gets the current target of this turret","example":"target = roof_turret GetTurretTarget()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"GetUpgradedPieceNumLives","description":"Returns the number of lives, or pull reps it should take a zombie to dislodge this piece, if it's upgraded.","example":"piece.numLives = ent GetUpgradedPieceNumLives(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetUTC","description":"Gets the UTC time.","example":"val = GetUTC()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetValidCoverPeekOuts","description":"Returns an array of directions an AI can peek out from a cover node. Possible values are 'over', 'left', and 'right'.","example":"GetValidCoverPeekOuts( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"pathnode","description":null},"parameters":[]}]},{"name":"GetVehicleArray","description":"Returns an array of all of the vehicles in a level","example":"enemies = GetVehicleArray( \"drones\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetVehicleSpawnerArray","description":"Returns an array of all of the vehicle spawners in a level","example":"enemies = GetVehicleSpawnerArray( \"bob\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetVehicleSpawnerTeamArray","description":"Returns an array of all of the vehicle spawners in a level with the specified team","example":"enemies = GetVehicleSpawnerTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of teams names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetVehicleTeamArray","description":"Returns an array of all of the vehicles in a level that are not sentients","example":"enemies = GetVehicleTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"any number of teams names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetVehicleTriggerFlags","description":"Returns the spawn flags that will allow vehicles to activate triggers","example":"spawn(\"trigger_radius\", (0,0,0), GetVehicleTriggerFlags())","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetVelocity","description":"Returns the entity's velocity.","example":"vel = thing GetVelocity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"An entity.","mandatory":true}]}]},{"name":"GetVisibleNode","description":"Returns the farthest visible node on the path from to or undefined if no path exists.","example":"node = GetVisibleNode( guy.origin, enemy.origin, guy )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting origin of the path","mandatory":true},{"name":"end","description":"ending origin of the path","mandatory":true},{"name":"ignore entity","description":"An entity to ignore during pathnode trace checks","mandatory":false}]}]},{"name":"GetVisibleNodes","description":"Returns an array of nodes visible to this node","example":"nodes = GetVisibleNodes( cover.node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"pathnode to check","mandatory":true}]}]},{"name":"GetVrCamAngles","description":"Get the VR camera angles of the player","flags":["unlisted"],"overloads":[{"calledOn":null,"parameters":[]}],"verifiedInRevision":5},{"name":"GetVrCamPos","description":"Get the VR camera position of the player","flags":["unlisted"],"overloads":[{"calledOn":null,"parameters":[]}],"verifiedInRevision":5},{"name":"GetWallRunWallNormal","description":"Returns the normal of the wall the player is running on (or was running on)","example":"wall_normal = player GetWallRunWallNormal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetWatcherWeapons","description":"Returns array of weapons that need watchers so they will die when the player respawns","example":"watcherWeapons = GetWatcherWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetWaterHeight","description":"Returns the height of the water at this position","example":"height = getwaterheight( self.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"Query position","mandatory":true}]}]},{"name":"GetWeapon","description":"Get the requested weapon object based on game mode agnostic weapon name string.","overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the base weapon to return.","type":{"dataType":"string"},"mandatory":true},{"name":"attachmentName1","description":"The first attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName2","description":"The second attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName3","description":"The third attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName4","description":"The fourth attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName5","description":"The fifth attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName6","description":"The sixth attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false}],"returns":{"name":"weaponObject","type":{"dataType":"struct","instanceType":"weapon","isArray":false},"description":"The requested weapon object with the specified attachments."}},{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the base weapon to return.","type":{"dataType":"string"},"mandatory":true},{"name":"attachmentNames","description":"An array of attachment names to return.","type":{"dataType":"string","isArray":true},"mandatory":false}],"returns":{"name":"weaponObject","type":{"dataType":"struct","instanceType":"weapon","isArray":false},"description":"The requested weapon object with the specified attachments."}}],"example":"GetWeapon(\"ar_standard\", \"acog\")","flags":["verified"],"verifiedInRevision":3},{"name":"GetWeaponAccuracy","description":"Returns accuracy at the distance from the current enemy.","example":"getweaponaccuracy( self, \"ak47\" ), getweaponaccuracy( ai, ai.primaryweapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity. Must be AI.","mandatory":true},{"name":"weapon name","description":"The weapon name.","mandatory":true}]}]},{"name":"GetWeaponAttachments","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetWeaponForCharacter","description":"Returns the weapon at the given index","example":"modelName = GetWeaponForCharacter( 0, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetWeaponForwardDir","description":"Returns the weapon's forward direction","example":"weapon GetWeaponForwardDir()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"weapon","description":null},"parameters":[]}]},{"name":"GetWeaponModelForCharacter","description":"Returns the name of the weapon model of at the given index","example":"modelName = GetWeaponModelForCharacter( 0, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetWeaponMuzzlePoint","description":"Returns the weapon's muzzle point","example":"weapon GetWeaponMuzzlePoint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"weapon","description":null},"parameters":[]}]},{"name":"GetWeaponOptic","description":"Gets the weapon optic attachment name","example":"attachmentName = player GetWeaponOptic( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"Weapon name","mandatory":true}]}]},{"name":"GetWeaponWorldModel","description":"Returns weaopn world model","example":"model = GetWeaponWorldModel(\"lmg\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetWeaponXCam","description":"Get the weapon XCam","example":"weapon GetWeaponXCam( GetWeapon( weaponName ), \"cam_cac_weapon\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon object","description":"The weapon entity","mandatory":true},{"name":"camera","description":"The camera to get","mandatory":true}]}]},{"name":"GetXCamForCharacter","description":"Returns the name of the xcam to use for the character pose in the frontend","example":"frontendVignetteAnim = GetXCamForCharacter( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetXModelCenterOffset","description":"Calculates the offset to the center of the model from the origin","example":"offset = GetXModelCenterOffset( \"modelname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"modelname","description":"The name of the xmodel","mandatory":true}]}]},{"name":"GetXuid","description":"Gets the 64-bit Steam ID (SteamID64) of the given player.","example":"xuid = self GetXuid(1)","flags":["verified"],"verifiedInRevision":5,"overloads":[{"calledOn":{"name":"player","description":"The player to get the XUID of.","mandatory":true,"type":{"dataType":"struct","instanceType":"player"}},"parameters":[{"name":"formatToDecimal","description":"When set to `true`, the XUID is returned in decimal format. Otherwise, it is returned in hexadecimal format.","mandatory":false,"type":{"dataType":"bool"}}],"returns":{"name":"xuid","description":"A string containing the XUID of the player in the requested format.","type":{"dataType":"string"}}}]},{"name":"GetZBarrierArray","description":"Returns an array of all of the zbarrier objects in a level.","example":"zbarriers = GetZBarrierArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetZBarrierAttackSlotHorzOffset","description":"Returns the horizontal offset used to offset the position of each attack slot relative to the zbarrier object. Odd numbers will start in the center of the barrier and offset to each side. Even numbers will start each side of the center - with no central spot specified.","example":"horzOffset = ent GetZBarrierAttackSlotHorzOffset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetZBarrierNumAttackSlots","description":"Returns the number of attack slots used by this zbarrier.","example":"numSlots = ent GetZBarrierNumAttackSlots()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetZBarrierPieceAnimLengthForState","description":"Returns the length in seconds for the animation associated with the supplied state for a piece, in seconds.","example":"wait(ent GetZBarrierPieceAnimLengthForState(0, \"opening\", 0.9))","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"index","description":"The index of the piece we care about.","mandatory":true},{"name":"state","description":"Name of state of interest - choices are 'open', 'closed', 'opening', 'closing'.","mandatory":true},{"name":"scalar","description":"Scalar applied to animation length.","mandatory":false}]}]},{"name":"GetZBarrierPieceAnimState","description":"Returns the anim state name to be used for zombies tearing this board down.","example":"anim_state = ent GetZBarrierPieceAnimState(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetZBarrierPieceAnimSubState","description":"Returns the anim sub-state name to be used for zombies tearing this board down.","example":"anim_state = ent GetZBarrierPieceAnimSubState(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetZBarrierPieceIndicesInState","description":"Returns an array of integer indices of the zbarriers pieces that are in the specified state.","example":"open_pieces = ent GetZBarrierPieceIndicesInState(\"open\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"state","description":"Name of state of interest - choices are 'open', 'closed', 'opening', 'closing'.","mandatory":true}]}]},{"name":"GetZBarrierPieceState","description":"Returns the state of the piece indexed in the zbarrier ent. States are open, opening, closed and closing.","example":"pieceState = ent GetZBarrierPieceState(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetZBarrierReachThroughAttackAnimState","description":"Returns the anim state name for reach through attacks used by this zbarrier.","example":"attackStateName = ent GetZBarrierReachThroughAttackAnimState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetZBarrierTauntAnimState","description":"Returns the anim state name for taunts used by this zbarrier.","example":"tauntStateName = ent GetZBarrierTauntAnimState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"Ghost","description":"Used when the entity should be sent over the network to clients but not be drawn","example":"model Ghost()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"Gib","description":"Gib an entity","example":"self gib( \"normal\", temp_array )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"gibtype","description":"Type of gib","mandatory":true},{}]}]},{"name":"GlassRadiusDamage","description":"Damages glass in the radius","example":"GlassRadiusDamage( origin, range, max_damage, min_damage, means_of_damage )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Origin of damage","mandatory":true},{"name":"radius","description":"Radius of damage","mandatory":true},{"name":"max_damage","description":"Max damage, this is the damage at the origin","mandatory":true},{"name":"min_damage","description":"Max damage, this is the damage at the edge of the radius","mandatory":true},{"name":"means_of_death","description":"Means of death passed to the glass system from script, defaults to MOD_EXPLOSIVE","mandatory":false}]}]},{"name":"GrenadeExplosionEffect","description":"Create a grenade explosion effect at the position","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position of the fx","mandatory":true}]}]},{"name":"GroundTrace","description":"Allows script to do a point trace with MASK_SHOT + MASK_ITEM. Returns hit position, hit entity, hit surface normal.","example":"trace = GroundTrace(magicBulletOrigin.origin, eyePos, true, undefined)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"hit characters","description":"When set to true, this will trace for character hits","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true},{"name":"ignore water","description":"Optionally ignore water. (bool)","mandatory":false},{"name":"ignore glass","description":"Optionally ignore glass. (bool)","mandatory":false}]}]},{"name":"HasASM","description":"Check if this entity has an ASM.","example":"if ( HasASM( self ) ) {","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"HasPart","description":"Returns whether the entity has the given tagname as part of its skeleton.","example":"has_part = self HasPart( \"tag_weapon\", \"weapon_saw\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"tagname","description":"The tag to search for. (string)","mandatory":true},{"name":"modelname","description":"The optional model name to help specify the part location. (string)","mandatory":false}]}]},{"name":"HeliTurretDogTrace","description":"Determines if you helicopter turret can see the dog.","example":"if (0 == (copter HeliTurretSightTrace(heli_turret_point, dog, lastHit))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"place that check if you can see if being performed","mandatory":true},{"name":"dog","description":"the dog that the helicopter wants to see","mandatory":true},{"name":"hitNum","description":"if you run this more than once make sure to populate this with the return of the last as it will increase efficiency","mandatory":true}]}]},{"name":"HeliTurretSightTrace","description":"Determines if you helicopter turret can see an the players eyes.","example":"if (0 == (copter HeliTurretSightTrace(heli_turret_point, player, lastHit))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"place that check if you can see if being performed","mandatory":true},{"name":"player","description":"the player that the helicopter wants to see","mandatory":true},{"name":"hitNum","description":"if you run this more than once make sure to populate this with the return of the last as it will increase efficiency","mandatory":true}]}]},{"name":"Hide","description":"Hide the entity","example":"self Hide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"HideFromTeam","description":"Hides the entity from a particular team","example":"self HideFromTeam( friend_team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"The team to show the entity to.","mandatory":true}]}]},{"name":"hideinfovolume","description":"Stops an info volume from being drawn","example":"InfoVolumeDebug_HideVolume( info_volume GetEntityNumber() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entnum","description":"the entity number of the info volume","mandatory":true}]}]},{"name":"HideMiscModels","description":"Hide all misc models with this targetname","example":"HideMiscModels( \"crash_destruct\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"targetname of misc model(s).","mandatory":true}]}]},{"name":"HidePart","description":"Hide part of an entity.","example":"self HidePart( \"tag_weapon\", \"weapon_saw\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"tagname","description":"The tag to hide. All surfaces with a vertex weighted to the tag will be hidden and have no bullet collision. (string)","mandatory":true},{"name":"modelname","description":"The optional model name to help specify the part location. (string)","mandatory":false},{"name":"bApplyToChildren","description":"Optional flag to specify if we should apply the operation to children bones as well. (boolean)","mandatory":false}]}]},{"name":"HideZBarrierPiece","description":"Stops the indexed piece from being drawn.","example":"ent HideZBarrierPiece(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"IncrementCounter","description":"Increments the counter","example":"IncrementCounter( \"global_comebacks\", level.globalComebacks )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"counterType","description":"The counter type","mandatory":true},{"name":"increment","description":"The increment type","mandatory":true}]}]},{"name":"incrementSpecificWeaponPickedUpCount","description":"increment the count of the times we've picked up this weapon (uniquely identified by weapon+attachemnts; see function: areWeaponsEqual )","example":"self incrementSpecificWeaponPickedUpCount( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"the weapon","mandatory":true}]}]},{"name":"InfoVolumeDebugInit","description":"Initializes the info volume debug array","example":"DebugInfoVolume()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"InLastStand","description":"Check the last stand state for the client","example":"if ( self InLastStand() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"IPrintLn","description":"Writes a line of text to the bottom left corner of the screen.","example":"IPrintLn( \"Where have all the cowboys gone?\" )","flags":["verified"],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"Text to be written.","type":{"dataType":"string"},"mandatory":true}],"returns":{"void":true}}]},{"name":"IPrintLnBold","description":"Writes a line of text to the center of the screen.","example":"IPrintLnBold( \"Mitchell!\" )","flags":["verified"],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"Text to be written.","type":{"dataType":"string"},"mandatory":true}],"returns":{"void":true}}]},{"name":"IsActor","description":"Checks whether this entity is an ai character","example":"if ( IsActor( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an ai character","mandatory":true}]}]},{"name":"IsActorCorpse","description":"Checks whether this entity is an actor corpse","example":"if ( IsActorCorpse( corpse ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that might be a corpse","mandatory":true}]}]},{"name":"IsActorSpawner","description":"Checks whether this entity is an actor spawner","example":"if ( IsActorSpawner( ent ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an actor spawner","mandatory":true}]}]},{"name":"IsAI","description":"Checks whether this entity is an ai character","example":"if ( IsAI( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an ai character","mandatory":true}]}]},{"name":"IsAirborne","description":"Checks whether this entity is an airborne unit","example":"if ( IsAirborne( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object","mandatory":true}]}]},{"name":"IsAlive","description":"Checks whether this entity is alive","example":"if ( IsAlive( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that might be alive or dead","mandatory":true}]}]},{"name":"IsAnimLooping","description":"Gets whether an animation is looped or not","example":"boolLoop = IsAnimLooping( climbAnim )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"an animation that needs to be identified as a looping or not","mandatory":true}]}]},{"name":"IsArchetypeLoaded","description":"Returns true if a given archetype is loaded in the level.","example":"if ( IsArchetypeLoaded( ARCHETYPE_WARLORD ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsArenaMode","description":"Returns true if we are in arena mode","example":"if ( IsArenaMode() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsAssetLoaded","description":"Check whether or not an asset is loaded.","example":"IsAssetLoaded( \"weapon\", \"rpg\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"assetType","description":"\"weapon\" or \"material\"","mandatory":true},{"name":"assetName","description":"The name of the asset - should match zone_source","mandatory":true}]}]},{"name":"IsBonusCardActive","description":"Returns if the bonus card is enabled and active in the class, cannot be called on a larry","example":"primary = self IsBonusCardActive( BONUSCARD_PRIMARY_GUNFIGHTER_INDEX, self.class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bonuscard","description":"BonusCard index from bonuscard.gsh","mandatory":true},{"name":"classnum","description":"The current class num of the player","mandatory":true}]}]},{"name":"IsBot","description":"Returns true if the entity is a bot controlled player","example":"if( self IsBot() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsCamAnimLooping","description":"Returns whether or not a specific camera anim loop.","example":"IsCamAnimLooping( \"proto_melee_cam\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cam_anim","description":"The animation to play","mandatory":true}]}]},{"name":"IsClientCacheStable","description":"Is the players client cache stable, have we loaded all other clients' resources.","example":"player IsClientCacheStable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsCorpse","description":"Checks whether this entity is a corpse","example":"if ( IsCorpse( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that might be a corpse","mandatory":true}]}]},{"name":"IsCoverNode","description":"returns true if the node is of type NODE_TYPEFLAGS_COVER_ONLY","example":"IsCoverNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to delete","mandatory":true}]}]},{"name":"IsDangerous","description":"Returns true if the pathnode is dangerous for the given team","example":"if ( node IsDangerous( team ) ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"pathnode","description":null},"parameters":[{"name":"team","description":"Name of the team.","mandatory":true}]}]},{"name":"IsDedicated","description":"Returns true/false if we are running on the dedicated server","example":"if ( IsDedicated() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsDoubleJumping","description":"Returns true if the player is double jumping.","example":"if(player DoubleJumping())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsEMPJammed","description":"Returns true if this player is jammed by the emp, false otherwise","example":"if ( player IsEMPJammed() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsEntity","description":"Checks whether given variable is of type entity.","example":"if ( IsEntity( variable ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable to test","mandatory":true}]}]},{"name":"IsEventServiced","description":"Set the specified event to serviced.","example":"serviced = self IsEventServiced( 100 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"eventId","description":"The identifier of the event (integer)","mandatory":true}]}]},{"name":"IsFiringTurret","description":"Checks whether this turret is firing. The entity must be a turret","example":"turret IsFiringTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"IsFlared","description":"Check is a player is under the influence of a flare","example":"if ( player IsFlared() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsGadgetMeleeCharging","description":"Is the player in the process of melee charging ","example":"self IsGadgetMeleeCharging()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsGlobalStatsServer","description":"Returns true if the game is a global stats ranked server","example":"level.ranked |= IsGlobalStatsServer()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsGodMode","description":"Checks whether this entity is in god mode","example":"if ( IsGodMode( player ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object to check for god mode","mandatory":true}]}]},{"name":"IsHidden","description":"return true if entity is hidden","example":"self IsHidden()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsInSecondChance","description":"To check if player is needs revive","example":"if ( self IsInSecondChance() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsInsideHeightLock","description":"Returns whether the entity is inside the height lock or not","example":"if( self IsInsideHeightLock() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsLaserOn","description":"check if the entity has laser turned on.","example":"if ( IsLaserOn( entity ) ) { ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsLinkedTo","description":"Returns true if the entity is linked to the other entity","example":"if (ent IsLinkedTo( other )) { // dostuff }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other","description":"Entity","mandatory":true}]}]},{"name":"IsLoadingCinematicPlaying","description":"Is the player playing the loading cinematic","example":"player IsLoadingCinematicPlaying()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsLocalGame","description":"Returns true if the game local only","example":"level.local = IsLocalGame()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsMantling","description":"Return true if the player is mantling, false otherwise.","example":"self IsMantling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsMapSubLevel","description":"Returns whether or not the map is a sublevel of a mission","example":"level.isSubLevel = IsMapSubLevel( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"IsMature","description":"Checks if a player has his Graphic Content Flag is on","example":"IsMature( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to check if his Graphic Content Flag is on","mandatory":true}]}]},{"name":"ismissileinsideheightlock","description":"Returns whether the entity is inside the height lock or not","example":"if( self IsInsideHeightLock() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsMovingPlatform","description":"Returns whether platform is a moving platform or not","example":"platform IsMovingPlatform()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsNavVolumeLoaded","description":"Checks whether nav volume is loaded","example":"if ( IsNavVolumeLoaded() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsNodeEnabled","description":"returns true if the node is enabled, false otherwise","example":"IsNodeEnabled( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to check","mandatory":true}]}]},{"name":"IsNodeOccupied","description":"See if anyone has claimed a particular node.","example":"if ( IsNodeOccupied( node ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"which node to check.","mandatory":true}]}]},{"name":"IsOnGround","description":"Returns true if entity is on ground","example":"if( self IsOnGround() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsOnLadder","description":"Return true if the player is on a ladder, false otherwise.","example":"self IsOnLadder()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsOnSlide","description":"Return true if the player is in the player movement slide.","example":"self IsOnSlide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPathfinder","description":"Checks whether this entity is registered with navigation system so it can do pathfinding and position query","example":"if ( IsPathfinder( tank ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity to check","mandatory":true}]}]},{"name":"IsPaused","description":"Returns whether a given entity is paused as part of a world pause.","example":"if ( ent IsPaused() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsPlayer","description":"Checks whether this entity is the player","example":"if ( IsPlayer( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be the player","mandatory":true}]}]},{"name":"IsPlayerNumber","description":"Returns true if the passed in int is a valid client number","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsPlayerSwimming","description":"Return if a player is swimming","example":"depth = get_players()[0] IsPlayerSwimming()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPlayerUnderwater","description":"Return if a player is underwater","example":"depth = get_players()[0] IsPlayerUnderwater()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPlayingAnimScripted","description":"Returns true if the entity is playing in scripted animation.","example":"if(player IsPlayingAnimScripted())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsPointInNavVolume","description":"Checks if a given point is within the specified navigation volume.","example":"result = IsPointInNavVolume( (10,20,30), \"small volume\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to evaluate.","mandatory":true},{"name":"navVolumeName","description":"Either \"navvolume_small\" or \"navvolume_big\".","mandatory":true}]}]},{"name":"IsPointOnNavMesh","description":"Checks if a given point is valid on the NavMesh. This check performs all the necessary validation such as away from boundary, correct material, navmesh trigger, etc.","example":"isValid = IsPointOnNavMesh( (10,20,30), self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to evaluate.","mandatory":true},{"name":"entity / radius","description":"the point is for this entity to path to, or an estimate radius of the expected character radius. default to radius 0. Note: not passing in the entity can cause false positive when point is on NavMesh but too close to boundary / on wrong material / in disabled navmesh trigger; or false negative when big character's origin is far below NavMesh but still within tolerant height.","mandatory":false}]}]},{"name":"IsPoisoned","description":"Check is a player is under the influence of gas","example":"if ( player IsPoisoned() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsRagdoll","description":"Return true if the entity is a ragdoll body, false otherwise.","example":"if( player IsRagdoll() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player_or_playercorpse","description":null},"parameters":[]}]},{"name":"IsSentient","description":"Checks whether this entity is a sentient, that is normally either an ai actor, ai vehicle or the player","example":"if ( IsSentient( vehicle.riders[j] ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be a sentient character","mandatory":true}]}]},{"name":"IsSlamming","description":"Returns true if the player is slamming.","example":"if(player IsSlamming())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsSliding","description":"Returns true if the player is sliding.","example":"if(player IsSliding())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsSpawner","description":"Checks whether this entity is a spawner","example":"if ( IsSpawner( ent ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"An entity object that may be a spawner","mandatory":true}]}]},{"name":"IsSpawnPointVisible","description":"Returns true or false if a point is visible to the given team","example":"if ( IsSpawnPointVisible( point_position, point_angles, \"axis\", player ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point","description":"Spawnpoint origin that needs to be checked","mandatory":true},{"name":"angles","description":"Spawnpoint angles that needs to be checked","mandatory":true},{"name":"team","description":"Team that we need to check against the point","mandatory":true},{"name":"ignore player","description":"The player that we are spawning in","mandatory":true}]}]},{"name":"IsSplitScreen","description":"Returns true if the game is a splitscreen game","example":"level.splitscreen = IsSplitScreen()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsSprinting","description":"Returns true if the player is sprinting.","example":"if(player IsSprinting())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsStarterPack","description":"Returns true if the player has starter pack","example":"if ( self IsStarterPack() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsStartingClassDefault","description":"Returns true if the starting class is the default class for the level","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsStreamerReady","description":"Is the players streamer ready.","example":"player IsStreamerReady()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTestClient","description":"Returns true if the player is a test client (Does not have a remote user).","example":"if( self IsTestClient() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTouching","description":"Returns true if is touching ","example":"if( player IsTouching( e_goal_volume ) ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other entity","description":"Entity.","mandatory":true}]}]},{"name":"IsTouchingSwept","description":"Returns true if is touching ","example":"if( player IsTouchingSwept( e_goal_volume ) ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other entity","description":"Entity.","mandatory":true}]}]},{"name":"IsTouchingVolume","description":"Returns true if entity is touching the volume.","example":"if ( crate_ent IsTouchingVolume( origin + (0,0,40), mins, maxs ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"origin","description":"Origin of the volume","mandatory":true},{"name":"volume mins","description":"The min extents of the volume","mandatory":true},{"name":"volume maxs","description":"The max extents of the volume","mandatory":true}]}]},{"name":"IsTraversing","description":"Returns true if the player is traversing.","example":"if(player IsTraversing())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTriggerEnabled","description":"Returns true if trigger is enabled. False otherwise","example":"if( trig isTriggerEnabled() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"IsTurretFiring","description":"Checks if this turret is firing","example":"if( IsTurretFiring( roof_turret ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"IsTurretLockedOn","description":"Checks whether this turret is locked onto a target. The entity must be a turret","example":"turret IsTurretLockedOn()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"IsUsingNavVolume","description":"Checks whether this entity is using Nav Volume. Note this is a relatively low level check. For general gameplay check whether an entity is flying, consider using IsAirborne.","example":"if ( IsUsingNavVolume( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object","mandatory":true}]}]},{"name":"isUsingT7Melee","description":"Returns true T7 Melee system is being used","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsValidGametype","description":"Returns true if the string is a valid game type","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"game type","description":"a string to check","mandatory":true}]}]},{"name":"IsVehicle","description":"Checks whether this entity is an ai character","example":"if ( IsVehicle( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an ai character","mandatory":true}]}]},{"name":"IsVehicleSpawner","description":"Checks whether this entity is a vehicle spawner","example":"if ( IsVehicleSpawner( ent ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"An entity object that may be a vehicle spawner","mandatory":true}]}]},{"name":"isvr","description":"check if this player has VR enabled","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsWallRunning","description":"Returns true if the player is wall running.","example":"if(player IsWallRunning())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsWallrunNode","description":"returns true if the node has the PNF_WALLRUN flag set","example":"IsWallrunNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to check","mandatory":true}]}]},{"name":"IsWorldPaused","description":"returns whether or not the world is currently paused","example":"if ( IsWorldPaused() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsZBarrier","description":"Returns true if the entity called on is a zbarrier.","example":"if(ent IsZBarrier())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsZBarrierClosed","description":"Returns true if the state of all of the zbarrier's pieces is 'closed'.","example":"closed = ent IsZBarrierClosed())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsZBarrierOpen","description":"Returns true if the state of all of the zbarrier's pieces is 'open'.","example":"open = ent IsZBarrierOpen())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ItemWeaponSetAmmo","description":"Set the weapon ammo to the given clip ammo and reserve ammo. Can give an alternate weapon index","example":"weap ItemWeaponSetAmmo( clip, extra, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"item","description":null},"parameters":[{"name":"clipAmmo","description":"Ammo for the clip","mandatory":true},{"name":"reserveAmmo","description":"Reserve ammo","mandatory":true},{"name":"altIndex","description":"Alternate weapon index","mandatory":false}]}]},{"name":"Kick","description":"Kicks the specified player.","example":"Kick( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"clientnum","description":"The client number of the player to kick.","mandatory":true}]}]},{"name":"Kill","description":"Kills this entity. If the entity could not be killed, errors. Automatically sets setCanDamage( true ).","example":"level.player kill()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"source position","description":"The position that the damage comes from. Defaults to entity's origin","mandatory":false},{"name":"attacker","description":"The entity that dealt the damage (such as an AI or player)","mandatory":false},{"name":"inflictor","description":"The entity that the damage came from (such as a grenade or turret)","mandatory":false},{"name":"weapon","description":"weapon to do damage with","mandatory":false}]}]},{"name":"KillClientRadiantExploder","description":"Deactivates a client side radiant exploder","example":"DeactivateClientRadiantExploder( \"light_switch\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"string id of exploder to deactivate","mandatory":true}]}]},{"name":"KillServer","description":"kills the server","example":"KillServer()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"LaserOff","description":"Turns off entity's laser sight.","example":"self LaserOff()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"LaserOn","description":"Turns on entity's laser sight.","example":"self LaserOn()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"Launch","description":"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":"self Launch( (x, y, z) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"initial velocity","description":"The initial velocity of the launch.","mandatory":true},{"name":"initial angular velocity","description":"The initial angular velocity of the launch.","mandatory":false}]}]},{"name":"LaunchRagdoll","description":"Launch this ragdoll.","example":"self LaunchRagdoll( (0,0,100) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"force","description":"launch force","mandatory":true},{"name":"bonename","description":"bone name to apply the force to","mandatory":false}]}]},{"name":"LaunchVehicle","description":"Launch this physics vehicle.","example":"panzer LaunchVehicle( (0,0,100) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"force","description":"launch force","mandatory":true},{}]}]},{"name":"LerpViewAngleClamp","description":"Only works if the player is currently linked to another entity and angles aren't locked. Lerps the current view angle constraints to the provided ones over the specified time.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"time","description":"Lerp duration in seconds. A value of 0 means instantaneous.","mandatory":true},{"name":"accel time","description":"Acceleration time.","mandatory":true},{"name":"decel time","description":"Decelaration time.","mandatory":true},{"name":"right arc","description":"Angle to clamp view to the right.","mandatory":true},{"name":"left arc","description":"Angle to clamp view to the left.","mandatory":true},{"name":"top arc","description":"Angle to clamp view to the top.","mandatory":true},{"name":"bottom arc","description":"Angle to clamp view to the bottom.","mandatory":true}]}]},{"name":"LinkNodes","description":"Connects node1 to node2. Call it again with arguments flipped if you want a two-way connection.","example":"LinkNodes( node_moving_elev_left, node_moving_elev_right )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"first node to link","mandatory":true},{"name":"node2","description":"second node to link","mandatory":true}]}]},{"name":"LinkTo","description":"Attaches one entity to another","example":"self.rightturret LinkTo( self, \"tag_gunRight\", (0,0,0), (0,0,0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach this thing to","mandatory":true},{"name":"tag","description":"The tag to attach the entity to","mandatory":false},{"name":"originOffset","description":"The positional offset from the base position","mandatory":false},{"name":"anglesOffset","description":"The angular offset from the base angles","mandatory":false}]}]},{"name":"LinkToBlendToTag","description":"Attaches one entity to another, gradually lerping entity to the parents orientation","example":"self.rightturret LinkToBlendToTag( self, \"tag_gunRight\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach this thing to","mandatory":true},{"name":"tag","description":"The tag to attach the entity to","mandatory":false},{"name":"only yaw","description":"Tells if blending only the yaw. Default to true.","mandatory":false},{"name":"collision physics","description":"Sets whether we should use collision physics. Defaults to false.","mandatory":false}]}]},{"name":"LinkToUpdateOffset","description":"Attaches one entity to another, gradually lerping entity to the parents orientation","example":"self.rightturret LinkToUpdateOffset( originsOffset, anglesOffset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{"name":"origin_offset","description":"The origin offset","mandatory":true},{"name":"angles_offset","description":"The angles offset","mandatory":false}]}]},{"name":"LinkTraversal","description":"Creates a user edge connecting two path nodes","example":"LinkTraversal( beginNode )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"Negotiation begin node","mandatory":true}]}]},{"name":"LoadSentientEventParameters","description":"Loads the global sentient event parameters for a given scriptbundle sentient events asset. (all AI will use these)","example":"LoadSentientEventParameters( \"sentientevents\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"scriptBundle","description":"String name of the script bundle to load","mandatory":true}]}]},{"name":"LocalToWorldCoords","description":"Transform the given local coordinate point to a world coordinate point","example":"ramboPoint = self LocalToWorldCoords( delta )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"local coordinate","description":"The point in local coordinates (vector3)","mandatory":true}]}]},{"name":"LookAtEntity","description":"Set this actor to look at the specified entity. Call this function without any entity specified to turn it off.","example":"guy LookAtEntity( otherguy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"otherguy","description":"the other guy to look at","mandatory":false}]}]},{"name":"LookAtPos","description":"Set this actor to look at the specified position. Call this function without any position specified to turn it off.","example":"guy LookAtPos( pos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"pos","description":"the position to look at","mandatory":false}]}]},{"name":"LUINotifyEvent","description":"Sends a notify from script to LUI.","example":"LUINotifyEvent( &\"update_objectives\", 1, &\"LEVEL_GOTO_NEXT_PLACE\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player","description":"the player to notify. If not specified, all players are notified.","mandatory":false},{"name":"lui event name","description":"as an IString","mandatory":true},{"name":"num of args","description":"number of parameters","mandatory":true},{"name":"args","description":"argument to pass to LUI","mandatory":true}]}]},{"name":"LUINotifyEventToSpectators","description":"Sends a notify from script to LUI.","example":"LUINotifyEventToSpectators( &\"update_objectives\", 1, &\"LEVEL_GOTO_NEXT_PLACE\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"lui event name","description":"as an IString","mandatory":true},{"name":"num of args","description":"number of parameters","mandatory":true},{"name":"args","description":"argument to pass to LUI","mandatory":true}]}]},{"name":"MagicBullet","description":"Creates a magic bullet at the source","example":"MagicBullet( GetWeapon(\"sniper_hyperion\"), level.sniper_loc.origin, target GetTagOrigin( \"tag_eye\" ), level.sniper_boss)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"Weapon type of the bullet","mandatory":true},{"name":"source","description":"Where the bullet will be spawned","mandatory":true},{"name":"destination","description":"Where the bullet will be fired at","mandatory":true},{"name":"attacker","description":"Set the owner of the bullet to this","mandatory":false},{"name":"targetent","description":"The target of the bullet","mandatory":false},{"name":"targetOffset","description":"Offset the target by this vector","mandatory":false}]}]},{"name":"MagicGrenade","description":"Creates a \"Magic\" grenade from an actor.","example":"self MagicGrenade( self.origin, target.origin, 2.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"target position","description":"The target point of the grenade toss","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false},{"name":"weapon","description":"The grenade weapon to use (defaults to equipped grenade weapon)","mandatory":false}]}]},{"name":"MagicGrenadeManual","description":"creates a \"Magic\" grenade from an actor","example":"self MagicGrenadeManual( self.origin, target.origin, 2.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"velocity","description":"The initial velocity vector for the grenade movement","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false}]}]},{"name":"MagicGrenadeManualPlayer","description":"creates a \"Magic\" grenade from a player","example":"self MagicGrenadeManualPlayer( self.origin, target.origin, 2.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"velocity","description":"The initial velocity vector for the grenade movement","mandatory":true},{"name":"weapon","description":"The grenade weapon to base on","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false}]}]},{"name":"MagicGrenadePlayer","description":"Creates a \"Magic\" grenade from a player.","example":"MagicGrenadePlayer( \"sticky_grenade_mp\", self.origin, toss_velocity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The grenade weapon to use","mandatory":true},{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"velocity","description":"The initial velocity vector for the grenade movement","mandatory":true}]}]},{"name":"MagicGrenadeType","description":"Fire a 'magic grenade', from the source location towards the destination point.","example":"ent MagicGrenadeType( \"fraggrenade\", self.origin, myVelocity )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the weapon","mandatory":true},{"name":"sourceLoc","description":"The grenade starting point","mandatory":true},{"name":"velocity","description":"The velocity of the grenade","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false}]}]},{"name":"MagicMissile","description":"Launches a weapon from the given position with the given velocity. Velocity determines direction.","example":"bomb = player MagicMissile( \"artillery_mp\", (100,100,0), ( 0.1, 0.1, 0.1 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"attacker","description":null},"parameters":[{"name":"weapon","description":"- Weapon name.","mandatory":true},{"name":"position","description":"- Position to launch from.","mandatory":true},{"name":"velocity","description":"- Direction and force of launch.","mandatory":true},{"name":"targetent","description":"The target of the bullet","mandatory":false}]}]},{"name":"MakeFakeAI","description":"Create a drone from script model, that can be moved around with simple commands","example":"guy MakeFakeAI()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model","description":null},"parameters":[]}]},{"name":"MakeGrenadeDud","description":"Turns a grenade into a dud","example":"grenade MakeGrenadeDud()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"grenade","description":null},"parameters":[]}]},{"name":"MakePathfinder","description":"Register a vehicle with Havok so it can do pathfinding and position query","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"MakeSentient","description":"Turn a vehicle or script mover into a sentient.","example":"heli MakeSentient()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"MakeTurretUnusable","description":"Sets a turret to be unable to be used","example":"roof_turret MakeTurretUnusable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"MakeTurretUsable","description":"Sets a turret able to be used","example":"roof_turret MakeTurretUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"MakeUnusable","description":"Sets this entity to be not usable by the player","example":"mover MakeUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"MakeUsable","description":"Sets this entity to be usable by the player","example":"mover MakeUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"The team that is allowed to use the object. Only for script movers.","mandatory":false}]}]},{"name":"Map","description":"Loads a new map","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"The map to load","mandatory":true},{"name":"save persistent","description":"if true then player info is retained","mandatory":false}]}]},{"name":"Map_Restart","description":"Restarts the map","example":"Map_Restart( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"save persistent","description":"if true then player info is retained","mandatory":false}]}]},{"name":"MapExists","description":"Returns true if the map with the given name exists on the server","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"The map to check.","mandatory":true}]}]},{"name":"MarkDestructibleDestroyed","description":"set destructible destroyed","example":"barrel MarkDestructibleDestroyed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"destructible","description":null},"parameters":[]}]},{"name":"MarkNoVehicleNavMeshFaces","description":"Update the novehicle flag on navmesh faces. This should only be used in MP map for now.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"matchRecordOvertimeRound","description":"call after matchRecordRoundStart to mark the round as an overtime round (only first overtimee round is actually recorded)","example":"matchRecordOvertimeRound()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"matchRecordRoundStart","description":"need a hook for round starts, to get time stamps","example":"matchRecordRoundStart()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Matrix4x4TransformPoints","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MaySpawnEntity","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MaySpawnFakeEntity","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Missile_DroneSetVisible","description":"Set the missile or drone to be visible","example":"self Missile_DroneSetVisible( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True to set visible, false otherwise","mandatory":true}]}]},{"name":"Missile_GetTarget","description":"Sets the target of the missile to the given entity, and resets if no entity is specified.","example":"target = missile Missile_GetTarget()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[]}]},{"name":"missile_settarget","description":"Sets the target of the missile to the given entity, and resets if no entity is specified.","example":"self missile_settarget( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{"name":"target","description":"The target of the missile","mandatory":false},{"name":"targetOffset","description":"Offset to the target location (vector3)","mandatory":false}]}]},{"name":"MissionFailed","description":"Restarts the map","example":"MissionFailed()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MissionHasAccolades","description":"Returns whether or not this mission has any accolades associated with it","example":"level.has_accolades = MissionHasAccolades( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"MissionHasCollectibles","description":"Returns whether or not this mission has any collectibles in it","example":"level.has_collectibles = MissionHasCollectibles( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"MissionRestart","description":"Restarts the mission, which might take you to a different BSP if this is a sublevel","example":"MissionRestart()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MoveGravity","description":"Fling this entity.","example":"self MoveGravity( break_vector, time )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"initial velocity","description":"The initial velocity to fling this entity at","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true}]}]},{"name":"MoveSlide","description":"Launches the entity in the given velocity. When on the ground it will slide smoothly. Call StopMoveSlide to make it stop moving.","example":"self MoveSlide( 16, anglesToForward( self.angles ) * 10 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"center","description":"The center of the entity's collision with the ground","mandatory":true},{"name":"radius","description":"The radius of the entity's collision with the ground","mandatory":true},{"name":"initial velocity","description":"The initial velocity to move the entity at","mandatory":true}]}]},{"name":"MoveTo","description":"Move this entity to the given point.","example":"dummy MoveTo( dest_org, .5, .05, .05 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The point to move the entity to","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating","mandatory":false}]}]},{"name":"MoveX","description":"Move this entity to the given world x value","example":"train MoveX( -4400, 60, 15, 20 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The x value to move the entity to, as a floating point number","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"MoveY","description":"move this entity to the given world y value","example":"hangardoor MoveY( 320, 10 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The y value to move the entity to, as a floating point number","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"MoveZ","description":"Move this entity to the given world z value","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The z value to move the entity to, as a floating point number","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"NavPointSightFilter","description":"Given an array of navmesh points, filters the array based on navmesh visibility to an origin.","example":"points = NavPointSightFilter( points, nearest )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"points","description":"Array of navmesh points","mandatory":true},{"name":"origin","description":"Origin to check visibility from","mandatory":true},{"name":"checksight","description":"True to check sight, false otherwise","mandatory":false}]}]},{"name":"NeedsRevive","description":"Used for mini maps to display compass icon","example":"self NeedsRevive( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"bool","description":"does player need to be reived","mandatory":true}]}]},{"name":"NodesAreLinked","description":"Returns true if node1 is connected to node2.","example":"NodesAreLinked( node_moving_elev_left, node_moving_elev_right )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"first node","mandatory":true},{"name":"node2","description":"second node","mandatory":true}]}]},{"name":"NodesVisible","description":"Returns true if these nodes are visible to one another, false otherwise.","example":"if ( NodesVisible( cover, guy.node ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"pathnode to check","mandatory":true},{"name":"node2","description":"pathnode to check against node1","mandatory":true}]}]},{"name":"NotSolid","description":"Unsets the solid flag, so that this object is no longer collidable.","example":"self NotSolid()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ent","description":null},"parameters":[]}]},{"name":"NumRemoteClients","description":"Returns the number of remote clients connected to the game. Very useful for scaling content for coop play, and network balancing.","example":"num_remote_clients = NumRemoteClients()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Obituary","description":"Create an obituary for a character","example":"Obituary( self, attacker, sWeapon, sMeansOfDeath )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"victim","description":"The victim entity","mandatory":true},{"name":"attacker","description":"The attacker entity","mandatory":true},{"name":"weapon","description":"The weapon name","mandatory":true},{"name":"weapon","description":"The means of death as a string","mandatory":true}]}]},{"name":"Objective_Add","description":"Add a new objective, with ability to specify all the info for the objective","example":"Objective_Add( objective_number, \"active\", closest.bomb.origin, objective_text, self.objective )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The number of the objective to add","mandatory":true},{"name":"state","description":"A string value representing the state of the objective. Valid states are \"empty\", \"active\", \"invisible\", \"done\", \"current\" and \"failed\"","mandatory":true},{"name":"position/onEntity","description":"The position of the objective - or - entity to be tracked.","mandatory":false},{"name":"displayName","description":"The text to use for the objective. This should be a valid localized text reference","mandatory":false},{"name":"entity","description":"The owner entity","mandatory":false}]}]},{"name":"Objective_ClearAllUsing","description":"Clears the objective of all players using status.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_ClearEntity","description":"Clears the entity previous set on the objective","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_ClearPlayerUsing","description":"Sets the objective to be not being used by the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player who is no longer using the objective","mandatory":true}]}]},{"name":"Objective_Delete","description":"Deletes the objective","example":"Objective_Delete( objective_number )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_GetGamemodeFlags","description":"Gets the gamemode flags for the objective.","example":"flags = Objective_GetGamemodeFlags( myObjNumber )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true}]}]},{"name":"Objective_Icon","description":"Set the objective icon","example":"objective_icon( crateObjID, \"compass_supply_drop_black\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"icon","description":"The icon name","mandatory":true}]}]},{"name":"Objective_OnEntity","description":"Sets the objective to get its position from an entity.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"entity","description":"The entity to set the objective to","mandatory":true}]}]},{"name":"Objective_Position","description":"Set the objective position","example":"objective_position( self.objectiveID, self.curOrigin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"position","description":"The position to set","mandatory":true}]}]},{"name":"Objective_Set3D","description":"Sets flag determining if 3D state for an objective is drawn.","example":"Objective_Set3D( myObjNum, true, undefined, undefined, undefined, (0,0,70) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"use3D","description":"true if should render in hud","mandatory":true},{"name":"unused","description":"not used","mandatory":false},{"name":"unused","description":"not used","mandatory":false},{"name":"unused","description":"not used","mandatory":false},{"name":"unused","description":"not used","mandatory":false}]}]},{"name":"Objective_SetColor","description":"Sets a color for the objective that the icon will then be drawn with.","example":"Objective_SetColor( myObjNumber, 1.0, 0.0, 0.0, 1.0 )Objective_SetColor( myObjNumber, \"FriendlyBlue\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"r/colorName","description":"Red float value for objective, or color name set from the UIEditor as an IString.","mandatory":true},{"name":"g","description":"Green float value for objective.","mandatory":false},{"name":"b","description":"Blue float value for objective.","mandatory":false},{"name":"a","description":"Alpha float value for objective. Default of 1.0 if not specified.","mandatory":false}]}]},{"name":"Objective_SetFlag","description":"Sets the gamemode flags for the objective.","example":"Objective_SetFlag( myObjNumber, \"active\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective to alter","mandatory":true},{"name":"flag","description":"- active, fadeoutonscreen, perk, drawdistance, drawname, in3d, clipToMap, primary","mandatory":true},{"name":"true/false","description":"turn the flag on or off","mandatory":true}]}]},{"name":"Objective_SetGamemodeFlags","description":"Sets the gamemode flags for the objective. This function only works for modes not using 3d objectives (mp).","example":"Objective_SetGamemodeFlags( myObjNumber, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"flags","description":"script managed flags.","mandatory":true}]}]},{"name":"Objective_SetInvisibleToAll","description":"Sets the objective to be invisible to all players.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_SetInvisibleToPlayer","description":"Sets the objective to be invisible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player to whom the objective is now invisible","mandatory":true}]}]},{"name":"Objective_SetInvisibleToPlayerByIndex","description":"Sets the objective to be invisible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"entnum","description":"The entity number of the player to whom the objective is now invisible","mandatory":true}]}]},{"name":"Objective_SetPlayerUsing","description":"Sets the objective to being used by the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player who is using the objective","mandatory":true}]}]},{"name":"Objective_SetProgress","description":"Sets the progress for the objective.","example":"Objective_SetProgress( myObjNumber, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"percent","description":"percent float value for objective [0-1].","mandatory":true}]}]},{"name":"Objective_SetSize","description":"Sets a size for the objective that the icon will then be drawn at. Min is MIN_OBJECTIVE_ICON_SIZE = 5","example":"Objective_SetSize( myObjNumber, myTrigger )Objective_SetSize( myObjNumber, 20, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"entity/float","description":"The entity to get the size from or a sizeX.","mandatory":true},{"name":"float","description":"If sizeX was used in prvious arg, this is sizeY.","mandatory":false}]}]},{"name":"Objective_SetUIModelValue","description":"Set a UI Model Value for an objective","example":"Objective_SetUIModelValue( 0, \"killedCount\", 4 ); or Objective_SetUIModelValue( 0, \"killedCount\", \"Four\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"lui menu data name","description":"precached name string for the data which we're trying to set.","mandatory":true},{"name":"lui menu data value","description":"value for the data which we're trying to set on the objective.","mandatory":true}]}]},{"name":"Objective_SetVisibleToAll","description":"Sets the objective to be visible to all players.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_SetVisibleToPlayer","description":"Sets the objective to be visible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player to whom the objective is now visible","mandatory":true}]}]},{"name":"Objective_SetVisibleToPlayerByIndex","description":"Sets the objective to be visible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"entnum","description":"The entity number of the player to whom the objective is now visible","mandatory":true}]}]},{"name":"Objective_State","description":"Set a state for the objective","example":"Objective_State( obj_id, \"active\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"state","description":"The state to set","mandatory":true}]}]},{"name":"Objective_Team","description":"Sets the team that the objective is for. Allows having different objectives for each team","example":"Objective_Team( 0, \"allies\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"team","description":"The team that the objective is for. Valid entries are 'allies', 'axis', 'team3', or 'none'","mandatory":true}]}]},{"name":"Objective_VisibleTeams","description":"Sets the team that the objective is visible too for. Allows having different objectives for each team","example":"Objective_VisibleTeams( 0, 01101101 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"team","description":"The team that the objective is for. Valid entries are 'allies', 'axis', 'team3', or 'none'","mandatory":true}]}]},{"name":"OffhandWeaponsEnabled","description":"Determine if offhand weapons are enabled for the player","example":"enabled = player OffhandWeaponsEnabled()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"OverrideSpawnflags","description":"Sets the spawnflags on this entity. Used for patching.","example":"entity OverrideSpawnflags( 64 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"PathDistance","description":"Returns the approximate/semi-accurate path distance between two points or undefined if no path can be found.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":".","mandatory":true},{"name":"end","description":".","mandatory":true},{"name":"generatePathForAccurateDist","description":"If set to true, a real path will be generated and the total length of the path segments will be returned.","mandatory":false},{"name":"pathEnt","description":"Only used when generatePathForAccurateDist is set. pathEnt will be used for generating a path, so it will respect the movement type. Only supported for actors.","mandatory":false},{"name":"pathDistanceType","description":"The method of pathdistance calculation. Two options are PATHDIST_APPROXIMATE(using getApproximateFuturePositions), PATHDIST_CORNERPREDICTED (using getCornerPredictor).","mandatory":false},{"name":"maxCornerPredictions","description":"Maximum number of cornerPrediction steps when PATHDIST_CORNERPREDICTED is used. Handles the edge case when cornerPrediction may not ever finish stepping the path all the way.","mandatory":false}]}]},{"name":"PhysicsExplosionCylinder","description":"Created a physics explosion cylinder","example":"PhysicsExplosionCylinder( self.origin, 600, 240, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The origin of the cylinder","mandatory":true},{"name":"outer radius","description":"The outer radius of the cylinder","mandatory":true},{"name":"inner radius","description":"The inner radius of the cylinder","mandatory":true},{"name":"magnitude","description":"The magnitude of the explosion","mandatory":true}]}]},{"name":"PhysicsExplosionSphere","description":"Create a physics explosion sphere","example":"PhysicsExplosionSphere( origin, radius, radius, 5, max_damage, min_damage )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The origin of the sphere","mandatory":true},{"name":"outer radius","description":"The outer radius of the sphere","mandatory":true},{"name":"inner radius","description":"The inner radius of the sphere","mandatory":true},{"name":"magnitude","description":"The magnitude of the explosion","mandatory":true},{"name":"outer damage","description":"The optional outer damage","mandatory":false},{"name":"inner damage","description":"The optional inner damage","mandatory":false}]}]},{"name":"PhysicsJetThrust","description":"Creates a physics jet thrust","example":"PhysicsJetThrust( self.origin, (0,0,1), 400, 1, 60)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"origin of the thrust","mandatory":true},{"name":"weapon facing dir","description":"The weapon facing direction","mandatory":true},{"name":"radius","description":"The radius of the thrust","mandatory":true},{"name":"magnitude","description":"The magnitude of the thrust","mandatory":true},{"name":"angle limit","description":"The angle limit for the thrust","mandatory":true}]}]},{"name":"PhysicsJolt","description":"Create a physics radius jolt","example":"PhysicsJolt( self.origin, 600, 240, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The origin of the jolt","mandatory":true},{"name":"outer radius","description":"The outer radius of the jolt","mandatory":true},{"name":"inner radius","description":"The inner radius of the jolt","mandatory":true},{"name":"impulse","description":"The impulse created by the explosion","mandatory":true}]}]},{"name":"PhysicsLaunch","description":"Permanently turn this entity into a physics object with an intial force vector at the specified point.","example":"dummy PhysicsLaunch( contact_point, initial_force )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model","description":null},"parameters":[{"name":"contact_point","description":"The point to apply the initial force","mandatory":false},{"name":"initial_force","description":"The force vector to apply","mandatory":false}]}]},{"name":"PhysicsTrace","description":"Does a physics trace from start to end. Returns hit position","example":"trace = PhysicsTrace( start, end, ( 0, 0, 0 ), ( 0, 0, 0 ), self, PHYSICS_TRACE_MASK_VEHICLE_CLIP )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true},{"name":"mins","description":"minimum bounds","mandatory":false},{"name":"maxs","description":"maximum bounds","mandatory":false},{"name":"ignore entity","description":"the entity to not consider","mandatory":false},{"name":"mask type","description":"the trace modifier","mandatory":false}]}]},{"name":"PhysicsTraceEx","description":"Physics trace, ignoring characters. Returns the full trace structure.","example":"trace = PhysicsTraceEx( start, end, (-10,-10,0), (10,10,0) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The start point","mandatory":true},{"name":"end","description":"The end point","mandatory":true},{"name":"mins","description":"trace capsule min","mandatory":false},{"name":"maxs","description":"trace capsule max","mandatory":false},{"name":"entity","description":"entity to ignore","mandatory":false},{"name":"player clip","description":"collide with the player solid mask instead of ai solid mask","mandatory":false}]}]},{"name":"PlaceSpawnPoint","description":"Raises the spawn point up to make sure it's not in the ground, then drops it back down into the ground.","example":"spawnpoints[i] PlaceSpawnPoint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"spawn point","description":null},"parameters":[]}]},{"name":"PlayBattleChatterToTeam","description":"Play the sound alias as if coming from the entity, so that only one team can hear it","example":"self PlaySoundToTeam( \"frag_out\", \"axis\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname1","description":"The first sound alias to play","mandatory":true},{"name":"aliasname2","description":"The second sound alias to play","mandatory":true},{"name":"teamname","description":"The team that will be able to hear the sound. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true},{"name":"ignoreplayer","description":"If present, this player will not hear the sound.","mandatory":false}]}]},{"name":"PlayerBulletTrace","description":"Allows script to do a bullet point trace with CONTENTS_PLAYER, collides with player hitboxes. Returns hit position, hit entity, hit surface normal.","example":"trace = PlayerBulletTrace( magicBulletOrigin.origin, eyePos, undefined )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true}]}]},{"name":"PlayerCamLinkTo","description":"Sets the player's vision to look through another entity.","example":"level.player2 CameraLinkTo( cameraUpstairs, \"tag_player\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":"Entity to look through.","mandatory":true},{"name":"tagname","description":"Name of tag on host model to attach to.","mandatory":true}]}]},{"name":"PlayerCamUnlink","description":"Unlinks the player's vision from an entity.","example":"level.player2 CameraUnlink( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayerGrappleTrace","description":"Trace to see if grapple is valid","example":"hitp = PlayerGrappleTrace(player.origin, player.origin + (0,0,-500))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true},{"name":"ignore entity","description":"this entity should be ignored","mandatory":false}]}]},{"name":"PlayerLinkedOffsetDisable","description":"If disabled, the linked player's orientation will not use their link offset.","example":"ac130guy PlayerLinkedOffsetDisable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"linked_player","description":null},"parameters":[]}]},{"name":"PlayerLinkedOffsetEnable","description":"If enabled, the linked player's orientation will use their link offset. This is traditional (CoD4) LinkTo behavior for a player.","example":"ac130guy PlayerLinkedOffsetEnable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"linked_player","description":null},"parameters":[]}]},{"name":"PlayerLinkedSetUseBaseAngleForViewClamp","description":"Sets the whether the player's view clamp is based on the entity (true) or the tag selected (false). Must be called after linking using WeaponViewToDelta","example":"player PlayerLinkedSetUseBaseAngleForViewClamp( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"linked_player","description":null},"parameters":[{"name":"enable","description":"whether or not to enable using the base entity for the view angle clamp base.","mandatory":true}]}]},{"name":"PlayerLinkTo","description":"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":"level.player PlayerLinkTo( vehicle, \"tag_player\", 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"view fraction","description":"How much the change in the tag's rotation effects the players view. Defaults to 0.","mandatory":false},{"name":"right arc","description":"Angle to clamp view to the right. Defaults to 180.","mandatory":false},{"name":"left arc","description":"Angle to clamp view to the left. Defaults to 180.","mandatory":false},{"name":"top arc","description":"Angle to clamp view to the top. Defaults to 180.","mandatory":false},{"name":"bottom arc","description":"Angle to clamp view to the bottom. Defaults to 180.","mandatory":false},{"name":"use tag angles","description":"Determines how the player's view will be tilted. 'False' (default) means that the orientation of the tag when the player is linked will appear flat to the player. Any rotation from that orientation will tilt the player's view. 'True' means that only a tag angles of (0,0,0) will appear flat to the player. Any rotation from (0,0,0) will tilt the player's view.","mandatory":false},{"name":"auto recenter","description":"Players view will auto recenter to the tag he is linked to. use tag angles must be true.","mandatory":false}]}]},{"name":"PlayerLinkToAbsolute","description":"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":"player PlayerLinkToAbsolute( vehicle, \"tag_player\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lockto entity","description":"The entity to attach the player to","mandatory":true},{"name":"tag","description":"The tag to attach the player to","mandatory":false}]}]},{"name":"PlayerLinkToBlend","description":"Only works if the player is currently linked to another entity and angles aren't locked. Lerps the current view angle constraints to the provided ones over the specified time.","example":"player PlayerLinkToBlend( ice_pick, \"tag_origin","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"parent","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"pos time","description":"Lerp duration in seconds. Default is 1.","mandatory":false},{"name":"pos accel time","description":"Acceleration time. Default is 0.","mandatory":false},{"name":"pos decel time","description":"Decelaration time. Default is 0.","mandatory":false},{"name":"angle time","description":"angle Lerp duration in seconds. Default is .","mandatory":false},{"name":"angle accel time","description":"angle Acceleration time. Default is 0.","mandatory":false},{"name":"angle decel time","description":"angle Decelaration time. Default is 0.","mandatory":false}]}]},{"name":"PlayerLinkToDelta","description":"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":"level.player PlayerLinkToDelta( vehicle, \"tag_player\", 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"view fraction","description":"How much the change in the tag's rotation effects the players view. Defaults to 0.","mandatory":false},{"name":"right arc","description":"Angle to clamp view to the right. Defaults to 180.","mandatory":false},{"name":"left arc","description":"Angle to clamp view to the left. Defaults to 180.","mandatory":false},{"name":"top arc","description":"Angle to clamp view to the top. Defaults to 180.","mandatory":false},{"name":"bottom arc","description":"Angle to clamp view to the bottom. Defaults to 180.","mandatory":false},{"name":"use tag angles","description":"Determines how the player's view will be tilted. 'False' (default) means that the orientation of the tag when the player is linked will appear flat to the player. Any rotation from that orientation will tilt the player's view. 'True' means that only a tag angles of (0,0,0) will appear flat to the player. Any rotation from (0,0,0) will tilt the player's view.","mandatory":false},{"name":"auto recenter","description":"Players view will auto recenter to the tag he is linked to. use tag angles must be true.","mandatory":false}]}]},{"name":"PlayerLinkWeaponViewToDelta","description":"Similar to PlayerLinkToDelta(), but the player's body stays behind. The player's view attaches to the tag, and any weapon fire will also come from there.","example":"level.player PlayerLinkToDelta( vehicle, \"tag_player\", 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"view fraction","description":"How much the change in the tag's rotation effects the players view. Defaults to 0.","mandatory":false},{"name":"right arc","description":"Angle to clamp view to the right. Defaults to 180.","mandatory":false},{"name":"left arc","description":"Angle to clamp view to the left. Defaults to 180.","mandatory":false},{"name":"top arc","description":"Angle to clamp view to the top. Defaults to 180.","mandatory":false},{"name":"bottom arc","description":"Angle to clamp view to the bottom. Defaults to 180.","mandatory":false},{"name":"use tag angles","description":"Determines how the player's view will be tilted. 'False' (default) means that the orientation of the tag when the player is linked will appear flat to the player. Any rotation from that orientation will tilt the player's view. 'True' means that only a tag angles of (0,0,0) will appear flat to the player. Any rotation from (0,0,0) will tilt the player's view.","mandatory":false}]}]},{"name":"PlayerPhysicsTrace","description":"Does a physics trace and returns the hit point.","example":"hitp = PlayerPhysicsTrace(player.origin + (0,0,72), player.origin + (0,0,-500))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true}]}]},{"name":"PlayerPhysicsTraceIgnoreEnt","description":"Does a physics trace and returns the hit point.","example":"hitp = PlayerPhysicsTraceIgnoreEnt(player.origin + (0,0,72), player.origin + (0,0,-500))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true}]}]},{"name":"PlayerPositionValid","description":"Returns true if the passed in origin is valid for a spawn (ie not inside something).","example":"if(playerpositionvalid(spawnpoints[i].origin))...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of the potential spawn point","mandatory":true}]}]},{"name":"PlayerPositionValidIgnoreEnt","description":"Returns true if the passed in origin is valid for a spawn (ie not inside something).","example":"if(PlayerPositionValidIgnoreEnt(spawnpoints[i].origin))...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of the potential spawn point","mandatory":true}]}]},{"name":"PlayerSetGroundReferenceEnt","description":"The ground entity's rotation will be added onto the player's view. In particular, this will cause the player's yaw to rotate around the entity's z-axis instead of the world z-axis. You only need to call this function once. After that, any rotation that the reference entity undergoes will affect the player. Call this command again with undefined to turn it off.","example":"player PlayerSetGroundReferenceEnt( seaEnt )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"ground reference entity","description":"The entity used to rotate the player's view.","mandatory":true}]}]},{"name":"PlayerSightTrace","description":"Determines if you can see an item. Checks distance and view cone before the trace to increase efficency.","example":"if (0 == (self Playersighttrace(positionOfFlare, 200, lastHit))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"place that check if you can see if being performed","mandatory":true},{"name":"maxDistance","description":"if the position is further than this -1 will be returned","mandatory":true},{"name":"hitNum","description":"if you run this more than once make sure to populate this with the return of the last as it will increase efficiency","mandatory":true}]}]},{"name":"PlayFX","description":"Plays the fx at the given location.","example":"PlayFX( level._effect[\"nuke_fx\"], nuke_pos.origin, forward, up )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"position","description":"Position to play the fx at","mandatory":true},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false},{"name":"ignore pause","description":"True if the fx should play even when the game is paused.","mandatory":false}]}]},{"name":"PlayFXOnCamera","description":"Plays the fx at the given offset from the camera.","example":"PlayFX( level._effect[\"bubbles\"], offset, forward, up )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"offset","description":"Offset from camera to play fx","mandatory":false},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false},{"name":"ignore pause","description":"True if the fx should play even when the game is paused.","mandatory":false}]}]},{"name":"PlayFXOnTag","description":"Play fx on a particular tag of an entity","example":"PlayFxOnTag( level._effect[\"character_fire_death_torso\"], self, \"J_Spine1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"entity","description":"The entity to play the fx on. Should have a model","mandatory":true},{"name":"tag","description":"The tag to play the fx on","mandatory":true},{"name":"ignore pause","description":"True if the fx should play even when the game is paused.","mandatory":false}]}]},{"name":"PlayLoopedFX","description":"Play an fx which is looped","example":"PlayLoopedFX( level._effect[self.v[\"trailfx\"]], self.v[\"trailfxdelay\"], self.v[\"origin\"], 0, self.v[\"forward\"], self.v[\"up\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"repeat","description":"Time to repeat after","mandatory":true},{"name":"position","description":"Position to play the fx at","mandatory":true},{"name":"cull distance","description":"The cull distance for the fx","mandatory":false},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false}]}]},{"name":"PlayLoopSound","description":"Play a looping sound with an optional fadetime in seconds.","example":"fire_sound_ent playloopsound (\"mpl_player_burn_loop\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"fadetime","description":"Time to fade the sound in. Range is between 1 and 31 inclusive.","mandatory":false}]}]},{"name":"PlayRumbleLoopOnEntity","description":"Plays a looping rumble on the given entity.","example":"self PlayRumbleLoopOnEntity( \"damage_heavy\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rumble name","description":"The name of the rumble to play","mandatory":true}]}]},{"name":"PlayRumbleLoopOnPosition","description":"Play a looping rumble on the given position","example":"PlayRumbleLoopOnPosition( \"grenade_rumble\", origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"rumblename","description":"The rumble name","mandatory":true},{"name":"position","description":"The rumble position","mandatory":true}]}]},{"name":"PlayRumbleOnEntity","description":"Plays a rumble on the given entity.","example":"self PlayRumbleOnEntity( \"damage_heavy\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rumble name","description":"The name of the rumble to play","mandatory":true}]}]},{"name":"PlayRumbleOnPosition","description":"Play a rumble on the given position","example":"PlayRumbleOnPosition( \"grenade_rumble\", origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"rumblename","description":"The rumble name","mandatory":true},{"name":"position","description":"The rumble position","mandatory":true}]}]},{"name":"PlaySound","description":"Play the sound at the entity","example":"bomb PlaySound( \"zmb_bomb_explode\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true}]}]},{"name":"PlaySoundAtPosition","description":"Play the sound alias from a position","example":"PlaySoundAtPosition(\"Dirt_skid\", ( 100, 100, 0 ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"position","description":"The point where the sound is played","mandatory":true}]}]},{"name":"PlaySoundOnTag","description":"Play the sound alias as if coming from the tag","example":"self PlaySoundOnTag( soundAlias, \"J_Head\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play, this can be the string name, or the integer hash","mandatory":true},{"name":"tag","description":"If present, the sound will play at the position of the given tag","mandatory":false},{"name":"team","description":"If present or not undefined the sound will only be heard by the specified team","mandatory":false},{"name":"ent","description":"If present the sound will also be heard on the specified entity","mandatory":false}]}]},{"name":"PlaySoundToAllButPlayer","description":"Play the sound alias as if coming from the entity, so that everyone but one player can hear it","example":"self PlaySoundToAllButPlayer( \"frag_out\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string)","mandatory":true},{"name":"player","description":"The player that will not be able to hear the sound. (entity)","mandatory":true}]}]},{"name":"PlaySoundToPlayer","description":"Play the sound alias as if coming from the entity, so that only one player can hear it","example":"self PlaySoundToPlayer( \"frag_out\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string) or the sound alias (int)","mandatory":true},{"name":"player","description":"The player that will be able to hear the sound. (entity)","mandatory":true}]}]},{"name":"PlaySoundToTeam","description":"Play the sound alias as if coming from the entity, so that only one team can hear it","example":"self PlaySoundToTeam( \"frag_out\", \"axis\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"teamname","description":"The team that will be able to hear the sound. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true},{"name":"ignoreplayer","description":"If present, this player will not hear the sound.","mandatory":false}]}]},{"name":"PlaySoundWithNotify","description":"Play the sound alias as if coming from the entity","example":"self PlaySoundWithNotify(\"Dirt_skid\",\"skidsound\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"notification string","description":"If present, the sound will notify this string on this entity when done.stopsounds","mandatory":false},{"name":"tag","description":"If present, the sound will play at the position of the given tag","mandatory":false}]}]},{"name":"PositionQuery_Filter_Directness","description":"Directness filter compute the direction information for each of the positions, relative to and .","example":"PositionQuery_Filter_Directness( queryResult, self.origin, self.enemy.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function. each point contained here will have direction info computed.","mandatory":true},{"name":"origin","description":"usually the position of AI before move.","mandatory":true},{"name":"target","description":"the position AI is trying to approach.","mandatory":true},{"name":"resultVarName","description":"by default the result directness value will be stored in pointStruct.directness, but can be override by this string.","mandatory":false}]}]},{"name":"PositionQuery_Filter_DistanceToGoal","description":"Calculate the distance to .goalpos. If the point is in .goalradius, the distance will be 0. the result is in pointStruct.distToGoal","example":"PositionQuery_Filter_DistanceToGoal( queryResult, self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function.\"","mandatory":true},{"name":"entity","description":"the entity used to check goal.\"","mandatory":true}]}]},{"name":"PositionQuery_Filter_InClaimedLocation","description":"Check if the locations are inside other sentients claimed locations .inClaimedLocation.","example":"PositionQuery_Filter_InClaimedLocation( queryResult, self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function.\"","mandatory":true},{"name":"entity","description":"the entity used to check goal.\"","mandatory":true}]}]},{"name":"PositionQuery_Filter_Sight","description":"Sight filter do sight check on each of the positions to a target position, and store the result in pointStruct.visibility (boolean).","example":"PositionQuery_Filter_Sight( queryResult, self.enemy.origin, self GetEye() - self.origin, self, 30, self.enemy );","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function. each point contained here will be used to check sight against . \"","mandatory":true},{"name":"targetPosition","description":"the position to check sight.\"","mandatory":true},{"name":"offset","description":"offset to add on each point before sight checking. this is usually something like: offset = ai GetEye() - ai.origin. default to (0,0,0). \"","mandatory":false},{"name":"visibleBy_Ent","description":"if defined, the corresponding sight check function on Actor or Vehicle will be called. Otherwise the checks just do simple bullet tracing.\"","mandatory":false},{"name":"numOfPassedToEarlyOut","description":"if defined and bigger than 0, the filter will early out after found this many passed sight checks. this is useful if the points are pre sorted by score and we don't care about lower scored ones.\"","mandatory":false},{"name":"ignoreEnt","description":"ignore entity during trace. if [visibleBy_Ent] is defined, it is already ignored internally. \"","mandatory":false},{"name":"resultVarName","description":"by default the results will be stored in pointStruct.visibility, but can be override by this string. \"","mandatory":false}]}]},{"name":"PositionQuery_Source_Navigation","description":"Generate points around , between and and within height difference. For ground AI, the points will be on Nav Mesh; for flying AI, the points will be in Nav Volume. Only the points in pathable area will be kept. If the itself is in pathable area, all the points are guaranteed to be reachable from . If the is outside pathable area, all the points will still be in pathable areas surrounding , but reach-abilities cannot be guaranteed.","example":"queryResult = PositionQuery_Source_Navigation( goalpos, self.radius, self.radius * 8, heightRadius, AI_GOAL_POINT_STEP, self, AI_GOAL_POINT_STEP * 0.2 )if ( queryResult.centerOnNav ){foreach( pointStruct in queryResult.data ){position = pointStruct.origindist = pointStruct.distToOrigin2D...}}","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Position to start the search around.","mandatory":true},{"name":"minSearchRadius","description":"the minimum radius away from origin.","mandatory":true},{"name":"maxSearchRadius","description":"the maximum radius away from origin. can equal to minSearchRadius.","mandatory":true},{"name":"halfHeight","description":"the max height difference (both positive and negative) away from origin.","mandatory":true},{"name":"innerSpacing","description":"the distance between points in.","mandatory":true},{"name":"reachableBy_Ent","description":"if defined, it will be used to make sure all the points are reachable by this entity from (not the entity's current position). Can pass in a float number radius to get points on NavMesh. Can also pass in string 'navvolume_small' or 'navvolume_big' to get points on navvolume. Note passing in entity radius only gives rough estimate, not correct result.","mandatory":false},{"name":"outerSpacing","description":"if defined, the distance between points will be Lerped from to [outerSpacing], to create a gradual distribution.","mandatory":false},{"name":"distributionBias","description":"(vec2) if defined, the density of the points will be changed gradually along the direction of this vector. the magnitude will be use as scalar, with 1 being the norm scale.","mandatory":false}]}]},{"name":"PositionWouldTelefrag","description":"Returns true if the passed in origin would telefrag a player if another player was spawned there.","example":"if ( PositionWouldTelefrag( spawnpoints[i].origin ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of the potential spawn point","mandatory":true}]}]},{"name":"PrecacheLeaderboards","description":"Precache a sp/mp leaderboard.","example":"PrecacheLeaderboards( \"LB_KILLS LB_WINS LB_TOTALXP LB_ACCURACY\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"leaderboard names","description":"The name of the leaderboards to precache","mandatory":true}]}]},{"name":"PredictGrenade","description":"Predict where the grenade (self) will explode.","example":"grenade PredictGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"grenade","description":null},"parameters":[]}]},{"name":"PredictPosition","description":"Predict position of the entity at the end of the frames","example":"prediction = PredictPosition( ent, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"ent","description":"The entity to predict position of","mandatory":true},{"name":"frames","description":"The frame count","mandatory":true}]}]},{"name":"PredictSpawnPoint","description":"Indicates to the Texture Streamer where we expect to spawn in.","example":"player predictSpawnPoint( origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"The origin to spawn at","mandatory":true},{"name":"angles","description":"The angle.","mandatory":true}]}]},{"name":"Print","description":"Development only - write to the console","example":"Print( \"Stuff and things!\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"text to be written","mandatory":true}]}]},{"name":"PrintLn","description":"Development only - write line to the console","example":"PrintLn( \"I could be doing better!\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"text to be written","mandatory":true}]}]},{"name":"PropagateCurrentEvent","description":"Propagate the current event to other AI.","example":"point = self PropagateCurrentEvent()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"QSortScoredSpawnPointsAscending","description":"Sort the scored spawn points in an ascending order","example":"sorted_spawn_points = QSortScoredSpawnPointsAscending( scored_spawn_points )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"input_array","description":"The array of points","mandatory":true}]}]},{"name":"queuemeleeactionstate","description":"Sets the queued action state to melee for the player's default hand.","example":"player QueueMeleeActionState()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"RadiusDamage","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"RecordBreadcrumbDataForPlayer","description":"record a breadcrumb data point for player at time","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"RefreshShieldAttachment","description":"Re-attach the shield model to the player.","example":"player RefreshShieldAttachment()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"RegisterClientField","description":"Register a client field. Client fields are variable bit length fields communicated from server to client.","example":"RegisterClientField(\"world\", \"my_field\", 2, \"int\"); // registers a world int field with 2 bits of resolution, that can hold the values 0,1,2,3.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"Client field pool name","description":"Which pool the field is allocated from. Currently supported : \"world\", \"actor\", \"vehicle\", \"scriptmover\"","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"version","description":"Number indicating version this field was added in - see _version.gsh for defines.","mandatory":true},{"name":"num bits","description":"How many bits to use for the field. Valid values are in the range of 1-32. Only ask for as many as you need.","mandatory":true},{"name":"type","description":"Type of the field. Currently supported types \"int\" or \"float\"","mandatory":true}]}]},{"name":"RegisterSkipto","description":"Register a new skipto name","example":"struct.code_index = RegisterSkipto( msg )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"skipto_name","description":"The skipto name to register","mandatory":true}]}]},{"name":"ReleaseClaimedTrigger","description":"Release a currently claimed trigger","example":"self.trigger releaseClaimedTrigger()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"RemoveForceNoCull","description":"Removes the force-no-cull flag. Entity will now be culled by portals","example":"helicopter RemoveForceNoCull()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"RemoveInfluencer","description":"Removes the given influencer","example":"RemoveInfluencer( influencer_id )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer to remove","mandatory":true}]}]},{"name":"RemoveNoSunShadow","description":"Removes the no-sunshadow flag.","example":"helicopter RemoveNoSunShadow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ReportUser","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetAILimit","description":"Clears any previous restrictions on the max number of AI.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetDestructible","description":"Resets the destructible entity back to its start state","example":"vehicle ResetDestructible()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ResetDoubleJumpRechargeTime","description":"Resets the double jump recharge timer as if the player had just used it","example":"player ResetDoubleJumpRechargeTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetFOV","description":"Replace the current FOV by the default FOV","example":"player ResetFOV()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetGlass","description":"Server side glass struct loops through all glass and resets to inital state","example":"ResetGlass()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetMissileDetonationTime","description":"Resets the timer for a grenade or missile to its max fuse time.","example":"grenadeEnt ResetMissileDetonationTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"time","description":"Override the reset timer from the weapon and specify the time left.","mandatory":false}]}]},{"name":"ReviveObituary","description":"Create an revive obituary for a character","example":"Obituary( self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"victim","description":"The victim entity","mandatory":true}]}]},{"name":"Rotate","description":"Causes a script entity to rotate, rotating around its origin","example":"self Rotate( rotationVir )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"rotation vector","description":"The direction of the bobbing","mandatory":true}]}]},{"name":"RotatePitch","description":"Rotate this entity to the given pitch","example":"treeorg RotatePitch( -5, 0.26, 0.15, 0.1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"pitch angle","description":"The new pitch angle in degrees","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateRoll","description":"Rotate this entity to the given roll angle","example":"self RotateRoll( (2 * 1500 + 3 * Randomfloat( 2500 )) * -1, 5, 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"model_origin_brushmodel","description":null},"parameters":[{"name":"roll angle","description":"The new roll angle in degrees","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateTo","description":"Rotate this entity to the given world rotation value","example":"shutter RotateTo( (shutter.angles[0], newYaw, shutter.angles[2]), newTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"angles","description":"The new world angle to rotate to","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateVelocity","description":"Rotate this entity at a particular velocity for a given time","example":"self RotateVelocity( (x,y,z), 12 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"rotate velocity","description":"The rotational velocity to rotate","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateYaw","description":"Rotate this entity to the given yaw","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"yaw angle","description":"The new yaw angle in degrees","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"ScreenShake","description":"Create a screen shake event on the given point.","example":"ScreenShake( jolt.origin, 0.3, 0.3, 0.3, 3, 0.2, 3, 850, 0.5, 0.25, 0.25 ); // locationalScreenShake( (0,0,0), 0.3, 0.3, 0.3, 3, 0.2, 3, 0, 0.5, 0.25, 0.25, player ); // non locational for one player only","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sourcePoint","description":"The position of the earthquake.","mandatory":true},{"name":"scalepitch","description":"The scale of the shake in player's pitch. Max is 100; Accurate to 2 decimal places.","mandatory":true},{"name":"scaleyaw","description":"The scale of the shake in player's yaw. Max is 100; Accurate to 2 decimal places.","mandatory":true},{"name":"scaleroll","description":"The scale of the shake in player's roll. Max is 100; Accurate to 2 decimal places.","mandatory":true},{"name":"duration","description":"Duration in seconds.","mandatory":true},{"name":"durationfadeup","description":"Duration in seconds, included in base duration. Default is 0. Value of -1 means duration - durationfadeup.","mandatory":false},{"name":"durationfadedown","description":"Duration in seconds, included in base duration. Default is -1. Value of -1 means duration - durationfadedown.","mandatory":false},{"name":"radius","description":"The radius of shake, dampens as you move away from entity. Default is 0 = shake is global","mandatory":false},{"name":"frequencypitch","description":"The scaled speed of the shake's pitch. Default is 1. Max is 100; Accurate to 2 decimal places.","mandatory":false},{"name":"frequencyyaw","description":"The scaled speed of the shake's yaw. Default is 1. Max is 100; Accurate to 2 decimal places.","mandatory":false},{"name":"frequencyroll","description":"The scaled speed of the shake's roll. Default is 1. Max is 100; Accurate to 2 decimal places.","mandatory":false},{"name":"exponent","description":"The scale is multiplied by itself 'exponent' times to determine how the shake falls off. Default is 1 which is a linear falloff. Max is 100; Accurate to 2 decimal places","mandatory":false},{"name":"target","description":"Target is given if screen shake is to be shown to particular client only","mandatory":false}]}]},{"name":"SendFaceEvent","description":"Broadcast to the client a face event","example":"self SendFaceEvent( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"index","description":"Face event index (string)","mandatory":true}]}]},{"name":"SendKillstreakDamageEvent","description":"Send a killstreak damage event to the client","example":"killstreakOwner SendKillstreakDamageEvent( 25 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"damage","description":"How much damage was done","mandatory":false}]}]},{"name":"ServerFieldGetValue","description":"Get the value of a serverfield from a given player","example":"ServerFieldGetValue(self, \"my_field\"); ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"player to get value from","mandatory":true},{"name":"name","description":"name of field to retrieve","mandatory":true}]}]},{"name":"serverfieldregister","description":"Register a server field. Server fields are variable bit length fields communicated from client to server","example":"RegisterServerField(\"my_field\", 2, \"int\"); // registers an int field with 2 bits of resolution, that can hold the values 0,1,2,3.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"num bits","description":"How many bits to use for the field. Valid values are in the range of 1-32. Only ask for as many as you need.","mandatory":true},{"name":"type","description":"Type of the field. Currently supported types \"int\" or \"float\"","mandatory":true},{"name":"callback","description":"Function that gets called when the value changes (each client can toggle this bit independently of the others)","mandatory":true}]}]},{"name":"ServiceEvent","description":"Set the specified event to serviced.","example":"point = self ServiceEvent( 100 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"eventId","description":"The identifier of the event (integer)","mandatory":true}]}]},{"name":"ServiceEventsInRadius","description":"Set the events within a radius to serviced.","example":"self ServiceEventsInRadius( self.origin, 500 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"origin","description":"Source position","mandatory":true},{"name":"radius","description":"Radius of events to service (-1 for all)","mandatory":true}]}]},{"name":"SessionModeAbbreviation","description":"Returns abbreviation of the current session mode, or \"default\" if none","example":"spawnpointname = SessionModeAbbreviation() + \"_frontend_camera","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsCampaignGame","description":"Returns true/false if the current session mode is a campaign game","example":"if ( SessionModeIsCampaignGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsCampaignZombiesGame","description":"Returns true/false if the current session mode is a campaign game and the campaign mode is set to zombies.","example":"if ( SessionModeIsCampaignZombiesGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsMultiplayerGame","description":"Returns true/false if the current session mode is a multiplayer game","example":"if ( SessionModeIsMultiplayerGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsOnlineGame","description":"Returns true/false if the current session mode is onlinegame","example":"if ( SessionModeIsOnlineGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsPrivate","description":"Returns true/false if the current session mode is a private game","example":"if ( SessionModeIsPrivate() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsPrivateOnlineGame","description":"Returns true/false if the current session mode is a private onlinegame","example":"if ( SessionModeIsPrivateOnlineGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsSystemlink","description":"Returns true/false if the current session mode is a systemlink game","example":"if ( SessionModeIsSystemlink() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsZombiesGame","description":"Returns true/false if the current session mode is a zombies game","example":"if ( SessionModeIsZombiesGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetActorWeapon","description":"Sets the actor weapon.","example":"self SetActorWeapon( \"weapon_name\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weaponname","description":"The weapon name. (string)","mandatory":true},{"name":"weapon options","description":"options value computed using calcweaponoptions","mandatory":false}]}]},{"name":"SetAILimit","description":"Allows you to specify a max number of active AI - which over-rides the MAX_AI functionality in the engine, when it comes time to spawn in new AI. Setting the value higher will not give you more AI than the system supports.","example":"SetAILimit( 10 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetAISpread","description":"Sets the spread of this turret when used by an AI","example":"roof_turret SetAISpread( 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"spread","description":"The spread of the turret in degrees","mandatory":true}]}]},{"name":"SetAnim","description":"Restart\": These functions cause the animation to restart. If they had been previously playing, without this they would continue from their current time.","example":"self SetAnim( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimForceNew","description":"Debug only functionality that adds a new instance of an animation to an animtree setting its time to a specific point.","example":"self SetAnimForceNew( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to set this animation to after adding it. Defaults to 0.","mandatory":false},{"name":"goalTime","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnob","description":"See \"SetAnim.","example":"self SetAnimKnob( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAll","description":"See \"SetAnim.","example":"self SetAnimKnobAll( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAllLimited","description":"See \"SetAnim.","example":"self SetAnimKnobAllLimited( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAllLimitedRestart","description":"See \"SetAnim.","example":"self SetAnimKnobAllLimitedRestart( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAllRestart","description":"See \"SetAnim.","example":"self SetAnimKnobAllRestart( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobLimited","description":"See \"SetAnim.","example":"self SetAnimKnobLimited( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobLimitedRestart","description":"See \"SetAnim.","example":"self SetAnimKnobLimitedRestart( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobRestart","description":"See \"SetAnim.","example":"self SetAnimKnobRestart( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimTime","description":"Get the animation time for the given animation.","example":"if ( (self GetAnimTime( %walk_and_run_loops ) ) < 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"animation to manipulate","mandatory":true}]}]},{"name":"SetAnimTimeByName","description":"Set the animation normalized time for the given animation.","example":"self SetAnimTimeByName( \"ai_anim_walk\", 0.5)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"animation to manipulate","mandatory":true},{"name":"time","description":"0->1","mandatory":true}]}]},{"name":"SetArchive","description":"deprecated function, does nothing","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetAssassinationEnabled","description":"Enable or disable assassinations on the AI. Also turns on/off the can assassinate indicator.","example":"quadtank SetAssassinationEnabled( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"Whether to use infrared material or not (boolean)","mandatory":true}]}]},{"name":"SetAttachmentCosmeticVariantIndex","description":"Set the attachment cosmetic variant index for the weapon","example":"level.weapon_clientscript_cac_model[type] SetAttachmentCosmeticVariantIndex( weaponFullName, level.attachment_names[i], 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"weapon","description":null},"parameters":[{"name":"weapon","description":"The weapon full name","mandatory":true},{"name":"attachment name","description":"The attachment name of the weapon","mandatory":true},{"name":"acvi","description":"The attachment cosmetic variant index","mandatory":true}]}]},{"name":"SetAttachmentCosmeticVariantIndexes","description":"Sets the previously calculated SetAttachmentCosmeticVariantIndexes of the entity. The entity should not be a player","example":"killcamEnt SetAttachmentCosmeticVariantIndexes( acvi )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"acvi","description":"The AttachmentCosmeticVariantIndexes to set","mandatory":true}]}]},{"name":"SetAttachmentCosmeticVariants","description":"Set the AttachmentCosmeticVariantIndexes data to be passed in to the weapon","example":"SetAttachmentCosmeticVariants( \"mp7_mp\", \"acog\", 2, \"grip\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponname","description":"the name of the base weapon to return","mandatory":true},{"name":"attachmentname_1","description":"the name of the first attachment","mandatory":false},{"name":"variantindex_1","description":"the index of the cosmetic variant to use for the first attachment","mandatory":false},{"name":"attachmentname_2","description":"the name of the second attachment","mandatory":false},{"name":"variantindex_2","description":"the index of the cosmetic variant to use for the second attachment","mandatory":false},{"name":"attachmentname_3","description":"the name of the third attachment","mandatory":false},{"name":"variantindex_3","description":"the index of the cosmetic variant to use for the third attachment","mandatory":false},{"name":"attachmentname_4","description":"the name of the fourth attachment","mandatory":false},{"name":"variantindex_4","description":"the index of the cosmetic variant to use for the fourth attachment","mandatory":false},{"name":"attachmentname_5","description":"the name of the fifth attachment","mandatory":false},{"name":"variantindex_5","description":"the index of the cosmetic variant to use for the fifth attachment","mandatory":false},{"name":"attachmentname_6","description":"the name of the sixth attachment","mandatory":false},{"name":"variantindex_6","description":"the index of the cosmetic variant to use for the sixth attachment","mandatory":false},{"name":"attachmentname_7","description":"the name of the seventh attachment","mandatory":false},{"name":"variantindex_7","description":"the index of the cosmetic variant to use for the seventh attachment","mandatory":false},{"name":"attachmentname_8","description":"the name of the eighth attachment","mandatory":false},{"name":"variantindex_8","description":"the index of the cosmetic variant to use for the eighth attachment","mandatory":false}]}]},{"name":"SetAvoidanceMask","description":"Set the avoidance mask of this Havok character.","example":"randEnemy SetAvoidanceMask(\"avoid none\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"Mask","description":"(const string) Mask must be 'avoid all', 'avoid none', 'avoid actor', 'avoid ai'(actors+vehicles), 'avoid player', or 'avoid vehicle'","mandatory":true}]}]},{"name":"SetAvoidanceProperty","description":"Set the avoidance properties of this Havok character.","example":"randAlly SetAvoidanceProperty(\"collision penalty\", 0.1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"Property","description":"(const string) Property must be 'collision penalty' or 'dodge penalty'","mandatory":true},{"name":"Value","description":"(float) The value to set the property to","mandatory":true}]}]},{"name":"SetBallPassAllowed","description":"Enables or disables ball passing for the given player.","example":"player SetBallPassAllowed( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetBlur","description":"Blur the screen over a period of time.","example":"setblur( 10.3, 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"target_blur","description":"The final blur. The value is pixels for Gaussian blur at 640x480. Must be a floating point value greater than 0.","mandatory":true},{"name":"time","description":"Time in seconds","mandatory":true}]}]},{"name":"SetBodyRenderOptions","description":"Sets the entity body, helmet and head render options.","example":"heroModel SetBodyRenderOptions( bodyRenderOptions, helmetRenderOptions, headRenderOptions )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"bodyRenderOptions","description":"The packed body render options - calculated with GetHeroBodyRenderOptions","mandatory":true},{"name":"helmetRenderOptions","description":"The packed helmet render options - calculated with GetHeroHelmetRenderOptions","mandatory":true},{"name":"headRenderOptions","description":"The packed head render options - calculated with GetHeroHeadRenderOptions","mandatory":true}]}]},{"name":"SetBombTimer","description":"Bomb timer set in the match state","example":"SetBombTimer( \"A\", 50000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag bit","description":"The flag bit to change","mandatory":true},{"name":"value","description":"The new value of the bit","mandatory":true}]}]},{"name":"SetBurn","description":"Set the entity burning for the given time","example":"self SetBurn( 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"time","description":"Time to burn for ( greater than 0 )","mandatory":true}]}]},{"name":"SetCameraSpikeActive","description":"Sets the state of a player's camera spike.","example":"player SetCameraSpikeActive( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"toggle","description":"0 for off, 1 for on","mandatory":true}]}]},{"name":"SetCanDamage","description":"Set the candamage flag for this entity - this means that it can respond to notifies from bullets and grenade hits","example":"self SetCanDamage( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"can damage","description":"The can damage flag","mandatory":true}]}]},{"name":"SetClearanceCeiling","description":"Sets a new clearance ceiling. If the value is larger than the current ceiling, cut faces will be invalidated.","example":"SetClearanceCeiling( 15.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetClientNameMode","description":"alters the way that the player name is updated, to prevent cheating by spectators altering their name to communicate with active players.","example":"SetClientNameMode( \"auto_change\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name mode","description":"either 'auto_change' or 'manual_change'","mandatory":true}]}]},{"name":"SetClone","description":"Sets the contents for the clone.","example":"clone SetClone()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetContents","description":"Sets contents of the entity to the given content","example":"reconModel SetContents( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"content","description":"The content to set for the entity","mandatory":true}]}]},{"name":"SetCullDist","description":"Set the cull distance for a level","example":"SetCullDist( 7200 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cull distance","description":"The cull distance","mandatory":true}]}]},{"name":"SetCursorHint","description":"Attach a cursor hint to the entity.","example":"self setCursorHint( cursor_hint, cursor_hint_weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetDangerous","description":"Set this node to be a dangerous node for a particular team. works only on pathnodes. ","example":"self SetDangerous( self.team, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"pathnode","description":null},"parameters":[{"name":"team","description":"Name of the team.","mandatory":true},{"name":"flag","description":"True if dangerous. False otherwise","mandatory":true}]}]},{"name":"SetDedicatedShadow","description":"Enabled or Disables dedicated shadow for a model","example":"thing SetDedicatedShadow( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True or False, enabled or disabled","mandatory":false}]}]},{"name":"SetDefaultDropPitch","description":"Set the default drop pitch that the turret attempts to return to when it is not in use.","example":"turret SetDefaultDropPitch( -90 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"pitch","description":"yaw of the turret (side to side) in degrees.","mandatory":true}]}]},{"name":"SetDemoIntermissionPoint","description":"Sets the intermission point for the demos.","example":"setDemoIntermissionPoint( spawnpoint.origin, spawnpoint.angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"SetDepthOfField","description":"Set the Depth of Field.","example":"self SetDepthOfField( 0, 0, 512, 4000, 4, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"nearStart","description":"Near start (should be greater than 0)","mandatory":true},{"name":"nearEnd","description":"Near end (should be greater than 0)","mandatory":true},{"name":"farStart","description":"Far start (should be greater than 0)","mandatory":true},{"name":"farEnd","description":"Far end (should be greater than 0)","mandatory":true},{"name":"nearBlur","description":"Near blur","mandatory":true},{"name":"farBlur","description":"Far blur","mandatory":true}]}]},{"name":"SetDoubleJumpEnergy","description":"Sets a double jump energy amount on the player","example":"player SetDoubleJumpEnergy( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"energy","description":"% energy to set on the player","mandatory":true}]}]},{"name":"SetDrawInfrared","description":"Draw this entity using infrared material when using infrared scope.","example":"helicopter SetDrawInfrared( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"Whether to use infrared material or not (boolean)","mandatory":true}]}]},{"name":"SetDvar","description":"Sets the value of a dvar.","example":"SetDvar( \"r_eyesAdjust\", \"1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string.","mandatory":true},{"name":"value","description":"The dvar value.","mandatory":true}]}]},{"name":"SetElectrified","description":"Electrify the entity for the given time","example":"self SetElectrified( 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"time","description":"Time to get electrified for ( greater than 0 )","mandatory":true}]}]},{"name":"SetEMPJammed","description":"Sets whether a player/client is affected by EMP","example":"player SetEMPJammed( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"isJammed","description":"Whether the player should be jammed or not. ( boolean )","mandatory":true}]}]},{"name":"SetEnableNode","description":"Disables or enabled this node.","example":"SetEnableNode( node, false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"the node to enable/disable","mandatory":true},{"name":"truefalse","description":"whether it should be enabled","mandatory":false}]}]},{"name":"SetEnemyModel","description":"Sets the model of the actor that actors enemies will see to the given model name","example":"dog SetEnemyModel( \"german_shepard_black\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"model name","description":"The name of the model to set this actor to","mandatory":true}]}]},{"name":"SetEntGravityTrajectory","description":"Sets the gravity trajectory type for the entity.","example":"player SetEntGravityTrajectory( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"trajectory","description":"0 = TR_GRAVITY, 1 = TR_MOON_GRAVITY","mandatory":true}]}]},{"name":"SetEntityAnimRate","description":"set the entity animation rate - ZOMBIES ONLY","example":"self SetEntityAnimRate( 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rate","description":"animation rate","mandatory":true}]}]},{"name":"SetEntityPaused","description":"Sets whether a given entity will advance normally.","example":"ent SetEntityPaused( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"ignore","description":"Whether or not to advance normally.","mandatory":true}]}]},{"name":"SetEntityWeapon","description":"Set weapon ent field from script.","example":"ent SetEntityWeapon( \"kniferang_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"SetExcludeTeamForTrigger","description":"Set the team that this trigger will not react to. Reacts to all other teams.","example":"self SetExcludeTeamForTrigger( game[\"attackers\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"team name","description":"The name of the team that the trigger will not respond to. Must be either 'axis', 'allies', 'team3', 'team4', 'team5', 'team6' or 'none'","mandatory":true}]}]},{"name":"SetExpFog","description":"Creates an exponential fog.","example":"SetExpFog(.0001144, 131/255, 116/255, 71/255, 0)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"startDist","description":"The distance, in world units, at which the fog begins.","mandatory":true},{"name":"halfwayDist","description":"The distance, beyond the startDist, at which the scene will be 50% fogged.","mandatory":true},{"name":"red","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"green","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"blue","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"transition time","description":"transition time in seconds","mandatory":true}]}]},{"name":"SetFakeFire","description":"Simulates gun fire. Sound and radar blip.","example":"entity SetFakeFire( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetForceNoCull","description":"Sets the force-no-cull flag. Entity will not be culled by portals","example":"helicopter SetForceNoCull()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetFOVForKillcam","description":"Sets the fov for use with this killcam entity. Setting it to zero makes it use the default fov.","example":"killCamEnt SetFOVForKillcam( 25 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"fov","description":"The fov you want to use for the killcam","mandatory":true}]}]},{"name":"SetGameEndTime","description":"Sets the time the current match will end","example":"setGameEndTime( getTime() + int(timeLeft) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"time","description":"The time to set","mandatory":true}]}]},{"name":"SetGametypeSetting","description":"Sets the value of a gametype setting.","example":"SetGametypeSetting( \"timeLimit\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"setting","description":"The setting name as a string.","mandatory":true},{"name":"value","description":"The new value for the setting.","mandatory":true}]}]},{"name":"SetGrapplableType","description":"Set how an entity is grappled.","example":"platform SetGrapplableType( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetGravity","description":"sets the gravity in inches per second per second.","example":"SetGravity( 800 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gravity","description":"The gravity to set","mandatory":true}]}]},{"name":"SetHideonClientWhenScriptedAnimCompleted","description":"hides the entity on the client side onces its scripted animation ends","example":"SetHideonClientWhenScriptedAnimCompleted( ent )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true}]}]},{"name":"SetHighDetail","description":"Enabled or Disables High Detail rendering for a model","example":"thing SetHighDetail( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True or False, enabled or disabled","mandatory":false}]}]},{"name":"SetHintLowPriority","description":"Sets this as a low priority hint which is lower priority then everything other then turrets and dropped weapons","example":"m_e_hack_trigger SetHintLowPriority( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"bool","description":"True\\False if its on or off","mandatory":true}]}]},{"name":"SetHintString","description":"Set the hint string for the entity","example":"t_door SetHintString( \"Press and Hold ^3[{+activate}]^7 to transmit unlock code\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"hint string","description":"The hint string that will be displayed to the player","mandatory":true},{"name":"...","description":"Additional arguments may be appended to the hint string","mandatory":false}]}]},{"name":"SetHintStringForPerk","description":"Shows this hint string to the player if the player has the specified perk","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"perk","description":"The perk that the player needs to have to see this hint string","mandatory":true},{"name":"hint string","description":"The hint string that will be displayed to the player that has the perk","mandatory":true}]}]},{"name":"SetHintStringForPlayer","description":"Sets the trigger hint string for one specific player","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player that will see the hint string","mandatory":true},{"name":"hint string","description":"The hint string that will be displayed to the player","mandatory":true},{"name":"...","description":"Additional arguments may be appended to the hint string in the same way as SetHintString.","mandatory":false}]}]},{"name":"SetIgnoreEntForTrigger","description":"Ignores this entity when doing trigger sight traces. Currently only works for trigger_radius_use","example":"self SetIgnoreEntForTrigger( camera_spike_ent )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"entity to ignore","description":"The entity that will be ignored during sight trace checks","mandatory":true}]}]},{"name":"SetIgnorePauseWorld","description":"Sets whether a given entity will advance normally when the world is paused.","example":"ent SetIgnorePauseWorld( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"ignore","description":"Whether or not to advance normally when the world is paused.","mandatory":true}]}]},{"name":"SetIncludeMeshes","description":"Sets a streamer hint entity to include mesh data","example":"self setIncludeMeshes( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"SetInfluenceAt","description":"Sets the influence value on the influence map, returns true/false if the value was set.","example":"SetInfluenceAt(influenceMapIndex, origin, influence)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influenceMapIndex","description":"Index of the influence map","mandatory":true},{"name":"origin","description":"The location to set the influence value","mandatory":true},{"name":"influence","description":"The influence value to set","mandatory":true}]}]},{"name":"SetInfluencerTeamMask","description":"Sets the team mask for the given influencer","example":"SetInfluencerTeamMask( influencer_id, team_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer id","mandatory":true},{"name":"team mask","description":"The team mask to apply","mandatory":true}]}]},{"name":"SetInfluencerTimeout","description":"Sets the timeout for the influencer in seconds from current time","example":"SetInfluencerTimeout( influencer_id, 2.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer id","mandatory":true},{"name":"time","description":"The timeout for the influencer","mandatory":true}]}]},{"name":"SetInfraredVision","description":"Switches using the infrared vision (infrared visionset and thermal characters)","example":"player SetInfraredVision( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"is infrared vision","description":"Whether using infrared vision","mandatory":true}]}]},{"name":"SetInitialPlayersConnected","description":"Set initialPlayersConnected bool in match state to true","example":"SetInitialPlayersConnected()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetInvisibleToAll","description":"Set entity invisible to all players","example":"use_trigger SetInvisibleToAll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetInvisibleToPlayer","description":"Make the entity invisible to the player","example":"hackable._trigger SetInvisibleToPlayer( player, false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to set the entity invisible to.","mandatory":true},{"name":"setInvisible","description":"True if entity has to be invisible to player. False otherwise","mandatory":false}]}]},{"name":"SetJumpHeight","description":"Set the global jump height of all players. Minimum value of 0, maximum value of 1023.","example":"SetJumpHeight( 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"height_in_inches","description":"The height to jump in inches","mandatory":true}]}]},{"name":"SetLightColor","description":"Sets the current color of the light, as an RGB vector.","example":"self SetLightColor( (0.5, 0.75, 1.0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"color","description":"An RGB vector with components in the range 0 to 1. The given values get rounded before they are stored. (vector3)","mandatory":true}]}]},{"name":"SetLightExponent","description":"Sets the current exponent of the light.","example":"self SetLightExponent( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"exponent","description":"A new value for the exponent of the light. This should be an integer in the range of 0 to 100. (integer)","mandatory":true}]}]},{"name":"SetLightFovRange","description":"Sets the current fov range of the light.","example":"self SetLightFovRange( 200, 50 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"fov_outer","description":"A new value for the outer FOV of the light, in degrees. This cannot be larger than the fov when the map was compiled, or less than 1. (float)","mandatory":true},{"name":"fov_inner","description":"A new value for the inner FOV of the light, in degrees. This cannot be larger than fov_outer, or less than 0. If not specified, the map value is used. (float)","mandatory":false}]}]},{"name":"SetLightingOnly","description":"Sets a streamer hint entity to only hint lighting data","example":"self SetLightingOnly( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"SetLightingState","description":"Changes lighting state for the map","example":"SetLightingState( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"new light state","description":"new state to change to. Lighting state defaults to 1 at start of game","mandatory":true}]}]},{"name":"SetLightIntensity","description":"Sets the current intensity of the light.","example":"self SetLightIntensity( 1.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"intensity","description":"A new value for the intensity of the light. 1 is fullbright, but values can be larger than 1. (float)","mandatory":true}]}]},{"name":"SetLightRadius","description":"Sets the current radius of the light.","example":"self SetLightRadius( 200 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"radius","description":"A new value for the radius of the light. This cannot be larger than the radius when the map was compiled. (float)","mandatory":true}]}]},{"name":"SetMapCenter","description":"Set the center of the map (used by the network code to optimize position data)","example":"SetMapCenter( level.mapCenter )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mapCenter","description":"The map center","mandatory":true}]}]},{"name":"SetMatchFlag","description":"Flags a bit in the match state","example":"SetMatchFlag( \"bomb_timer\", \"1\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flag bit","description":"The flag bit to change","mandatory":true},{"name":"value","description":"The new value of the bit","mandatory":true}]}]},{"name":"SetMatchTalkFlag","description":"Flags a bit in the match talk state","example":"SetMatchTalkFlag( \"DeadChatWithDead\", \"1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag bit","description":"The flag bit to change","mandatory":true},{"name":"value","description":"The new value of the bit","mandatory":true}]}]},{"name":"SetmaxHealth","description":"Sets the max health of this entity","example":"self SetMaxHealth( required_amount )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"health","description":"The new max health","mandatory":true}]}]},{"name":"SetMiniMap","description":"Sets the minimap bounds and material","example":"setMiniMap(material, northwest[0], northwest[1], southeast[0], southeast[1])","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"material","description":"Sets the material","mandatory":true},{"name":"upperLeftX","description":"Upper left X value","mandatory":true},{"name":"upperLeftY","description":"Upper left Y value","mandatory":true},{"name":"lowerRightX","description":"Lower right X value","mandatory":true},{"name":"lowerRightY","description":"Lower right Y value","mandatory":true}]}]},{"name":"SetMissileBrake","description":"Tells a remote missile to disable brake","example":"missile DisableMissileBrake( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{"name":"flag","description":"True to enable or disable missile brake.","mandatory":true}]}]},{"name":"SetMissileCoasting","description":"Tells a remote missile to start coasting at a reduced speed.","example":"missile SetMissileCoasting( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{"name":"flag","description":"True to start coasting at reduced speed.","mandatory":true}]}]},{"name":"SetMissileOwner","description":"Sets the missile entity owner.","example":"grenade SetMissileOwner( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{}]}]},{"name":"SetMode","description":"Set the mode of a turret.","example":"turret SetMode( \"auto_ai\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"mode","description":"The turret mode. Possible modes are \"auto_ai\", \"manual\", \"manual_ai\" and \"auto_nonai","mandatory":true}]}]},{"name":"SetModel","description":"Set the model for the entity","example":"raps_meteor SetModel( \"veh_t7_drone_raps\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"model alias","description":"Name of the model","mandatory":true}]}]},{"name":"SetMoveSpeedScale","description":"Sets the speed scale multiplier for the entity","example":"self SetMoveSpeedScale( HOLDING_CRATE_MOVEMENT_SPEED )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"speed scale multiplier","description":"The speed scale multiplier (float)","mandatory":true}]}]},{"name":"SetMovingPlatformEnabled","description":"Enbles the moving platfrom.","example":"platform SetMovingPlatformEnabled( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetNemesisXUID","description":"Sets the Nemesis XUID","example":"player setNemesisXuid( player.pers[\"nemesis_xuid\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"nemesisXuidString","description":"The Nemesis XUID string","mandatory":true}]}]},{"name":"SetNodePriority","description":"Enable or disable the priority for this node.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"(node) A priority allowed node.","mandatory":true},{"name":"enable","description":"(boolean) True if this node is enabled.","mandatory":true}]}]},{"name":"SetNormalHealth","description":"Set health of entity. Input health is normalized.","example":"self SetNormalHealth( 0.8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"normal health","description":"Health in normalized form. Range 0 - 1","mandatory":true}]}]},{"name":"SetNoSunShadow","description":"Sets the no-sunshadow flag.","example":"helicopter SetNoSunShadow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetObjectivePointStatus","description":"Objective status set in the match state","example":"SetObjectivePointStatus( 1, \"allies\", 80 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The objective index in the matchstate","mandatory":true},{"name":"team","description":"The team of the objective","mandatory":true},{"name":"percent","description":"Percentage completed","mandatory":true}]}]},{"name":"SetOnTargetAngle","description":"Set the angle range at which the turret_on_target notify will occur.","example":"boat SetOnTargetAngle( 0, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"angle","description":"In degrees (float)","mandatory":true},{"name":"gunnerIndex","description":"Which gun, 0-3.","mandatory":false}]}]},{"name":"SetOwner","description":"Sets the entity owner.","example":"grenade SetOwner( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"SetPauseWorld","description":"pauses playback of animations and effects, but doesn't affect the server tick the way slomo does","example":"SetPauseWorld( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pause","description":"Whether or not to pause the world","mandatory":true}]}]},{"name":"SetPerkForTrigger","description":"Set the perk that the player must have for this trigger will react to","example":"self SetPerkForTrigger( \"specialty_fastinteract\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"perk name","description":"The name of the perk that the trigger will respond to.","mandatory":true}]}]},{"name":"SetPlayerCollision","description":"Use to turn on off the collision with the player.","example":"self SetPlayerCollision( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"on_off","description":"True for on and false for off","mandatory":true}]}]},{"name":"SetPlayerCurrentObjective","description":"Sets the current objective information on the player","example":"SetPlayerCurrentObjective( \"flag_a\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"objective_index","description":"The objective index in the matchstate","mandatory":true},{"name":"objective_type","description":"Type of the objective","mandatory":true}]}]},{"name":"SetPlayerCurrentStreak","description":"Sets the current kill streak count on the player","example":"SetPlayerCurrentStreak( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"current streak","description":"The current kill streak count","mandatory":true}]}]},{"name":"SetPlayerGravity","description":"Sets the gravity override value for the player.","example":"player SetPlayerGravity( 600 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"gravity","description":"The gravity to set","mandatory":true}]}]},{"name":"SetPlayerIgnoreRadiusDamage","description":"Set the player to take or ignore radius damage","example":"SetPlayerIgnoreRadiusDamage( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"true to ignore radius damage, false otherwise","mandatory":true}]}]},{"name":"SetPlayerSpread","description":"Sets the spread of this turret when used by the player","example":"roof_turret SetPlayerSpread( 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"spread","description":"The spread of the turret in degrees","mandatory":true}]}]},{"name":"SetPlayerStateLoadoutBonusCards","description":"Set the player state to have bonus card info, for codcaster to view it","example":"self SetPlayerStateLoadoutBonusCards( class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"SetPlayerStateLoadoutWeapons","description":"Set the player state to have primary and secondary weapon info, for codcaster to view it","example":"self SetPlayerStateLoadoutWeapons( class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"SetReviveHintString","description":"Set the revive hint string to show to all or to a team.","example":"self.revivetrigger setReviveHintString( &\"GAME_BUTTON_TO_REVIVE_PLAYER\", self.team )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"hint string","description":"The hint string that will be displayed to the player that has the perk","mandatory":true},{"name":"team","description":"The team to show the hint to","mandatory":false}]}]},{"name":"SetRoundsPlayed","description":"Set rounds played in match state","example":"SetRoundsPlayed( game[\"roundsplayed\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"The number of rounds played","mandatory":true}]}]},{"name":"SetScale","description":"Set the model scale on a script mover.","example":"entity SetScale(2.0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"scale","description":"The scale factor. (float)","mandatory":true}]}]},{"name":"SetScanningPitch","description":"Set the pitch that the turret attempts to use while scanning for enemies.","example":"turret SetScanningPitch( -45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"pitch","description":"of the turret (up and down) in degrees.","mandatory":true}]}]},{"name":"SetScoreboardColumns","description":"Set the scoreboard columns.","example":"SetScoreboardColumns( \"score\", \"kills\", \"deaths\", \"kdratio\", \"assists\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"column1","description":"to ","mandatory":true},{"name":"...","description":"More columns if needed.","mandatory":false}]}]},{"name":"SetScriptMoverFlag","description":"Sets flag 0-7 on the script mover ent.","example":"some_script_model SetScriptMoverFlag( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{}]}]},{"name":"SetSessStat","description":"Sets the indicated stat","example":"self SetSessStat( \"byteStat\", 0, 12 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"stat path","description":"The path to the stat to set the value for.","mandatory":true}]}]},{"name":"SetSharedViewPort","description":"Sets the view mode to either shared or independent, shared combines all views into a single shared viewport, modifies the way input is handled, and places the camera into scripted camera mode (i.e. control it with script).","example":"SetSharedViewPort(true)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mode","description":"true if shared viewport, false for independent (default splitscreen behavior)","mandatory":true}]}]},{"name":"SetSkipTos","description":"Set skip tos","example":"SetSkiptos( ToLower( skipto ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"skipto","description":"The skipto name","mandatory":true}]}]},{"name":"SetSlowMotion","description":"sets the current slow motion timescale interpolation.","example":"SetSlowMotion( 1.0, 0.25, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"startTimescale","description":"The initial timescale.","mandatory":true},{"name":"endTimescale","description":"The final timescale. Default to 1.","mandatory":false},{"name":"deltaTime","description":"The time to go from start to end timescale. Default to 1. (in seconds)","mandatory":false}]}]},{"name":"SetSpawnClientFlag","description":"Set a flag on a client's spawn client data in the spawning system.","example":"player SetSpawnClientFlag( \"SCDFL_DISABLE_LOGGING\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flag","description":"Flag to set","mandatory":true}]}]},{"name":"SetSpawnPointRandomVariation","description":"Random value will be added into the spawn point weighting calculation.","example":"SetSpawnPointRandomVariation( 10 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variation","description":"random range will be [0, variation]","mandatory":true}]}]},{"name":"SetSpawnPointsBaseWeight","description":"If the spawn point is facing the objective position then it will have an additional score applied","example":"SetSpawnPointsBaseWeight( team_mask, point, 30, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team mask","description":"teams that this command will affect","mandatory":true},{"name":"objective position","description":"Position of the objective that will be used in the facing calculations","mandatory":true},{"name":"angle","description":"max angle that will be accepted","mandatory":true},{"name":"score","description":"additional score that will be applied","mandatory":true}]}]},{"name":"SetStableMissile","description":"Set the stable missile flag of the entity","example":"self SetStableMissile( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"Set to true if the stable flag should be set. False otherwise","mandatory":true}]}]},{"name":"SetStance","description":"Sets the stance of the player. It only works for the player.","example":"player SetStance( \"stand\" );\\","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"stance","description":"The stance. Possible values are 'crouch', 'prone' and 'stand'","mandatory":true}]}]},{"name":"SetStowedWeapon","description":"Sets the stowed weapon for the player","example":"self SetStowedWeapon( \"mp40_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weaponName","description":"The weapon name to attach (string).","mandatory":true}]}]},{"name":"SetTargetEntity","description":"Sets the target of this turret","example":"roof_turret SetTargetEntity( target )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"target","description":"the turret target","mandatory":true}]}]},{"name":"SetTargetOrigin","description":"Sets the target origin of this turret or vehicle weapon","example":"roof_turret SetTargetOrigin( origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"origin","description":"the turret target origin","mandatory":true}]}]},{"name":"SetTeam","description":"Sets the entity team.","example":"panzer SetTeam( team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"SetTeamForTrigger","description":"Set the team that this trigger will react to","example":"self SetTeamForTrigger( game[\"attackers\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"team name","description":"The name of the team that the trigger will respond to. Must be either 'axis', 'allies', 'team3' or 'none'","mandatory":true}]}]},{"name":"SetTeamSatellite","description":"Sets whether a team has Spyplane or not","example":"SetTeamSatellite( \"allies\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true},{"name":"availability","description":"Whether the team has Satellite; defaults to false","mandatory":true}]}]},{"name":"SetTeamScore","description":"Set a team's score","example":"SetTeamScore( \"allies\", 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true},{"name":"score","description":"The new team score","mandatory":true}]}]},{"name":"SetTeamSpyplane","description":"Sets whether a team has Spyplane or not","example":"SetTeamSpyplane( \"allies\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true},{"name":"availability","description":"Whether the team has Spyplane; defaults to false","mandatory":true}]}]},{"name":"SetTmodeProvider","description":"Enables (or disables) the actor to provide tmode traces to the player.","example":"entity SetTmodeProvider( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"value","description":"(int) 1-enable 0-disable","mandatory":true}]}]},{"name":"SetTopDownCameraYaw","description":"Set the top down camera yaw that is used in DOA to get the player controls to work correctly in bgpmove.","example":"SetTopDownCameraYaw( 180 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"yaw_angle","description":"The yaw angle to set","mandatory":true}]}]},{"name":"SetTopScorer","description":"Sets the top scorer for the end game screen.","example":"SetTopScorer( 0, player, weapon, renderoptions, acvi)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"index","description":"position [0..2] of the player","mandatory":true},{"name":"player","description":"player who is the top scorer","mandatory":true},{"name":"taunt","description":"players selected taunt index","mandatory":true},{"name":"gesture0","description":"players selected gesture type 0 index","mandatory":true},{"name":"gesture1","description":"players selected gesture type 1 index","mandatory":true},{"name":"gesture2","description":"players selected gesture type 2 index","mandatory":true},{"name":"weapon","description":"players weapon","mandatory":true},{"name":"weapon render options","description":"players weapon renderoptions","mandatory":false},{"name":"acvi","description":"players attachment cosmetic variant indexes","mandatory":false}]}]},{"name":"SetTurretAccuracy","description":"Currently does nothing.","example":"roof_turret SetTargetAccuracy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"SetTurretCarried","description":"Sets whether a turret is being carried.","example":"turret SetTurretCarried( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"flag","description":"True if the turret is being carried","mandatory":true}]}]},{"name":"SetTurretMinimapVisible","description":"Sets whether a turret is visible on the minimap.","example":"sentry SetTurretMinimapVisible( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True if the turret is visible on the minimap","mandatory":true}]}]},{"name":"SetTurretNode","description":"Set this turretnode to use this turret.","example":"SetTurretNode( node, turret )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The turret node to connect to the turret","mandatory":true},{"name":"turret","description":"The turret to connect to the node","mandatory":true}]}]},{"name":"SetTurretOwner","description":"Sets the turret entity owner.","example":"turret SetTurretOwner( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{}]}]},{"name":"SetTurretSpinning","description":"Set the minigun spin for the turret on this entity. Works for vehicles also.","example":"roof_turret SetTurretSpinning( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"onoff","description":"Turn it on or off (boolean)","mandatory":true}]}]},{"name":"SetTurretType","description":"Sets the turret Type, Sentry or TOW.","example":"turret SetTurretType( \"sentry\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{}]}]},{"name":"SetupFieldOpsKitLoadouts","description":"Sets up all the field ops custom classes (using slots 6 through 9)","example":"SetupFieldOpsKitLoadouts( mapname )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mapname","description":"The map to load the field ops kits for","mandatory":true}]}]},{"name":"SetViewAngleResistance","description":"Sets the zones in the player's view cone in which resistance will be applied in the direction of the view limit","example":"level.player SetViewAngleResistance( 40, 40, 20, 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"right arc","description":"Angle to resist against the right plane of the view cone.","mandatory":true},{"name":"left arc","description":"Angle to resist against the left plane of the view cone.","mandatory":true},{"name":"top arc","description":"Angle to resist against the top plane of the view cone.","mandatory":true},{"name":"bottom arc","description":"Angle to resist against the bottom plane of the view cone.","mandatory":true},{"name":"snap to","description":"false when the resistance will be blended to over time. True by default.","mandatory":false}]}]},{"name":"SetViewModelDepthOfField","description":"Set the view model depth of field of the player","example":"self SetViewModelDepthOfField(0,1000)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"start","description":"Start DOF ( >= 0 )","mandatory":true},{"name":"end","description":"End DOF ( >= 0 )","mandatory":true}]}]},{"name":"SetVisibleToAll","description":"Make the entity visible to all players","example":"trigger SetVisibleToAll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetVisibleToAllExceptTeam","description":"Set self visible to all teams except the selected teams","example":"plane SetVisibleToAllExceptTeam( self.team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"Which to teams not to show this entity too","mandatory":true}]}]},{"name":"SetVisibleToPlayer","description":"Make the entity visible to the player","example":"trigger SetVisibleToPlayer( self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"player","description":"The player to set the entity visible to.","mandatory":true}]}]},{"name":"SetVisibleToTeam","description":"Set self visible only to selected team","example":"plane SetVisibleToSquad( self.team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"Which to show this entity to","mandatory":true}]}]},{"name":"SetVisionSetForPlayer","description":"Specify the server override visionset and the transition time into it.","example":"player SetVisionSetForPlayer( \"mortar_thermal\", 1.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"visionset name","description":"Vision set to transition into (string)","mandatory":true},{"name":"transition time","description":"How long, in seconds, to take transitioning to the new vision set if a transition is possible. Default is one second. (float)","mandatory":false}]}]},{"name":"SetVolFog","description":"Creates an exponential fog.","example":"SetVolFog(0.0001144, 0.01, 131/255, 116/255, 71/255, 0)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"startDist","description":"The distance, in world units, at which the fog begins.","mandatory":true},{"name":"halfwayDist","description":"The distance at which the scene will be 50% fogged.","mandatory":true},{"name":"halfwayHeight","description":"The height at which the scene will be 50% fogged.","mandatory":true},{"name":"baseHeight","description":"The ground-level Z position at which the fog will start from.","mandatory":true},{"name":"red","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"green","description":"The green component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"blue","description":"The blue component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"transition time","description":"transition time in seconds","mandatory":true},{"name":"startDist","description":"The distance, in world units, at which the fog begins.","mandatory":true},{"name":"halfwayDist","description":"The distance at which the scene will be 50% fogged.","mandatory":true},{"name":"halfwayHeight","description":"The height at which the scene will be 50% fogged.","mandatory":true},{"name":"baseHeight","description":"The ground-level Z position at which the fog will start from.","mandatory":true},{"name":"red","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"green","description":"The green component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"blue","description":"The blue component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"fogColorScale","description":"The scaler for the colors as a value between 1 and 10000.0","mandatory":true},{"name":"sunFogRed","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"sunFogGreen","description":"The green component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"sunFogBlue","description":"The blue component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"sunFogDirX","description":"The X component of the fog direction as a value between -1.0 and 1.0","mandatory":true},{"name":"sunFogDirY","description":"The Y component of the fog direction as a value between -1.0 and 1.0","mandatory":true},{"name":"sunFogDirZ","description":"The Z component of the fog direction as a value between -1.0 and 1.0","mandatory":true},{"name":"sunFogStartAng","description":"The starting angle of the sun fog as a value between 0 and 180","mandatory":true},{"name":"sunFogEndAng","description":"The ending angle of the sun fog as a value between 0 and 180","mandatory":true},{"name":"fog max opacity","description":"The maximum opacity of the fog as a value between 0 and 1","mandatory":true},{"name":"transition time","description":"transition time in seconds","mandatory":true}]}]},{"name":"SetVoteNoCount","description":"Sets the number of No votes","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"no count","description":"Number of 'no' votes","mandatory":true}]}]},{"name":"SetVoteString","description":"Sets the string for a vote","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The vote string","mandatory":true}]}]},{"name":"SetVoteTime","description":"Sets the start time for a vote","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"time","description":"The vote time in ms","mandatory":true}]}]},{"name":"SetVoteYesCount","description":"Sets the number of Yes votes","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"no count","description":"Number of 'yes' votes","mandatory":true}]}]},{"name":"SetWaterDrops","description":"Sets water drops equal to the count","example":"self SetWaterDrops( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"count","description":"Number of water drops (should be >= 0)","mandatory":true}]}]},{"name":"SetWaveWaterGeneratorAmplitude","description":"Sets the wave water amplitude of the generator.","example":"SetWaveWaterGeneratorAmplitude( \"exampleGenerator\", 1.1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"generator name","description":"The generator name","mandatory":true},{"name":"amplitude","description":"The amplitude for the generator","mandatory":true}]}]},{"name":"SetWeapon","description":"Sets the weapon of the entity. The entity should not be a player","example":"killcamEnt SetWeapon( self.weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weapon","description":"The weapon to set","mandatory":true}]}]},{"name":"SetWeaponOptions","description":"Sets the previously calculated weapon options of the entity. The entity should not be a player","example":"killcamEnt SetWeaponOptions( weapon_options )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weaponOptions","description":"The weapon options to set","mandatory":true}]}]},{"name":"SetWeaponRenderOptions","description":"Sets the weapon render options in the entity.","example":"level.weapon_clientscript_model SetWeaponRenderOptions( level.camo_index, level.reticle_index, level.show_player_tag, level.show_emblem, level.show_paintshop )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{},{},{},{},{}]}]},{"name":"SetWinningPlayer","description":"Sets a player to be the winner","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to set as the winning player","mandatory":true}]}]},{"name":"SetWinningTeam","description":"Sets a team to be the winner","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The team name of the winning team. Must be 'axis', 'allies' or 'none'","mandatory":true}]}]},{"name":"SetWorldFogActiveBank","description":"Sets world fog volumes active bank mask.","example":"self setworldfogactivebank(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"bankMask","description":"Active bank","mandatory":true}]}]},{"name":"SetZBarrierColModel","description":"Sets the collision model for a zbarrier.","example":"ent SetZBarrierColModel(\"p6_anim_zm_barricade_board_collision\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"model","description":"The model.","mandatory":true}]}]},{"name":"SetZBarrierPieceState","description":"Set's the state of the piece indexed in the zbarrier ent. States are open, opening, closed and closing.","example":"ent SetZBarrierPieceState(1, \"open\", 0.8)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true},{"name":"state","description":"State to set - valid states are open, opening, closed and closing.","mandatory":true},{"name":"animation scalar","description":"Valid range 0.1 - 2.0, changes the playback speed of the animation in the set state - numbers less than 1.0 are faster.","mandatory":false}]}]},{"name":"SetZombieName","description":"Set this actors name","example":"guy SetZombieName( \"zombie11\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShellShock","description":"Start a shell shock sequence for the entity for given duration.","example":"self shellShock( \"frag_grenade_mp\", 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{"name":"duration","description":"duration in seconds. The duration must be between 0 and 60 seconds.","mandatory":true},{"name":"allowReduceShellShockPerk","description":"true if shell shock perk should be reduced","mandatory":false}]}]},{"name":"ShootTurret","description":"Shoots a turret","example":"roof_turret ShootTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"ShootUp","description":"Gives an entity vertical movement","example":"betty ShootUp( 350 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"float","description":"upwards velocity","mandatory":true}]}]},{"name":"ShouldDoInitialWeaponRaise","description":"Set weaponstate to force or prevent first raise animation the next time the player switches to it. Only works if the player currently has it","example":"old_state = self ShouldDoInitialWeaponRaise( \"ak47\", false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to set the first raise anim state for","mandatory":true},{"name":"bool shouldDoRaise","description":"Whether the weapon should do the initial raise","mandatory":true}]}]},{"name":"Show","description":"Show the entity","example":"self Show()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ShowAllParts","description":"Show all parts of an entity.","example":"self ShowAllParts()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ShowInfoVolume","description":"Enables an info volume to be drawn with the specified color","example":"InfoVolumeDebug_ShowVolume( info_volume GetEntityNumber(), ( 0.2, 0.2, 0.5 ), 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entnum","description":"The entity number of the info volume","mandatory":true},{"name":"rgb color","description":"The rgb color that the info volume will be drawn with","mandatory":false},{"name":"alpha","description":"The alpha that the info volume will be drawn with","mandatory":false}]}]},{"name":"ShowMiscModels","description":"Show all misc models with this targetname","example":"ShowMiscModels( \"crash_destruct\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"targetname of misc model(s).","mandatory":true}]}]},{"name":"ShowPart","description":"Show part of an entity.","example":"self ShowPart( \"tag_weapon\", \"weapon_saw\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"tagname","description":"The tag to show. All surfaces with a vertex weighted to the tag will be shown. (string)","mandatory":true},{"name":"modelname","description":"The optional model name to help specify the part location. (string)","mandatory":false},{"name":"bApplyToChildren","description":"Optional flag to specify if we should apply the operation to children bones as well. (boolean)","mandatory":false}]}]},{"name":"ShowToPlayer","description":"Show the entity to a given client","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"player","description":"The player to show the entity to.","mandatory":true}]}]},{"name":"ShowToTeam","description":"Show the entity to a particular team","example":"self ShowToTeam( team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"The team to show the entity to.","mandatory":true}]}]},{"name":"ShowZBarrierPiece","description":"Allows the indexed piece to be drawn.","example":"ent ShowZBarrierPiece(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"SightConeTrace","description":"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":"tankVisibilityFraction = tank SightConeTrace( player.origin, player, player.angles, 65)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"sight position","description":"The point the sight starts at","mandatory":true},{"name":"ignore entity","description":"An entity to ignore when doing the traces","mandatory":false},{"name":"cone forward","description":"The forward direction of the cone, whose base is at the . Must be normalized.","mandatory":false},{"name":"cone angle","description":"Angle in degrees from the line of sight to the edge of the cone. Defaults to 65.","mandatory":false}]}]},{"name":"SightTracePassed","description":"Does a sight trace from start to end. Returns true if doesnt hit anything","example":"passed = SightTracePassed( player.origin + ( 0, 0, 64 ), self.origin + ( 0, 0, 64 ), false, undefined )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"hit characters","description":"An entity to ignore","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true}]}]},{"name":"SnapshotAcknowledged","description":"Returns 1 if all clients have acknowledged the snapshot or the timeout has expired. Otherwise returns undefined.","example":"acked = SnapshotAcknowledged( snapindices )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"The array returned by GetSnapshotIndexArray.","mandatory":true}]}]},{"name":"Solid","description":"Set the solid flag, so that this object is collidable.","example":"self Solid()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ent","description":null},"parameters":[]}]},{"name":"SoundExists","description":"Returns true if the given sound exists","example":"if( SoundExists( soundAlias )) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"soundName","description":"The sound alias","mandatory":true}]}]},{"name":"SoundGetAlias","description":"The the string alias of a sound from the hashed sound id. Will return undefined if no sound is found","example":"soundAlias = SoundGetAlias( soundId )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"soundId","description":"the hashed sound id of the alias","mandatory":true}]}]},{"name":"SoundGetPlaybackTime","description":"Get the playback time for the sound","example":"playbackTime = SoundGetPlaybackTime( \"evt_infection_record_oneshot\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"soundName","description":"The sound alias","mandatory":true}]}]},{"name":"Spawn","description":"Spawn an entity.","example":"Spawn( \"trigger_radius\", trigger_origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"classname","description":"The classname of the entity to spawn","mandatory":true},{"name":"origin","description":"The position to spawn at","mandatory":true},{"name":"spawnflags","description":"Optional spawn flags (up to 5)","mandatory":false}]}]},{"name":"SpawnActor","description":"Spawns an actor from an actor spawner, if possible (the spawner won't spawn if the player is looking at the spawn point, or if spawning would cause a telefrag)","example":"spawned = SpawnActor( \"spawner_bo3_soldier_ally_sniper_tool\", origin, angles, \"george\", false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"AIType","description":"AI type (constant string)","mandatory":true},{"name":"origin","description":"The position of the vehicle (vector)","mandatory":true},{"name":"angles","description":"The angle to spawn the vehicle at (vector)","mandatory":true},{"name":"targetname","description":"sets the targetname of the spawned entity","mandatory":false},{"name":"forcespawn","description":"forces a guy to spawn even if the spawn may be visible to the player","mandatory":false},{"name":"fullyaware","description":"gives the AI full awareness of all enemies","mandatory":false},{"name":"spawnerEnt","description":"if passed in, then the fields of the spawnerEnt will be duplicated to the newly spawned actor","mandatory":false}]}]},{"name":"SpawnCollision","description":"Spawns a script mover thats used only for collision","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"modelname","description":"The name of the model to spawn (constant string)","mandatory":true},{"name":"targetname","description":"target name (constant string)","mandatory":true},{"name":"origin","description":"The position of the collision (vector)","mandatory":true},{"name":"angles","description":"The angle to spawn the collision at (vector)","mandatory":true}]}]},{"name":"SpawnFromSpawner","description":"Spawns an actor or vehicle from a spawner, if possible (the spawner won't spawn if the player is looking at the spawn point, or if spawning would cause a telefrag) Unsupplied optional fields will use flag values from the entity","example":"spawned = spawnerent SpawnFromSpawner( \"george\", false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor_or_vehicle_spawner","description":null},"parameters":[{"name":"targetname","description":"sets the targetname of the spawned entity","mandatory":false},{"name":"forcespawn","description":"forces a guy to spawn even if the spawn may be visible to the player","mandatory":false},{"name":"makeroom","description":"will remove an undeletable entity if necessary to spawn a new one","mandatory":false},{"name":"infinitespawn","description":"don't increment the spawn count","mandatory":false},{"name":"classnameOverride","description":"override the spawner's classname","mandatory":false}]}]},{"name":"SpawnFX","description":"Spawn an FX","example":"fx = SpawnFx( level._effect[player.light_playFX], monkey.origin + (0,0,-12),(1,0,0),(0,0,1) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"position","description":"Position to play the fx at","mandatory":true},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false}]}]},{"name":"SpawnHelicopter","description":"Spawns a helicopter","example":"heliGuard = spawnHelicopter( self, startPos, startAng, \"heli_guard_mp\" , \"veh_t6_drone_overwatch_light\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"owner","description":"the owner entity","mandatory":true},{"name":"origin","description":"the location","mandatory":true},{"name":"angles","description":"the angles","mandatory":true},{"name":"vehicle name","description":"the vehicle name","mandatory":true},{"name":"model name","description":"the model name","mandatory":true}]}]},{"name":"SpawnNapalmGroundFlame","description":"Spawn a napalm ground flame at the origin with the direction.","example":"self SpawnNapalmGroundFlame( bot_pos , weapon, forward)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"origin","description":"The origin of the flame","mandatory":true},{"name":"weapon","description":"The weapon","mandatory":true},{"name":"direction","description":"The direction of the flame","mandatory":true},{"name":"time","description":"The time to live","mandatory":false}]}]},{"name":"SpawnPathNode","description":"Spawn a dynamically created path node or cover node","example":"node = SpawnPathNode( cover_left, origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"classname","description":"The class name","mandatory":true},{"name":"origin","description":"The origin","mandatory":true},{"name":"angles","description":"The view angles","mandatory":true},{"name":"key1","description":"Key 1","mandatory":false},{"name":"value1","description":"Value for key 1","mandatory":false},{"name":"key2","description":"Key 2","mandatory":false},{"name":"value2","description":"Value for key 2","mandatory":false}]}]},{"name":"SpawnPlane","description":"Spawns a plane at the origin","example":"plane = spawnplane( owner, \"script_model\", origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"the owner","mandatory":true},{"name":"classname","description":"class of entity","mandatory":true},{"name":"origin","description":"location to spawn at","mandatory":true},{"name":"spawnflags","description":"optional spawn flags","mandatory":false}]}]},{"name":"SpawnStruct","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SpawnTimedFX","description":"Spawns a broadcast entity that plays an oriented timed FX using the weapon's property projExplosionEffect","example":"ent = SpawnTimedFX( smokeGrenade, position, directionUp, duration )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon to spawn fx on","mandatory":true},{"name":"origin","description":"the position to spawn fx at","mandatory":true},{"name":"direction","description":"default (0,0,1)","mandatory":false},{"name":"time","description":"default 10 seconds","mandatory":false},{"name":"team","description":"defaults to TEAM_FREE","mandatory":false}]}]},{"name":"SpawnTurret","description":"Unsupported function. Do not use.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SpawnVehicle","description":"Spawns a new vehicle and returns a reference to it","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vehicletype","description":"vehicle type (constant string)","mandatory":true},{"name":"origin","description":"The position of the vehicle (vector)","mandatory":true},{"name":"angles","description":"The angle to spawn the vehicle at (vector)","mandatory":true},{"name":"targetname","description":"vehicle target name (constant string)","mandatory":false},{"name":"destructibledef","description":"The destructibledef to use to make this vehicle a destructible","mandatory":false}]}]},{"name":"StartBinocs","description":"Start Binoculars on player","example":"player StartBinocs()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StartFadingBlur","description":"Blurs the screen, then fades out the blur to 0, over a period of time.","example":"player StartFadingBlur( 3, 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"blur_amount","description":"The initial blur amount. The value is pixels for Gaussian blur at 640x480. Must be a floating point value greater than 0.","mandatory":true},{"name":"time","description":"Time in seconds, how long the fade out will take","mandatory":true}]}]},{"name":"StartFiring","description":"Starts a turret firing","example":"turret StartFiring()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"StartMission","description":"Start the (server side) mission script for the specified mission - all loading (on all clients) should be completed before calling - use client side LoadMission to load missions","example":"StartMission()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mission_index","description":"index of the mission name to start - mission names can be retrieved by calling GetMissions to return the available mission array","mandatory":true}]}]},{"name":"StartPoisoning","description":"Start poisoning player","example":"player StartPoisoning()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StartRagdoll","description":"Begin ragdoll physics for this entity. Does nothing if the entity is already a ragdoll.","example":"self StartRagdoll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player_or_playercorpse","description":null},"parameters":[{"name":"immediate","description":"Start the ragdoll immediately and don't do the velocity capture on the client.","mandatory":false}]}]},{"name":"StartResurrectViewAngleTransition","description":"Finishes the flashback","example":"self StartResurrectViewAngleTransition()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopAllRumbles","description":"Stop all the rumbles playing right now","example":"StopAllRumbles()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopAnimScripted","description":"Halts animscript on this entity.","example":"self StopAnimScripted()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"blend","description":"The blend out time for the animation","mandatory":false},{"name":"ImmediateStop","description":"Stop the animation immediatly on the client side (no client/server time sync)","mandatory":false}]}]},{"name":"StopBinocs","description":"Stop Binoculars on player","example":"player StopBinocs()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StopDemoRecording","description":"Stops demo recording","example":"Demo_End()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopFiring","description":"Stops a turret firing","example":"turret StopFiring()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"StopJukeMove","description":"Stops the player juke movement in progress","example":"player StopJukeMove()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StopLoopSound","description":"Stops the looping sound with an optional fadetime.","example":"m_chasm stoploopsound( 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"fadetime","description":"Time to fade the sound in. Range is between 1 and 31 inclusive.","mandatory":false}]}]},{"name":"StopMission","description":"fire Mission_Stop event to terminate the current mission","example":"StopMission()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopMoveSlide","description":"Stops the movement caused by MoveSlide().","example":"self StopMoveSlide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"model_origin_brushmodel","description":null},"parameters":[]}]},{"name":"StopPoisoning","description":"Stop poisoning player","example":"player StopPoisoning()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StopRumble","description":"Plays a looping rumble on the given entity.","example":"self StopRumble( \"damage_heavy\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rumble name","description":"The name of the rumble to play","mandatory":true}]}]},{"name":"StopShellShock","description":"Stops the shell shock sequence for the player","example":"player StopShellShock()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StopShootTurret","description":"Stops a turrent from firing.","example":"roof_turret StopShootTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"StopSound","description":"Stop a particular sound on an entity *WARNING*, You must have a wait between StopSounds() and delete() or the sound will not stop.","example":"beatBox StopSound(\"alias\");","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopSounds","description":"Stop all sounds on an entity. *WARNING*, You must have a wait between StopSounds() and delete() or the sound will not stop.","example":"beatBox StopSounds()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"StreamerModelHint","description":"Force a model to be loaded for a set period of time.","example":"streamerModelHint( \"c_hro_hendricks_base_fb\", 10 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"modelname","description":"The name of the model.","mandatory":true},{"name":"duration","description":"Length of time (in seconds) to keep it loaded.","mandatory":true}]}]},{"name":"StreamerRequest","description":"Streamer request","example":"streamerRequest( \"set\", \"ramses_igc1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"command","description":"\"set\", \"clear\" or \"play\"","mandatory":true},{"name":"name","description":"Name of the streamer hint asset","mandatory":true}]}]},{"name":"StreamerSkiptoDebug","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SwitchMap_Load","description":"Start loading a map/level.","example":"SwitchMap_Load( \"cp_sh_cairo\", \"coop\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"the name of the map to preload","mandatory":true}]}]},{"name":"SwitchMap_Preload","description":"Start preloading a map/level. A 'switchmap_preload_finished' notify is sent to the level when its finished.","example":"SwitchMap_Preload( \"cp_sh_cairo\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"the name of the map to preload","mandatory":true}]}]},{"name":"SwitchMap_SetLoadingMovie","description":"Set the loading movie to play","example":"SwitchMap_SetLoadingMovie( str_intro_movie )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"movie_name","description":"The name of the movie","mandatory":true}]}]},{"name":"SwitchMap_Switch","description":"Switch to the loaded map/level","example":"SwitchMap_Switch()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Target_BoundingIsUnderReticle","description":"Returns true if the player's cursor is roughly inside of the target's bounding box.","example":"player Target_BoundingIsUnderReticle( player, enemy_chopper, 1000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player entity","mandatory":true},{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"maxDistance","description":"The maximum distance to check for target intersection","mandatory":true}]}]},{"name":"Target_ClearReticleLockOn","description":"Cancels any lock-on sequence on the hud.","example":"Target_ClearReticleLockOn()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Target_GetArray","description":"Gets an array of entities that are set as targets","example":"mytargets = Target_GetArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Target_GetOffset","description":"Gets the target offset","example":"offset = Target_GetOffset( entity )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity that is the target","mandatory":true}]}]},{"name":"Target_IsInCircle","description":"Returns whether a target is within a given radius from the center of the player's screen","example":"player Target_IsInCircle( enemy_chopper, player, 65, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"radius","description":"radius of the circle, centered at the center of the screen","mandatory":true},{"name":"zoffset","description":"if entity is not in target array, use optional zoffset for target pos","mandatory":false}]}]},{"name":"Target_IsInRect","description":"Returns whether a target is within a given rectangle, centered in the center of the player's screen","example":"player Target_IsInRect( enemy_chopper, player, 65, 100, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"halfwidth","description":"half the width of the rectangle","mandatory":true},{"name":"halfheight","description":"half the height of the rectangle","mandatory":true}]}]},{"name":"Target_IsTarget","description":"Returns whether an entity has been marked as a target","example":"if ( Target_IsTarget( foundEnt ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity to check","mandatory":true}]}]},{"name":"Target_OriginIsInCircle","description":"Returns whether a target is within a given radius from the center of the player's screen","example":"player Target_IsInCircle( enemy_chopper, player, 65, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The origin to test","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"radius","description":"radius of the circle, centered at the center of the screen","mandatory":true}]}]},{"name":"Target_Remove","description":"Removes a target","example":"Target_Remove( enemy_chopper )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true}]}]},{"name":"Target_ScaleMinMaxRadius","description":"Returns the ratio from 0-1 of where the target is in relation to the radius min and radius max","example":"scale = Target_ScaleMinMaxRadius( target, self, level.hackerToolLockOnFOV, radiusInner, radiusOuter )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"radius_min","description":"radius of the circle, centered at the center of the screen","mandatory":true},{"name":"radius_max","description":"radius of the circle, centered at the center of the screen","mandatory":true}]}]},{"name":"Target_Set","description":"Adds a new target to draw on the hud","example":"Target_Set( enemy_chopper )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"target offset","description":"The offset of the target position from the entity's origin","mandatory":false}]}]},{"name":"Target_SetAllowHighSteering","description":"Target will allow incoming missiles to steer more making the target easier to hit","example":"Target_SetAllowHighSteering( enemy_tank, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"bool","description":"true/false\"","mandatory":true}]}]},{"name":"Target_SetAttackMode","description":"Sets how missiles and rockets should approach the target.","example":"Target_SetAttackMode( enemy_tank, \"top\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"mode name","description":"\"top\" or \"direct\"","mandatory":true}]}]},{"name":"Target_SetJavelinOnly","description":"Target will only draw on player's hud when they are looking through the Javelin-weapon's site.","example":"Target_SetJavelinOnly( enemy_tank, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"mode name","description":"\"top\" or \"direct\"","mandatory":true}]}]},{"name":"Target_SetOffscreenShader","description":"Sets the material that is used when a target clamps to the edge of the screen. The target must have already been created with target_set()","example":"Target_SetOffscreenShader( enemy_chopper, \"arrow\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"materialname","description":"The shader for the quad drawn over the target","mandatory":true}]}]},{"name":"Target_SetOffset","description":"Sets the offset for a particular target","example":"Target_SetOffset( enemy_chopper, ( 0, 0, -100 ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"target offset","description":"The offset of the target position from the entity's origin","mandatory":false}]}]},{"name":"Target_SetShader","description":"Changes the material of a target. The target must have already been created with target_set()","example":"Target_SetShader( enemy_chopper, \"locked_on_shader\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"materialname","description":"The shader for the quad drawn over the target","mandatory":true}]}]},{"name":"Target_SetTurretAquire","description":"Sets if the target can be attacked by SAM turrets","example":"Target_SetTurretAquire( chopper, false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity to set the flag","mandatory":true},{"name":"bool","description":"false if you want the SAM turret to ignore the targe. default is true.","mandatory":false}]}]},{"name":"Target_StartReticleLockOn","description":"Begins the lock-on sequence for the target on the hud. This affects the animation of the vehicle reticle.","example":"Target_StartReticleLockOn( enemy_chopper, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"duration","description":"The amount of time between now and fully locked-on, in seconds.","mandatory":true}]}]},{"name":"TestSpawnPoint","description":"Returns true if the player would not be in a solid when spawned at the given point.","example":"TestSpawnPoint( self.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point","description":"the point to test","mandatory":true}]}]},{"name":"TmodeSetServerUser","description":"informs the server if the entity is using tmode","example":"entity TmodeSetServerUser( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"value","description":"(int) 1-using 0-not usuing","mandatory":true}]}]},{"name":"ToggleNoVehicleFaceTraversability","description":"Set whether the entity can use NoVehicleFaces. This should only be used in MP map for now.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"TracePassedOnNavMesh","description":"Run a trace on NavMesh to see if a character can go straight from start to end.","example":"posOnNavMesh = TracePassedOnNavMesh( (10,20,30), 25, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"start of the trace","mandatory":true},{"name":"end","description":"end of the trace","mandatory":true},{"name":"characterRadius","description":"the radius of the capsule used in trace. default to 0.","mandatory":false},{"name":"materialFlags","description":"the flags marking whether a face type can be used","mandatory":false}]}]},{"name":"TriggerEnable","description":"Enables or disables the trigger","example":"trig TriggerEnable( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"flag","description":"True if trigger should be enabled, false otherwise","mandatory":true}]}]},{"name":"TriggerFX","description":"Trigger the fx after some time delay","example":"triggerFx( domFlag.enemyBaseEffect, 0.001 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The fx entity","mandatory":true},{"name":"time delay","description":"The time delay for the fx to play","mandatory":false}]}]},{"name":"TriggerIgnoreTeam","description":"Trigger ignores team","example":"trig TriggerIgnoreTeam()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"Unlink","description":"Unlinks a linked entity from another entity","example":"guy Unlink()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"UnlinkNodes","description":"Disconnects node1 from node2. Call it again with arguments flipped if you want to completely disconnect the two nodes.","example":"UnlinkNodes( node_moving_elev_left, node_moving_elev_right )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"first node to unlink","mandatory":true},{"name":"node2","description":"second node to unlink","mandatory":true}]}]},{"name":"UnlinkTraversal","description":"Destroys a user edge connecting two path nodes","example":"UnlinkTraversal( beginNode )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"Negotiation begin node","mandatory":true}]}]},{"name":"UnlockSongByAlias","description":"Unlock the the sound alias","example":"self UnlockSongByAlias( \"frag_out\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string)","mandatory":true}]}]},{"name":"UnSetTurretNode","description":"Unset the turret from this node.","example":"UnSetTurretNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The turret node to disconnect","mandatory":true}]}]},{"name":"UpdateClientNames","description":"Update all of the client names: only works in 'manual_change' mode","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"UpdateNavTriggers","description":"Optimized code that performs the update_nav_triggers() script functionality","example":"UpateNavTriggers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"UpdateUnlockedAttachmentBits","description":"Updates client->unlockedAttachments","example":"self UpdateUnlockedAttachmentBits()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"UseAnimTree","description":"Sets the anim tree for the entity","example":"self UseAnimTree( #animtree )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"anim tree","description":"The anim tree to set","mandatory":true}]}]},{"name":"UseBuildKitWeaponModel","description":"Use a build kit weapon model","example":"wall_weapon_model UseBuildKitWeaponModel( player, magicbox.weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player whose build kit data will be used","mandatory":true},{"name":"weapon","description":"The weapon to base the build kit on","mandatory":true},{"name":"camoIndex","description":"The index of the camo to override the build kit's camo with","mandatory":false},{"name":"upgraded","description":"bool whether this should be the upgraded version. If so extclip and fmj will be added","mandatory":false}]}]},{"name":"UseBy","description":"Uses the entity with the passed in entity as the activator","example":"self UseBy( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"UseServerVisionset","description":"Switches using the server supplied (via SetVisionSetForPlayer()) visionset.","example":"player UseServerVisionset( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"use it","description":"Whether using the server override visionset","mandatory":true}]}]},{"name":"UseTriggerIgnoreUseHoldTime","description":"Set the require look at flag for the trigger","example":"e_trig_mobile_armory UseTriggerIgnoreUseHoldTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"UseTriggerRequireLookAt","description":"Set the require look at flag for the trigger","example":"e_trig_plaza_igc UseTriggerRequireLookAt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"UseTriggerRequireLookToward","description":"Set the require look along flag for the trigger","example":"e_trig_plaza_igc UseTriggerRequireLookToward()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"UseWeaponHideTags","description":"Hides tags on this entity based on the hidetags value of the provided weaponname","example":"wall_weapon_model UseWeaponHideTags()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the weapon to base the tags to hide on","mandatory":true}]}]},{"name":"UseWeaponModel","description":"Use a weapon model","example":"wall_weapon_model UseWeaponModel(\"m16_zm\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the weapon to base the tags to hide on","mandatory":true},{"name":"model","description":"The name of a model to use. If none is specified the world model for the weapon will be used","mandatory":false},{"name":"weapon options","description":"The weapon options","mandatory":false}]}]},{"name":"Vibrate","description":"Causes a script entity to vibrate, rotating around its origin, along a given vector dir","example":"self Vibrate( directionVir, 0.3, 0.4, 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"direction vector","description":"The direction of the vibration","mandatory":true},{"name":"amplitude","description":"The amount of the vibration in degrees","mandatory":true},{"name":"period","description":"The period of the vibration in seconds","mandatory":true},{"name":"time","description":"The length of time of the vibration in seconds","mandatory":true}]}]},{"name":"VideoPause","description":"Pause video playback","example":"VideoPause( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to pause. do not add a file suffix (like .mp4)","mandatory":true}]}]},{"name":"VideoPrime","description":"Preload the first second of a movie. Call this several seconds before the movie needs to play to prevent any delay","example":"VideoPrime( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to play. do not add a file suffix (like .mp4)","mandatory":true},{"name":"loop","description":"Set this to true if the movie should automatically restart when it reaches the end.","mandatory":false}]}]},{"name":"VideoStart","description":"Start a video for playback on an in-game surface","example":"VideoStart( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to play. do not add a file suffix (like .mp4)","mandatory":true},{"name":"loop","description":"Set this to true if the movie should automatically restart when it reaches the end.","mandatory":false}]}]},{"name":"VideoStop","description":"Stop a video being played on an in-game surface","example":"VideoStop( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to stop. do not add a file suffix (like .mp4)","mandatory":true}]}]},{"name":"VideoUnpause","description":"Unpause video playback","example":"VideoUnpause( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to pause. do not add a file suffix (like .mp4)","mandatory":true}]}]},{"name":"ViewKick","description":"Give the player a view kick","example":"entity ViewKick( 25, self.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"damage","description":"The damage to inflict","mandatory":true},{"name":"origin","description":"The origin of the kick","mandatory":true}]}]},{"name":"VisionSetLastStand","description":"Sets players' laststand vision. Optionally give a transition time from the current vision.","example":"VisionSetLastStand( \"armada\", 1.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vision name","description":"Vision to transition to.","mandatory":true},{"name":"transition time","description":"How long, in seconds, to take transitioning to the new vision set if a transition is possible. Default is one second.","mandatory":false}]}]},{"name":"VisionSetLerpRatio","description":"Determines if you can see an item. Checks distance and view cone before the trace to increase efficency.","example":"self VisionSetLerpRatio ( currentDistance / maxDistance )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"float","description":"ratio between 0 and 1","mandatory":true}]}]},{"name":"VisionSetNaked","description":"Set the vision and its duration","example":"VisionSetNaked( \"cp_igc_chinatown_intro\", 0.05 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The vision set name","mandatory":true},{"name":"duration","description":"The duration of the vision","mandatory":false}]}]},{"name":"WalkUnderwater","description":"Sets if a player should walk while underwater","example":"depth = get_players()[0] WalkUnderwater( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"boolean","description":"true if player should walk underwater. False if player should swim","mandatory":true}]}]},{"name":"WeaponCyclingEnabled","description":"Determine if weapon cycling is enabled for the player","example":"enabled = player WeaponCyclingEnabled()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponHasAttachment","description":"Does the weapon have all the attachments specified?","example":"WeaponHasAttachment( weapon, \"extbarrel\", \"damage, \"fmj\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"WeaponHasAttachmentAndUnlocked","description":"Does the weapon have all the attachments specified? And are they all unlocked for challenge stat purposes?","example":"player WeaponHasAttachmentAndUnlocked( weapon, \"extbarrel\", \"damage, \"fmj\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon","mandatory":true},{"name":"string","description":"string id for attachment","mandatory":true}]}]},{"name":"WorldEntNumber","description":"Returns the entity number for the world","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"WorldToLocalCoords","description":"Transform the given world point into the local space of the entity","example":"local_point = self WorldToLocalCoords( world_point )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"world coords","description":"The point in world coordinates (vector3)","mandatory":true}]}]},{"name":"WorldTrace","description":"Trace from start to end","example":"trace = WorldTrace( start_pos, end_pos )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The trace start point","mandatory":true},{"name":"end","description":"The trace end point","mandatory":true}]}]},{"name":"ZBarrierPieceUseAlternateModel","description":"Sets the indexed piece to use the alternate model.","example":"ent ZBarrierPieceUseAlternateModel(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseAttachWeapon","description":"Sets the indexed piece to attach the zbarrier's weapon to tag_weapon (and tag_weapon_left if it's dual wield).","example":"ent ZBarrierPieceUseAttachWeapon( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseBoxRiseLogic","description":"Sets the indexed piece to use the box rise logic.","example":"ent ZBarrierPieceUseBoxRiseLogic(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseDefaultModel","description":"Sets the indexed piece to use the default model.","example":"ent ZBarrierPieceUseDefaultModel(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseUpgradedModel","description":"Sets the indexed piece to use the upgraded model.","example":"ent ZBarrierPieceUseUpgradedModel(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierSupportsZombieReachThroughAttacks","description":"Returns true if this zbarrier supports zombie reach through attacks.","example":"useAttack = ent ZBarrierSupportsZombieReachThroughAttacks()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ZBarrierSupportsZombieTaunts","description":"Returns true if this zbarrier supports zombie taunt anims.","example":"useTaunt = ent ZBarrierSupportsZombieTaunts()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ZeroGravityVolumeOff","description":"Disables Zero Gravity Volume.","example":"ZeroGravityVolumeOff( \"area_four\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"volume name","description":"The volume name.","mandatory":true}]}]},{"name":"ZeroGravityVolumeOn","description":"Enables Zero Gravity Volume.","example":"ZeroGravityVolumeOn( \"area_four\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"volume name","description":"The volume name.","mandatory":true}]}]},{"name":"AddSentientEventListener","description":"Registers entity to listen to a specific event. Call waittill() to get the notification in script.","example":"self AddSentientEventListener(\"bulletwhizby\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"event","description":"The event name","mandatory":true}]}]},{"name":"aithrowgrenade","description":"Throw a grenade. CheckGrenadeThrowPos() or CheckGrenadeThrow() must be called first.","example":"self GrenadeThrow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"AllowPitchAngle","description":"Allows AI to pitch on stairs","example":"guy AllowPitchAngle ( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"on_off","description":"1 to allow and 0 to disallow","mandatory":true}]}]},{"name":"AnimMode","description":"Set the way that animation deltas are interpreted by the game engine","example":"self AnimMode( \"gravity\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"mode","description":"which animmode to use. Must be 'gravity', 'nogravity', 'angle deltas', 'pos deltas', 'normal', 'normal_nogravity', 'zonly_physics', 'nophysics', 'none'","mandatory":true},{"name":"clear path","description":"The clear path flag","mandatory":false}]}]},{"name":"AtDangerousNode","description":"Determine whether this actor is near a dangerous node.","example":"if ( ai atDangerousNode() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"AttackedRecently","description":"Returns true if given sentient has attacked the entity within last \"time\" sec.","example":"self AttackedRecently(self.enemy)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"entity","description":"The enemy entity","mandatory":true},{"name":"time","description":"Time interval in seconds.","mandatory":true}]}]},{"name":"CalcApproximatePathToPosition","description":"Returns an array of world positions representing the approximate path an actor will take. Calculating an approximate path will cause the AI to clear their current path.","example":"self CalcApproximatePathToPosition( position )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"The goal position for the path","mandatory":true},{"name":"clear path","description":"True to clear path, false otherwise. Defaults to True","mandatory":false}]}]},{"name":"CalcLookaheadPos","description":"Calculate a lookahead point based on a given starting location and number of iterations. Returns an array with these keys: \"position\", \"node\" and \"next_node\", which contain vectors for the actual lookahead position and the next two nodes on the path, respectively.","example":"self CalcLookaheadPos( self.origin, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"startPos","description":"Starting position of the lookahead traces","mandatory":true},{"name":"numIter","description":"Number of times to iterate (more gives better results, but is more expensive). Set to 0 to get current lookahead.","mandatory":true}]}]},{"name":"CanAttackEnemyNode","description":"Checks if this actor can attack its enemies node.","example":"self CanAttackEnemyNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"CanSee","description":"Check to see if the AI can see the given entity.","example":"if( self CanSee( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(entity) The entity to check.","mandatory":true},{"name":"cacheLength","description":"(integer) The cache length","mandatory":false}]}]},{"name":"CanShoot","description":"Check to see if the actor can shoot the given position.","example":"canShoot = self CanShoot( eye, offset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"shoot at position","description":"(vector) The position to shoot at.","mandatory":true},{"name":"offset from gun","description":"(vector) The offset from the gun muzzle from which to calculate collision.","mandatory":false}]}]},{"name":"CanShootEnemy","description":"Check to see if the actor can shoot his current enemy.","example":"canShootEnemy = self CanShootEnemy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"cache duration","description":"(int) When set, uses a custom time value for the cache.","mandatory":false}]}]},{"name":"CanThrowGrenade","description":"Checks whether the actor can throw a grenade at a given position. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CanThrowGrenade( armOffset, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"random range","description":"(float) random range from target position to throw at","mandatory":true}]}]},{"name":"CanThrowGrenadePos","description":"Checks whether the actor can throw a grenade at a given position. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CanThrowGrenadePos( armOffset, targetPos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"targetpos","description":"(vector) The target position, should be at ground level of potential target","mandatory":true}]}]},{"name":"CheckGrenadeThrow","description":"Checks whether the actor can throw a grenade at his target. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CheckGrenadeThrow( armOffset, \"min energy\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"method","description":"(string) The grenade toss method. Can be 'min energy', 'min time', and 'max tune'","mandatory":true},{"name":"random range","description":"(float) random range from target position to throw at","mandatory":true}]}]},{"name":"CheckGrenadeThrowPos","description":"Checks whether the actor can throw a grenade at a given position. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CheckGrenadeThrowPos( armOffset, \"min energy\", targetPos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"method","description":"(vector) The grenade toss method. Can be 'min energy', 'min time', and 'max tune'","mandatory":true},{"name":"targetpos","description":"(vector) The target position, should be at ground level of potential target","mandatory":true}]}]},{"name":"CheckProne","description":"Returns true when a character can go prone at the specified position. Specifically setup for use by AI characters.","example":"canFitProne = self CheckProne( origin, yaw, alreadyProne )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(vector) The position of the prone character.","mandatory":true},{"name":"yaw","description":"(float) The world yaw in degrees.","mandatory":true},{"name":"is prone","description":"(bool) Flag if the character is already prone.","mandatory":true}]}]},{"name":"ChooseBetterCoverNode","description":"Chooses a better cover node for an ai","example":"newNode = behaviorTreeEntity ChooseBetterCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearEnemy","description":"Clear the actor's current enemy entity.","example":"self ClearEnemy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearEntityOwner","description":"Clears an AI's entity owner.","example":"self ClearEntityOwner()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearEntityTarget","description":"Clears an AI's entity target.","example":"self ClearEntityTarget( vehicle_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearFixedNodeSafeVolume","description":"Clears this actor's fixed node safe volume.","example":"self ClearFixedNodeSafeVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearForcedGoal","description":"Clears the forcedGoal for this AI's goal.","example":"self ClearForcedGoal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"ClearGoalVolume","description":"Clears this actor's goal volume.","example":"self ClearGoalVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"ClearPath","description":"Clears the AI's current path.","example":"self ClearPath()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearPitchOrient","description":"Clear pitch orientation","example":"self clearPitchOrient()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearPotentialThreat","description":"Clear the potential threat direction. See SetPotentialThreat for more info on potential threats","example":"self ClearPotentialThreat( 90 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"dir","description":"direction of the threat. This is the angle from which the NPC should expect danger","mandatory":true}]}]},{"name":"ClearUsePosition","description":"Clear the override for the goal pos.","example":"self ClearUsePosition()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"CollideWithActors","description":"Toggles collision with other actors. Actor will go through each other, when its toggled off.","example":"entity CollideWithActors( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{}]}]},{"name":"CreateThreatBiasGroup","description":"Create a new threat bias group. If it already exists, do nothing","example":"CreateThreatBiasGroup( \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"threat bias group name.","mandatory":true}]}]},{"name":"DamageMode","description":"Set the damage mode of this actor.","example":"randAlly DamageMode(\"next_shot_kills\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"damage mode","description":"(const string) DamageMode must be 'normal' or 'next_shot_kills'","mandatory":true}]}]},{"name":"DropWeapon","description":"Drop the actor's weapon","example":"self DropWeapon(self.weapon, self.anim_gunHand, throwVel)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"weapon name","description":"(string) The name of the weapon.","mandatory":true},{"name":"hand","description":"(string) The tag to throw the weapon from.","mandatory":true},{"name":"velocity","description":"(vector) The initial velocity of the weapon.","mandatory":false},{"name":"angular velocity","description":"(vector) The initial angular velocity of the weapon.","mandatory":false},{"name":"scavenger","description":"(bool) If the weapon requires the player to have scavenger perk to pick up the weapon.","mandatory":false}]}]},{"name":"FindBestCoverNode","description":"Find the best cover node for a given NPC given his state.","example":"self FindBestCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"FindBestCoverNodes","description":"Find the best cover nodes for a given NPC given his state. Sorted by best","example":"nodes = self FindBestCoverNodes(radius,origin)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"radius","description":"search radius","mandatory":true},{"name":"origin","description":"search origin","mandatory":true}]}]},{"name":"FindCoverNodeAtLocation","description":"Finds a near by cover node for the character.","example":"guy FindCoverNodeAtLocation(512,loc)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"radius","description":"search radius","mandatory":true},{"name":"origin","description":"search origin","mandatory":true}]}]},{"name":"FindReacquireDirectPath","description":"Finds a path directly to the enemy. Call ReacquireMove to use the path.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"ignore suppression","description":"Whether to ignore suppression when looking for a path. True makes a success more likely but may result in a more dangerous path.","mandatory":false}]}]},{"name":"FindReacquireNode","description":"Finds a reacquire node when exposed.","example":"guy FindReacquireNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"FindReacquireProximatePath","description":"Finds a path to a point that can see the enemy without leaving goal. Call ReacquireMove to use the path.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"ignore suppression","description":"Whether to ignore suppression when looking for a path. True makes a success more likely but may result in a more dangerous path.","mandatory":false}]}]},{"name":"FinishActorDamage","description":"Does damage to an actor - usually as part of the damage callback","example":"self FinishActorDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, vDir, sHitLoc, vDamageOrigin, psOffsetTime, iBoneIndex, iSurfaceType, vSurfaceNormal )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"Hit Loc","description":"The location of the hit","mandatory":true},{"name":"Damage Origin","description":"Position of the originator of the damage","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true},{"name":"Bone Index","description":"Index of nearest bone","mandatory":true},{"name":"Surface Type","description":"The surface type of the hit location","mandatory":false},{"name":"Surface Normal","description":"The surface normal at hit location","mandatory":false}]}]},{"name":"ForceTeleport","description":"Force Teleport the actor to a new position with the given origin and angles, regardless of wether it will be visible to the player or not.","example":"self ForceTeleport( org, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(point) The actor's new position.","mandatory":true},{"name":"angles","description":"(vector) The actor's new angles.","mandatory":false},{"name":"updategoalpos","description":"(bool) Update the script goal position to the teleport location. True by default.","mandatory":false},{"name":"resetEntity","description":"(bool) Reset the entity behaviors.","mandatory":false}]}]},{"name":"GenerateRadioEvent","description":"Searches animation selector table and returns an animation alias based on current state of the blackboard.","example":"self GenerateRadioEvent(\"radio_event_low\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"type of event","description":"The type of radio event","mandatory":true}]}]},{"name":"GetAimLimitsFromEntry","description":"Searches animation selector table and returns an animation alias based on current state of the blackboard.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetBehaviorTreeStatus","description":"Returns current status/BHTN_STATUS of the behavior tree for an actor.","example":"isBehaviorTreeInRunningState = behaviorTreeEntity GetBehaviortreeStatus() == BHTN_RUNNING","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetClosestEnemySqDist","description":"Get the distance to the nearest enemy","example":"dist = self GetClosestEnemySqDist()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"GetDropToFloorPosition","description":"Gets the floor position for dropping an AI or player to the ground. Returns undefined if the AI is in solid.","example":"position = ai GetDropToFloorPosition( ai.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"position","description":"test position. Defaults to entity's current origin","mandatory":false}]}]},{"name":"GetFinalPathPos","description":"Get the last position in the path","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetFireMode","description":"returns the firemode","example":"soldier GetFireMode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetFixedNodeSafeVolume","description":"Get this actor's fixed node safe volume.","example":"volume = self GetFixedNodeSafeVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetFlashBangedStrength","description":"Retrieves how strongly the actor was initially hit by a flashbang. 1.0 is full strength, 0.0 is none at all.","example":"flashedPercent = self GetFlashBangedStrength()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetGoalVolume","description":"Get this actor's goal volume.","example":"goalVolume = self GetGoalVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"GetGroundEntType","description":"Get the entity type of the 'ground' that the actor is on.","example":"self GetGroundEntType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetHitEntType","description":"Get the type of entity that the actor has hit. Can be 'hit', 'obstacle' or 'world'.","example":"self GetHitEntType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetHitYaw","description":"Get the direction in degrees that the player has hit an obstacle at. Returns an error if nothing was hit.","example":"self GetHitYaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetIgnoreEnt","description":"Returns if a specific sentient entity is ignored by this sentient entity or not","example":"if ( aiGuy GetIgnoreEnt( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Another sentient entity","mandatory":true}]}]},{"name":"GetNextFindBestCoverTime","description":"Generates a new next find cover time","example":"behaviorTreeEntity.nextFindBestCoverTime = GetActorNextFindBestCoverTime( behaviorTreeEntity.engageMinDist, behaviorTreeEntity.engagemaxdist, behaviorTreeEntity.coversearchinterval )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"minEngageDist","description":"Min engage enemy dist.","mandatory":true},{"name":"maxEngageDist","description":"Max engage enemy dist.","mandatory":true},{"name":"noEnemyInterval","description":"How often cover should be searched when without an enemy","mandatory":true}]}]},{"name":"GetNodeOffsetAngles","description":"Returns the angles the actor thinks the node is facing, this can contain additional rotation from the node's actual angles.","example":"self GetNodeOffsetAngles( self.node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetNodeOffsetPosition","description":"Returns the position the actor thinks the node's origin is at, this can be offset from where the actual node's position in the world is.","example":"self GetNodeOffsetPosition( self.node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetOrientMode","description":"Set the orient mode of this actor.","example":"orientMode = randAlly GetOrientMode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetPathLength","description":"Gets the length of the path being used by this actor","example":"self GetPathLength()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetPathMode","description":"Get the path mode of this actor.","example":"pathMode = randAlly GetPathMode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetPerfectInfo","description":"Forces the AI to become aware of this entity regardless of whether it can be seen or not.","example":"self GetPerfectInfo( get_players()[0] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An entity to become aware of. Must be a sentient (i.e. AI or player)","mandatory":true},{"name":"update sight","description":"If true then it will update the last seen position also.","mandatory":false}]}]},{"name":"GetPersonalThreatBias","description":"return the personal threat bias for this sentient versus the other sentient","example":"value = self GetPersonalThreatBias( self.enemy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Self","mandatory":true},{"name":"enemy","description":"The enemy to get threat bias for","mandatory":true}]}]},{"name":"GetReacquireNode","description":"Gets the reacquire node of this actor.","example":"guy GetReacquireNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetStealthSightValue","description":"Get the current stealth sight value for this sentient seeing another sentient (floating point from 0.0 to 1.0)","example":"aiGuy GetStealthSightValue( forOtherGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"otherSentient","description":"other sentient you want to get the value on this sentient for","mandatory":true}]}]},{"name":"GetThreatBias","description":"Get threat bias of first group against second group","example":"GetThreatBias( \"axis\", \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"of group","description":"(string) threat bias group for.","mandatory":true},{"name":"against group","description":"(string) threat bias group against.","mandatory":true}]}]},{"name":"GetThreatBiasGroup","description":"Get the threat bias group of an AI or player","example":"GetThreatBiasGroup()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTurnExitYaw","description":"Predicts exit yaw vector using havok pathfinding.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GrenadeThrow","description":"Throw a grenade. CheckGrenadeThrowPos() or CheckGrenadeThrow() must be called first.","example":"self GrenadeThrow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"HasPath","description":"returns true/false if AI has a path","example":"self HasPAth()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"HasValidInterrupt","description":"Return true if there is a valid interrupt with the given name alive on the current server frame.","example":"if ( entity HasValidInterrupt(\"pain\") )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"interrupt name","description":"The name of the interrupt","mandatory":true}]}]},{"name":"IsActorShooting","description":"Checks whether this entity is an ai is shooting","example":"if ( meanGuy IsActorShooting() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An actor","mandatory":true}]}]},{"name":"IsApproachingGoal","description":"returns true/false if actor at the goal or approaching the goal.","example":"self IsApproachingGoal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsAtCoverNode","description":"returns true/false if actor is at cover node. (exposed node is considered as covernode)","example":"self IsAtCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsAtCoverNodeStrict","description":"returns true/false if actor is at cover node. (exposed node is not considered as covernode)","example":"self IsAtCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsAtGoal","description":"returns true/false if actor has at/reached its current goal, similar to waiting for \"goal\" notify.","example":"self IsAtGoal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsBadGuy","description":"Returns true if the sentient is on the bad guy team (not 'allies', not 'neutral').","example":"if ( ai IsBadGuy() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsCoverValid","description":"Return true if the passed in node is a valid cover node.","example":"if( self IsCoverValid( pathnode ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"pathnode","description":"The pathnode to check for validity","mandatory":true}]}]},{"name":"IsCurrentBTActionLooping","description":"Return true if there is an action running and its looping.","example":"if( behaviorTreeEntity IsCurrentBTActionLooping() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsDeflected","description":"Check if the actor has been deflected.","example":"self IsDeflected()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsFlankedAtCoverNode","description":"returns true/false if actor is at is flanked at cover node","example":"self IsFlankedAtCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsGrenadePosSafe","description":"Checks a grenade throw target position is safe.","example":"if ( self IsGrenadeThrowSafe( throwPos, 200 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"throw pos","description":"(vector) position to throw at","mandatory":true},{"name":"radius","description":"(float) safety radius","mandatory":false}]}]},{"name":"IsInAnyBadPlace","description":"Returns whether the AI is in a bad place.","example":"self IsInAnyBadPlace()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsInGoal","description":"Determine whether a given point is in the actor's current goal area","example":"if ( ai IsInGoal( point ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"point","description":"which point to check.","mandatory":true}]}]},{"name":"IsInScriptedState","description":"Checks if actor is in a scripted state (animscripted, custom, negotiation)","example":"self isInScripteState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsKnownEnemyInRadius","description":"Checks if there is a known enemy in a radius for an AI.","example":"if ( self IsKnownEnemyInRadius( pos, radius ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"center of radius to check.","mandatory":true},{"name":"radius","description":".","mandatory":true}]}]},{"name":"IsKnownEnemyInVolume","description":"Checks if there is a known enemy in a volume for an AI.","example":"if ( self isKnownEnemyInVolume( volume ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"volume","description":"volume entity to check in.","mandatory":true}]}]},{"name":"IsMoveSuppressed","description":"Checks whether this actor is in a suppressed state ( blocked by friendly fire ).","example":"while ( self IsMoveSuppressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsNoTarget","description":"returns if the sentient is marked no target","example":"if ( self IsNoTarget() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"IsPathDirect","description":"Check whether the actor's current path is direct","example":"self IsPathDirect()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsPosAtGoal","description":"returns true/false if position is inside the current goal","example":"self IsPosAtGoal(position)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsPosInClaimedLocation","description":"returns true/false if position is claimed by another sentient","example":"self IsPosInClaimedLocation( position )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"IsSafeFromGrenade","description":"returns true/false if actor is within a blast radius of a grenade.","example":"self IsSafeFromGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsStanceAllowed","description":"Checks whether this actor can go to the given stance.","example":"if ( self IsStanceAllowed( \"stand\" ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"stance","description":"(string) A stance, can be 'prone', 'crouch', 'stand'.","mandatory":true}]}]},{"name":"IsSuppressed","description":"Checks whether this actor is in a suppressed state ( under fire ).","example":"while ( self IsSuppressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsSuppressionWaiting","description":"Checks whether this actor is still doing suppression wait.","example":"while ( self IsSuppressionWaiting() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsThreateningMyProtectEntity","description":"Returns true if the enemy is currently threatening my protect entity.","example":"if ( self IsThreateningMyProtectEntity( self.enemy ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(sentient) The sentient to check.","mandatory":true}]}]},{"name":"Knockback","description":"Turn knockback on and off for an actor","example":"self Knockback( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"true/false","description":"if true, actor affected by knockback","mandatory":true}]}]},{"name":"LastKnownPos","description":"Return the last known pos of an AI.","example":"if ( self lastKnownPos( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(sentient) The sentient to check.","mandatory":true}]}]},{"name":"LastKnownTime","description":"Return the last time an AI was aware of target. Includes visibility and ai events like footstep, gunshot etc.","example":"if( self lastKnownTime( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(sentient) The sentient to check.","mandatory":true}]}]},{"name":"LerpPosition","description":"Interpolate an actor's position, and angles.","example":"self LerpPosition( entry['origin'], entry['angles'] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"(vector) the position to interpolate to.","mandatory":true},{"name":"angles","description":"(vector) the angles to interpolate to.","mandatory":true}]}]},{"name":"MayMoveFromPointToPoint","description":"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":"if ( !self MayMoveFromPointToPoint( startPoint endPoint ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"start","description":"(point) start position.","mandatory":true},{"name":"end","description":"(point) end position.","mandatory":true},{"name":"check drop","description":"checks if the point would cause the AI to drop. Defaults to true.","mandatory":false},{"name":"check direct","description":"checks if there are no obstructions between actor origin and .","mandatory":false}]}]},{"name":"MayMoveToPoint","description":"Check whether the actor can move to a given point.","example":"if ( !self MayMoveToPoint( endPoint ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(point) The position that the actor may be able to move to.","mandatory":true},{"name":"check drop","description":"checks if the point would cause the AI to drop. Defaults to true.","mandatory":false},{"name":"check direct","description":"checks if there are no obstructions between actor origin and .","mandatory":false}]}]},{"name":"Melee","description":"Makes this actor melee attack. Returns the entity hit, if any.","example":"guy Melee()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"direction","description":"direction to attack, if not specified, uses direction to current enemy.","mandatory":false}]}]},{"name":"MeleeWithOffset","description":"Makes this actor melee attack. Returns the entity hit, if any.","example":"guy MeleeWithOffset( (0,0,32) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"offset","description":"A vector offset added to the actor's eye position from which to start the melee trace.","mandatory":true}]}]},{"name":"NearClaimNode","description":"Determine whether this actor is near its claim node.","example":"if ( ai NearClaimNode() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"NearClaimNodeAndAngle","description":"Determine whether this actor is near its claim node and nearly matches the angle.","example":"if ( ai NearClaimNodeAndAngle() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"NearNode","description":"Determine whether this actor is near to a given path node.","example":"if ( ai NearNode( node ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"node","description":"The path node to check.","mandatory":true}]}]},{"name":"OrientMode","description":"Set the orient mode of this actor.","example":"randAlly OrientMode(\"face direction\", player.origin-randAlly.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"orient mode","description":"(const string) OrientMode must be 'face angle', 'face current', 'face direction', 'face enemy', 'face enemy or motion', 'face goal', 'face motion', 'face point', or 'face default'","mandatory":true},{"name":"face angle","description":"(float) The yaw angle to face if orient mode is 'face angle'","mandatory":false},{"name":"direction vector","description":"(vector) The direction vector to face if orient mode is 'face direction'","mandatory":false},{"name":"face position","description":"(vector) The point to face if orient mode is 'face point'","mandatory":false}]}]},{"name":"PathMode","description":"Set the path mode of this actor.","example":"randAlly PathMode(\"dont move\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"path mode","description":"(const string) PathMode must be 'dont move', 'move allowed', or 'move delayed'","mandatory":true},{"name":"clear path","description":"(integer) 1 to clear path","mandatory":false},{"name":"path delay","description":"(float) Amount of time (seconds) to wait if path mode is 'move delayed'","mandatory":false}]}]},{"name":"PickUpGrenade","description":"Pick up a grenade","example":"self PickUpGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PredictArrival","description":"Predicts the arrival direction vector using havok corner predictor.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PredictExit","description":"Predicts the exit direction vector using havok corner predictor.","example":"predictedLookAheadInfo = self PredictExit()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PredictPath","description":"Predicts the path to look for upcoming corner using havok corner predictor.","example":"predictedLookAheadInfo = self PredictPath()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PushPlayer","description":"Set whether this character can push the player. Don't call this unless you know what you are doing.","example":"level.elder PushPlayer( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"can push player","description":"(bool) True if this character can push the player.","mandatory":true}]}]},{"name":"ReacquireMove","description":"Start the reaquire move","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ReacquireStep","description":"Do side step move to safe place left or right while facing enemy.","example":"reacquirePos = entity ReacquireStep( step_size )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"dist","description":"(floating point number) amount to side step left or right","mandatory":true}]}]},{"name":"RemoveSentientEventListener","description":"De-Registers entity to listen to a specific event. if event is undefined, entity will stop listening to all the evnets.","example":"self RemoveSentientEventListener(\"bulletwhizby\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"event","description":"The event name","mandatory":false}]}]},{"name":"ResetVisibilityCacheWithinRadius","description":"Reset the viscache for sentients within the specified radius","example":"ResetVisibilityCacheWithinRadius(origin, 500)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Center of reset bounds","mandatory":true},{"name":"radius","description":"Distance around the origin to scan for sentients","mandatory":true}]}]},{"name":"SeeRecently","description":"Check to see if the AI saw the given sentient in the past . If called on a non-sentient, just does a cansee check","example":"if( self SeeRecently( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(entity) The entity to check.","mandatory":true},{"name":"time","description":"(int) seconds.","mandatory":true}]}]},{"name":"SetEntityOwner","description":"Set an entity as the AI's owner. The owner will never be targeted.","example":"self SetEntityOwner( vehicle_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An entity for owner.","mandatory":true}]}]},{"name":"SetEntityTarget","description":"Set an entity as the AI's target. This is for special cases only. Do not set AI or player targets with this.","example":"self SetEntityTarget( vehicle_entity, 0.7, \"tag_head\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An entity to target (cannot be server only entity).","mandatory":true},{"name":"threat","description":"A fraction of maximum possible threat an AI can have. Must be in 0 to 1 range. Defaults to 1.","mandatory":false},{"name":"tag name","description":"Tag to aim/shoot at on this entity. Defaults to tag_eye for actors/players\".","mandatory":false}]}]},{"name":"SetFixedNodeSafeVolume","description":"Set this actor's fixed node safe volume.","example":"self SetFixedNodeSafeVolume( volume )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"volume entity","description":"(entity) The safe volume entity.","mandatory":true}]}]},{"name":"SetFlashBanged","description":"Sets whether an actor is under a flashbang effect.","example":"self SetFlashBanged( true, 0.8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"flashed","description":"Whether or not the actor is under the affect of a flashbang.","mandatory":true},{"name":"strength","description":"If actor is flashed, how severely they were initially affected. Between 0.0 and 1.0 (full strength).","mandatory":false}]}]},{"name":"SetFlashbangImmunity","description":"Sets whether an actor is succeptable to flashbangs.","example":"level.suicideguy SetFlashbangImmunity( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"immune","description":"If the actor can be affected by flashbangs.","mandatory":true}]}]},{"name":"SetFreeCameraLockOnAllowed","description":"Sets whether the ai is allowed to be locked onto in the demo free camera","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"allowed","description":"boolean of whether it is allowed","mandatory":true}]}]},{"name":"SetGoal","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalentity","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalnode","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalpos","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalvolume","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalvolumeauto","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"SetIgnoreEnt","description":"Set a sentient entity to ignore another specific sentient entity or not","example":"aiGuy SetIgnoreEnt( player, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Another sentient entity","mandatory":true},{"name":"ignored","description":"true/false","mandatory":true}]}]},{"name":"SetIgnoreMeGroup","description":"Make first group ignored by second group","example":"SetIgnoreMeGroup( \"flanking_team\", \"axis\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"ignored group","description":"(string) ignored group.","mandatory":true},{"name":"ignoring group","description":"(string) ignoring group.","mandatory":true}]}]},{"name":"SetPersonalIgnore","description":"self will not pick enemy as target for the duration","example":"self SetPersonalIgnore( self.enemy, 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Self","mandatory":true},{"name":"enemy","description":"The enemy to set threat bias for","mandatory":true},{"name":"duration","description":"How long this threat bias lasts in seconds","mandatory":false}]}]},{"name":"SetPersonalThreatBias","description":"Sets a personal threat bias for this sentient versus the other sentient. It lasts for the given duration.","example":"self SetPersonalThreatBias( self.enemy, -1000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Self","mandatory":true},{"name":"enemy","description":"The enemy to set threat bias for","mandatory":true},{"name":"threatBias","description":"The threat bias amount","mandatory":true},{"name":"duration","description":"How long this threat bias lasts in seconds","mandatory":false}]}]},{"name":"SetPhysParams","description":"Sets the collision bounds for an actor.","example":"self setPhysParams( 15, 0, 72 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"radius","description":"size of the actor.","mandatory":true},{"name":"minsz","description":"min height of the actor.","mandatory":true},{"name":"maxsz","description":"max height of the actor.","mandatory":true}]}]},{"name":"SetPitchOrient","description":"Set pitch orientation","example":"self setPitchOrient()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"SetPotentialThreat","description":"In non-combat situations. This is mostly useful for friendlies.","example":"self SetPotentialThreat( 90 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"dir","description":"direction of the threat. This is the angle from which the NPC should expect danger","mandatory":true}]}]},{"name":"SetRepairPaths","description":"True allows havok to repath automatically if the AI moves off their predefined path.","example":"self SetRepairPaths( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"on_off","description":"true to enable repair paths, false otherwise","mandatory":true}]}]},{"name":"SetStairsExitTransform","description":"Sets the base transform for the exit stairs animation using the current position in the looping anim","example":"self SetStairsExitTransform()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"SetStealthSight","description":"Set the parameters for given awarenesslevel of stealth sight when active on an sentient","example":"SetStealthSight( \"high_alert\", 2, 1, 10, 200, 1000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"awareness","description":"\"unaware\", \"low_alert\", \"high_alert\", or \"combat\"","mandatory":true},{"name":"timeDecay","description":"float value of seconds stealth sight takes to fall off completely (0 for never/infinite)","mandatory":true},{"name":"timeDistMin","description":"float value of seconds stealth sight takes to grow completely at min range (0 for never/infinite)","mandatory":true},{"name":"timeDistMax","description":"float value of seconds stealth sight takes to grow completely at max range (0 for never/infinite)","mandatory":true},{"name":"distMin","description":"float value of the min distance","mandatory":true},{"name":"distMax","description":"float value of the max distance","mandatory":true},{"name":"extendSight","description":"indicates of sight continues beyond max range at the max rate","mandatory":false}]}]},{"name":"SetStealthSightAwareness","description":"Set the current stealth sight awareness state for this sentient","example":"aiGuy SetStealthSightAwareness( \"unaware\", true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"awareness","description":"\"unaware\", \"low_alert\", \"high_alert\", \"combat\", or undefined to disable it (default disabled)","mandatory":false},{"name":"decayEnabled","description":"if true stealth sight will decay when other sentient is not in sight (default true)","mandatory":false}]}]},{"name":"SetStealthSightValue","description":"Set the current stealth sight value for this sentient seeing another sentient (floating point from 0.0 to 1.0)","example":"aiGuy SetStealthSightValue( forOtherGuy, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"otherSentient","description":"other sentient you want to set the value on this sentient for","mandatory":true},{"name":"newValue","description":"The new stealth sight value","mandatory":true}]}]},{"name":"SetSteeringMode","description":"Sets the steering mode for the actor. Valid modes are \"normal steering\", \"slow steering\", \"vignette steering\".","example":"self SetSteeringMode( \"slow steering\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"steering mode","description":"Mode to set.","mandatory":true}]}]},{"name":"SetThreatBias","description":"Set threat bias of second group against first group","example":"SetThreatBias( \"axis\", \"flanking_team\", 120 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"against group","description":"(string) threat bias group against.","mandatory":true},{"name":"for group","description":"(string) threat bias group for.","mandatory":true},{"name":"threat bias","description":"(int) threat bias value.","mandatory":true}]}]},{"name":"SetThreatBiasAgainstAll","description":"Set the threatbias a group has against all others","example":"SetThreatBiasAgainstAll( \"flanking_team\", 120 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"group","description":"(string) threat bias group name.","mandatory":true},{"name":"value","description":"(int) threat bias value.","mandatory":true}]}]},{"name":"SetThreatBiasGroup","description":"Set or clear threat bias group of an AI or player","example":"SetThreatBiasGroup( \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"threat_bias_group","description":"(string) threat bias group name. If none, remove actor from current threat bias group","mandatory":false}]}]},{"name":"Shoot","description":"Makes this actor shoot.","example":"guy shoot()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"accuracy modifier","description":"(floating point number)","mandatory":false},{}]}]},{"name":"ShouldFaceMotion","description":"Determines if the AI should face the motion direction. Use self.faceMotion instead of this except when the AI is just beginning to move.","example":"self ShouldFaceMotion()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldHoldGroundAgainstEnemy","description":"Return true if enemy is within pathEnemyFightDist.","example":"if( behaviorTreeEntity ShouldHoldGroundAgainstEnemy() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldStartArrival","description":"returns true/false if actor should start arriving at given node","example":"self ShouldStartArrival()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldStartTraversal","description":"returns true/false if actor should start traversal","example":"self ShouldStartTraversal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldUseCoverNode","description":"returns true/false if actor is at is safe at cover node and use it as a cover","example":"self ShouldUseCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"StartCoverArrival","description":"Runs cover arrival animscript on an actor.","example":"soldier StartCoverArrival( pos, 45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"start pos","description":"the offset to start the arrival animation from","mandatory":true},{"name":"yaw angles","description":"the arrival angle","mandatory":true}]}]},{"name":"Teleport","description":"Teleport the actor to a new position with the given origin and angles.","example":"self Teleport( org, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(point) The actor's new position.","mandatory":true},{"name":"angles","description":"(vector) The actor's new angles.","mandatory":false}]}]},{"name":"ThreatBiasGroupExists","description":"Check if a threat bias group exists","example":"ThreatBiasGroupExists( \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"threat bias group name.","mandatory":true}]}]},{"name":"TraverseMode","description":"Set the traverse mode of this actor.","example":"self TraverseMode( \"nogravity\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"traverse mode","description":"(const string) Possible traverse modes are 'gravity', 'nogravity', or 'noclip'","mandatory":true}]}]},{"name":"TrimPathtoAttack","description":"Trims the path to attack.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"UseCoverNode","description":"Tells this actor to use the given cover node. This is invalid if the actor's keepclaimednode flag is set. Returns true or false depending on whether the actor can claim the node.","example":"guy UseCoverNode( covernode )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"path node","description":"The path node to use as cover","mandatory":true}]}]},{"name":"UsePosition","description":"Override where the actor should run to. This overrides the goal pos and the claimed node.","example":"self UsePosition( pos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"The position for the actor to run to.","mandatory":true},{"name":"arrivalfinalposition","description":"The arrivalfinalposition if this is an arrival.","mandatory":false}]}]},{"name":"UseReacquireNode","description":"Use the given reacquire node.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"node","description":"(path node) the node to use.","mandatory":true}]}]},{"name":"Abs","description":"Returns the absolute value of a float","example":"x = Abs( x )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A float or integer value.","mandatory":true}]}]},{"name":"AbsAngleClamp180","description":"Returns abs angle value clamped between [0,180].","example":"deltaAngle = AbsAngleClamp180( currentAngle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"Angle to be clamped","mandatory":true}]}]},{"name":"AbsAngleClamp360","description":"Returns as a value in the range of 0 and 360 degrees.","example":"new_angle = AbsAngleClamp360( boatAngles[2] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle.","mandatory":true}]}]},{"name":"ACos","description":"Returns an angle corresponding to a particular cosine value","example":"upAngle = ACos( distanceratio )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cos value","description":"A cosine value","mandatory":true}]}]},{"name":"AngleClamp180","description":"Returns angle value clamped between [-180,180].","example":"deltaAngle = AngleClamp180( currentAngle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"Angle to be clamped","mandatory":true}]}]},{"name":"AngleLerp","description":"Returns lerped angle value.","example":"180 = AngleLerp( 0, 360, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"An angle.","mandatory":true},{"name":"to","description":"An angle.","mandatory":true},{"name":"fraction","description":"A float from 0-1.","mandatory":true}]}]},{"name":"AnglesToForward","description":"Returns the forward vector corresponding to a set of angles.","example":"forward = AnglesToForward( forward )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"A set of angles","mandatory":true}]}]},{"name":"AnglesToRight","description":"Returns the right vector corresponding to a set of angles.","example":"right = AnglesToRight(angles)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"A set of angles","mandatory":true}]}]},{"name":"AnglesToUp","description":"Returns the up vector corresponding to a set of angles.","example":"up = AnglesToUp(angles)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"A set of angles","mandatory":true}]}]},{"name":"ASin","description":"Returns an angle corresponding to a particular sin value","example":"upAngle = ASin( upAmount )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sin value","description":"A sin value","mandatory":true}]}]},{"name":"ATan","description":"Returns an angle corresponding to a particular tangential value","example":"upAngle = ATan( height/distance )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"tan value","description":"A tangential value","mandatory":true}]}]},{"name":"Ceil","description":"Returns the ceiling of floating point value . This effectively rounds up Ceil(2.7) == 3, Ceil(3.9) == 4.","example":"rounded_down = Floor( val )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true}]}]},{"name":"Closer","description":"Tests which of two points is the closest. Returns true if point a is closer to the reference than point b","example":"if( Closer( center, models[j].origin , models[i].origin ))...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"reference","description":"The base position","mandatory":true},{"name":"point a","description":"The first point","mandatory":true},{"name":"point b","description":"The second point","mandatory":true}]}]},{"name":"CombineAngles","description":"Returns angles b reoriented by angles a.","example":"crateAnglesInWorld = CombineAngles( boatAngles, crateAnglesInBoat )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles a","description":"Angles representing the orientation in which to place ","mandatory":true},{"name":"angles b","description":"Angles which will be reoriented","mandatory":true}]}]},{"name":"Cos","description":"Returns the cos of an angle","example":"frac = Cos( degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle in degrees","mandatory":true}]}]},{"name":"DiffTrack","description":"Returns a lagged value between and based on and ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"to","description":"Float, start of the range","mandatory":true},{"name":"from","description":"Float, end of the range","mandatory":true},{"name":"rate","description":"Floating point","mandatory":true},{"name":"deltaTime","description":"Time elapsed","mandatory":true}]}]},{"name":"DiffTrackAngle","description":"Returns a lagged angle between and based on and . Properly accounts for wrapping 2pi","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"to","description":"Float, start of the range","mandatory":true},{"name":"from","description":"Float, end of the range","mandatory":true},{"name":"rate","description":"Floating point","mandatory":true},{"name":"deltaTime","description":"Time elapsed","mandatory":true}]}]},{"name":"Distance","description":"Returns the distance between two points","example":"dist = Distance( org, ai[i].origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"Distance2D","description":"Returns the distance between two points, ignores height difference.","example":"dist = Distance2D( org, ai[i].origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"Distance2DSquared","description":"Returns the squared distance between two points, ignores height difference.","example":"distsq = Distance2DSquared( org, ai[i].origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"DistanceSquared","description":"Returns the squared distance between two points - this is cheaper than the actual distance as it doesn't involve a square root","example":"dist2 = DistanceSquared(models[j].origin, center)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"Float","description":"Casts a string or an integer to a float","example":"x = Float( floatValString )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A string or integer number to cast to a float","mandatory":true}]}]},{"name":"Floor","description":"Returns the floor of floating point value . This effectively rounds down Floor(2.7) == 2, Floor(3.9) == 3.","example":"rounded_down = Floor( val )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true}]}]},{"name":"ForwardRotateAroundUpByAngle","description":"returns a vector that is the result of angles1 forward vector rotated around its up by degrees","example":"v=ForwardRotateByAngles( player_angles, frustum_edge_angle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"GetMinBitCountForNum","description":"Returns the minimum number of bits needed to express the provided integer","example":"GetMinBitCountForNum( 15 ) returns 4","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"uint","description":"The integer a minimum bit count is needed for","mandatory":true}]}]},{"name":"Int","description":"Casts a floating point number or a string to an integer","example":"x = Int( self.HUDHealthHeight )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A string or floating point number to cast to an integer","mandatory":true}]}]},{"name":"Length","description":"Returns the length of the given vector","example":"dist = Length(models[j].origin - center)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"A vector","mandatory":true}]}]},{"name":"LengthSquared","description":"Returns the squared vector length for the given vector - this is cheaper than the actual vector length as it doesn't involve a square root","example":"dist2 = LengthSquared(models[j].origin - center)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"A vector","mandatory":true}]}]},{"name":"LerpFloat","description":"Returns a lerped value between and based on ","example":"val = LerpFloat( 0, 10, 0.5);\t// would return 5.0","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"Floating point value, start of the range","mandatory":true},{"name":"to","description":"Floating point value, end of the range","mandatory":true},{"name":"time","description":"Floating point value in the range of 0 - 1","mandatory":true}]}]},{"name":"LerpVector","description":"Returns a lerped vector value between and based on ","example":"val = LerpVector( (0,0,0), (5,5,5), 0.5);\t// would return (2.5, 2.5, 2.5)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"Vector, start of the range","mandatory":true},{"name":"to","description":"Vector, end of the range","mandatory":true},{"name":"time","description":"Floating point value in the range of 0 - 1","mandatory":true}]}]},{"name":"Log","description":"Returns the logarithm of a number to base 10","example":"y = Log( x )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"MapFloat","description":"Returns a lerped value between and based on . is a value between and .","example":"val = MapFloat( 1, 2, 0, 10, 1.5); // would return 5.0","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"timeMin","description":"Floating point value, min time value","mandatory":true},{"name":"timeMax","description":"Floating point value, max time value","mandatory":true},{"name":"from","description":"Floating point value, start of the result range","mandatory":true},{"name":"to","description":"Floating point value, end of the result range","mandatory":true},{"name":"time","description":"Floating point value in the range from to ","mandatory":true}]}]},{"name":"Max","description":"Returns whichever of or is larger.","example":"largest = Max( val1, val2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true},{"name":"b","description":"A float or integer value.","mandatory":true}]}]},{"name":"Min","description":"Returns whichever of or is smallest.","example":"smallest = Min( val1, val2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true},{"name":"b","description":"A float or integer value.","mandatory":true}]}]},{"name":"PackRgba","description":"Packs rgba into a single int.","example":"Byte4PackRgba( 1.0, 1.0, 1.0, 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"red","description":"as a float 0.0-1.0","mandatory":true},{"name":"green","description":"as a float 0.0-1.0","mandatory":true},{"name":"blue","description":"as a float 0.0-1.0","mandatory":true},{"name":"alpha","description":"as a float 0.0-1.0","mandatory":true}]}]},{"name":"PointOnSegmentNearestToPoint","description":"Given a line segment and a point P, this returns the point on the segment that is closest to P.","example":"nearestPoint = PointOnSegmentNearestToPoint( A, B, P )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"SegmentA","description":"One endpoint of the line segment","mandatory":true},{"name":"SegmentB","description":"Other endpoint of the line segment","mandatory":true},{"name":"P","description":"The point","mandatory":true}]}]},{"name":"Pow","description":"Return the value of base raised to exp power.","example":"c = pow( 2, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exp","description":"A float or integer value, .\"","mandatory":true}]}]},{"name":"RandomFloat","description":"Returns a random floating point number r, where 0 <= r < max","example":"if ( RandomFloat( 100 ) > 50 ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"max","description":"The maximum floating point size","mandatory":true}]}]},{"name":"RandomFloatRange","description":"Returns a random floating point number r, where min <= r < max","example":"rand = RandomFloatRange( 3.0, 5.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"min","description":"The minimum result","mandatory":true},{"name":"max","description":"The maximum result","mandatory":true}]}]},{"name":"RandomInt","description":"Returns a random integer between `0` and `max - 1` inclusive.","example":"if ( RandomInt( 100 ) > 50 ) ...","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":null,"parameters":[{"name":"max","description":"The maximum integer size.","type":{"dataType":"int"},"mandatory":true}],"returns":{"name":"result","type":{"dataType":"int"},"description":"A random integer between `0` and `max - 1` inclusive."}}]},{"name":"RandomIntRange","description":"Returns a random integer `result`, where `min ≤ result < max`.","example":"rand = RandomIntRange( 3, 5 )","flags":["verified"],"overloads":[{"calledOn":null,"parameters":[{"name":"min","description":"The minimum result.","type":{"dataType":"int"},"mandatory":true},{"name":"max","description":"The maximum result + 1.","type":{"dataType":"int"},"mandatory":true}],"returns":{"name":"result","type":{"dataType":"int"},"description":"A random integer `result`, where `min ≤ result < max`."}}]},{"name":"RotatePoint","description":"Returns lerped angle value.","example":"rotatedPoint = RotatePoint(point, angle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point","description":"A point.","mandatory":true},{"name":"angles","description":"An angle.","mandatory":true}]}]},{"name":"RotatePointAroundAxis","description":"returns a vector that is the result of point rotated around the axis vector by num degrees","example":"v = RotatePointAroundAxis( point, up, degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{},{}]}]},{"name":"Sin","description":"Returns the sin of an angle","example":"frac = Sin( degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle in degrees","mandatory":true}]}]},{"name":"Sqrt","description":"Returns the square-root of floating point value .","example":"c = sqrt( (a*a) + (b*b) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true}]}]},{"name":"Tan","description":"Returns the tan of an angle","example":"frac = Tan( degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle in degrees","mandatory":true}]}]},{"name":"VectorCross","description":"Returns the cross product of two vectors","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector a","description":"The first vector","mandatory":true},{"name":"vector b","description":"The second vector","mandatory":true}]}]},{"name":"VectorDot","description":"Returns the dot product of two vectors","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector a","description":"The first vector","mandatory":true},{"name":"vector b","description":"The second vector","mandatory":true}]}]},{"name":"VectorFromLineToPoint","description":"Given a line and a point P, this returns a vector perpendicular to the line and pointing from the line to P.","example":"myvector = VectorFromLineToPoint( A, B, P )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"SegmentA","description":"One point on the line","mandatory":true},{"name":"SegmentB","description":"Another point on the line","mandatory":true},{"name":"P","description":"The point","mandatory":true}]}]},{"name":"VectorLerp","description":"Linear interpolates between two vectors.","example":"color = VectorLerp(oldColor, newColor, timeElapsed / timeTotal)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"The vector whose value is used when fraction is 0","mandatory":true},{"name":"to","description":"The vector whose value is used when fraction is 1","mandatory":true},{"name":"fraction","description":"The fraction of the way between vectors. Values less than 0 or greater than 1 do linear extrapolation.","mandatory":true}]}]},{"name":"VectorNormalize","description":"Returns a normalized copy of this vector","example":"difference = VectorNormalize(end - start)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"The vector to normalize","mandatory":true}]}]},{"name":"VectorProjection","description":"Returns the vector projection of vector a onto vector b","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector a","description":"The first vector","mandatory":true},{"name":"vector b","description":"The second vector","mandatory":true}]}]},{"name":"VectortoAngles","description":"Returns a set of angles corresponding to the given vector.","example":"angles = VectortoAngles(end - start)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"The vector to convert to angles","mandatory":true}]}]},{"name":"ActionButtonPressed","description":"Check if the player is pressing the 'action' button. Use this for when the player might be in a scripted sequence but might still press the jump button.","example":"while( self ActionButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotFourButtonPressed","description":"Check if the player is pressing the action slot 4 button","example":"if ( self ActionSlotFourButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotOneButtonPressed","description":"Check if the player is pressing the action slot 1 button","example":"if ( self ActionSlotOneButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotThreeButtonPressed","description":"Check if the player is pressing the action slot 3 button","example":"if ( self ActionSlotThreeButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotTwoButtonPressed","description":"Check if the player is pressing the action slot 2 button","example":"if ( self ActionSlotTwoButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"AddToDamageIndicator","description":"Add damage to damage indicator","example":"self AddToDamageIndicator( int( armor_damage ), vDir)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"dmg","description":"The damage","mandatory":true},{"name":"direction","description":"The direction of hit","mandatory":false}]}]},{"name":"AdsButtonPressed","description":"Check if the player is pressing the 'ads' button.","example":"while( self AdsButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"AllowAds","description":"Sets whether the player can switch to ADS","example":"player AllowAds( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player ads","description":": A boolean. true if the player can switch to ADS, and false otherwise.","mandatory":true}]}]},{"name":"AllowCrouch","description":"Sets whether the player can crouch","example":"player AllowCrouch( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player crouch","description":": A boolean. true if the player can crouch, and false otherwise","mandatory":true}]}]},{"name":"AllowDoubleJump","description":"Sets whether the player can double jump","example":"player AllowDoubleJump( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"on off","description":": A boolean. true if the player can double jump, and false otherwise","mandatory":true}]}]},{"name":"AllowJump","description":"Sets whether the player can jump","example":"player AllowJump(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player jump","description":": A boolean. True if the player can jump, and false otherwise","mandatory":true}]}]},{"name":"AllowLean","description":"Sets whether the player can lean","example":"player AllowLean( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player lean","description":": A boolean. true if the player can lean, and false otherwise","mandatory":true}]}]},{"name":"AllowMelee","description":"Sets whether the player can melee","example":"player AllowMelee(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"melee","description":": A boolean. True if the player can melee, and false otherwise","mandatory":true}]}]},{"name":"AllowMeleePowerLeft","description":"Sets whether the player can melee power left","example":"player AllowMeleePowerLeft(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"melee","description":": A boolean. True if the player can melee power left, and false otherwise","mandatory":true}]}]},{"name":"AllowProne","description":"Sets whether the player can go prone","example":"player AllowProne( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player prone","description":": A boolean. true if the player can go prone, and false otherwise","mandatory":true}]}]},{"name":"AllowSlide","description":"Sets whether the player can slide","example":"player AllowSlide( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"on off","description":": A boolean. true if the player can slide, and false otherwise","mandatory":true}]}]},{"name":"AllowSpectateTeam","description":"Set whether the player can spectate the given team.","example":"self AllowSpectateTeam( \"axis\", true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"team","description":"A string description of the team. Valid teams are 'axis', 'allies', 'none' or 'freelook'","mandatory":true},{"name":"spectate","description":"A boolean value describing whether this player can spectate on this team.","mandatory":true}]}]},{"name":"AllowSprint","description":"Sets whether the player can sprint","example":"player AllowSprint(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player sprint","description":": A boolean. True if the player can sprint, and false otherwise","mandatory":true}]}]},{"name":"AllowStand","description":"Sets whether the player can stand up","example":"player AllowStand( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player stand","description":": A boolean. true if the player can stand, and false otherwise","mandatory":true}]}]},{"name":"AllowWallRun","description":"Sets whether the player can wall run","example":"player AllowWallRun( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"on off","description":": A boolean. true if the player can wallrun, and false otherwise","mandatory":true}]}]},{"name":"AnyAmmoForWeaponModes","description":"Returns true if the weapon has any ammo left","example":"if ( !(self AnyAmmoForWeaponModes( weapon )) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to check","mandatory":true}]}]},{"name":"ApplyKnockBack","description":"Applies a knockback on a player.","example":"player ApplyKnockBack( 10, dir )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"amount","description":"the amount of knockback to apply","mandatory":true},{"name":"dir","description":"the direction of knockback to apply","mandatory":false}]}]},{"name":"AreControlsFrozen","description":"Returns true if the controls are frozen","example":"if( player AreControlsFrozen() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"AttackButtonPressed","description":"Check if the player is pressing the fire button","example":"if ( self AttackButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"BeginLocationAirstrikeSelection","description":"Begin a location air strike selection","example":"self BeginLocationAirstrikeSelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationArtillerySelection","description":"Begin a location artillery selection","example":"self BeginLocationArtillerySelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationComlinkSelection","description":"Begin a location com link selection","example":"self BeginLocationComlinkSelection( LOCATION_SELECTOR, 1000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationMortarSelection","description":"Begin a location mortar selection","example":"self BeginLocationMortarSelection( LOCATION_SELECTOR, 1500 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationNapalmSelection","description":"Begin a location napalm selection","example":"self BeginLocationNapalmSelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationSelection","description":"Begin a location selection","example":"self BeginLocationSelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BoostButtonPressed","description":"Check if the player is pressing the change seat (Y) button","example":"if ( self BoostButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"BotSetRandomCharacterCustomization","description":"Equips this class number with the default class","example":"self BotSetRandomCharacterCustomization()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"bot","description":null},"parameters":[]}]},{"name":"ButtonBitState","description":"Return true if the button_bit(s) indicated are pressed (note: there is no way to know exactly which buttons are pressed on the client, since everything is remapped into these bit values)","example":"if ( self ButtonBitState( \"BUTTON_BIT_ATTACK\") ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"button","description":": name of button to check \"BUTTON_BIT_ATTACK\" for example, optionally can include as many button names as desired. Returns true if all buttons indicated are true.","mandatory":true}]}]},{"name":"ButtonPressed","description":"Check if the host is pressing the button/key, \"BUTTON_A\", \"BUTTON_B\", \"K\", etc...","example":"while( self ButtonPressed( \"BUTTON_A\" ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CalcPlayerOptions","description":"Calculate player options","example":"playerRenderOptions = self CalcPlayerOptions( class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom class slot","description":"The custom class slot","mandatory":true}]}]},{"name":"CalcWeaponOptions","description":"Calculates weapon options","example":"primaryWeaponOptions = self CalcWeaponOptions( class_num, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom class slot","description":"The custom class slot","mandatory":true},{"name":"weapon slot","description":"primary weapon=0 or secondary weapon=1 or knife weapon=2","mandatory":true}]}]},{"name":"CameraActivate","description":"Turns the script camera on or off.","example":"get_players()[0] CameraActivate( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"active","description":"True to activate the camera, false to turn it off and return to 1st person view","mandatory":true}]}]},{"name":"CameraSetAngles","description":"Sets the focus point of the script camera.","example":"get_players()[0] CameraSetAngles( ( 1100, -23, 644 ) )get_players()[0] CameraSetAngles( my_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"position","description":"Either an entity to focus the camera on or a vector defining the camera's focus point","mandatory":false}]}]},{"name":"CameraSetLookAt","description":"Sets the focus point of the script camera.","example":"get_players()[0] CameraSetLookAt( ( 1100, -23, 644 ) )get_players()[0] CameraSetLookAt( my_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"position","description":"Either an entity to focus the camera on or a vector defining the camera's focus point","mandatory":false}]}]},{"name":"CameraSetPosition","description":"Sets the position of the script camera.","example":"get_players()[0] CameraSetPosition( ( 1100, -23, 644 ) )get_players()[0] CameraSetPosition( my_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"position","description":"Either an entity to link the camera to or a vector defining the world position","mandatory":true},{"name":"angles","description":"The angles to set for the camera","mandatory":false}]}]},{"name":"CanPlaceRiotshield","description":"Try to place riotshield where the player is standing. return an array containing placement \"result\", \"origin\", and \"angles","example":"placement = level.player CanPlaceRiotshield()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CanPlayerPlaceTurret","description":"Try to place a Turret where the player is looking. It'll return an array containing the placement \"result\", \"origin\", and \"angles\".","example":"placement = level.player CanPlayerPlaceTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CanPlayerPlaceVehicle","description":"Try to place a vehicle in front of the player. It'll return an array containing the placement \"result\", \"origin\", and \"angles\".","example":"placement = level.player CanPlayerPlaceVehicle( 25, 45, 50, 40, 80, 0.7 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"radius","description":"Radius of the bounds check","mandatory":true},{"name":"height","description":"Height of the bounds check","mandatory":true},{"name":"forward Distance","description":"Distance away from player origin.","mandatory":true},{"name":"up Distance","description":"Distance up from player origin.","mandatory":true},{"name":"sweep Distance","description":"Distance to sweep downwards.","mandatory":true},{"name":"min normal","description":"Minimum hit normal needed to be pass.","mandatory":true}]}]},{"name":"CantSeeEntities","description":"Returns the set of entities that a player cannot see within a given angle, given a set of entities","example":"if( isplayer( self.enemy ) && self.enemy CantSeeEntities( entArray, 67 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entArray","description":"The entities to check against","mandatory":true},{"name":"dotRange","description":"The cosine of the angle representing your fov","mandatory":true},{"name":"trace","description":"Perform a trace for entities","mandatory":true}]}]},{"name":"CarryTurret","description":"Links the auto turret to the player to carry around.","example":"player CarryTurret( turret, offset, angleOffset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"The turret entity","mandatory":true},{"name":"offset","description":"the offset from the player to place the turret","mandatory":true},{"name":"angleOffset","description":"the angle offset of the turret","mandatory":true}]}]},{"name":"ChangeSeatButtonPressed","description":"Check if the player is pressing the change seat (Y) button","example":"if ( self ChangeSeatButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ClearDamageIndicator","description":"Clear damage indicator","example":"self ClearDamageIndicator()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"ClearPerks","description":"removes all perks for a player","example":"player ClearPerks()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ClonePlayer","description":"clone the player's model for death animations.","example":"body = self ClonePlayer(deathAnimDuration)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"deathAnimationDuration","description":"the duration of the death animation","mandatory":true},{"name":"killing weapon","description":"weapon that killed the player","mandatory":true},{"name":"attacker","description":"attacker that killed the player","mandatory":false}]}]},{"name":"CloseInGameMenu","description":"close the in game menu for this client.","example":"player CloseInGameMenu()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"CloseLUIMenu","description":"Closes the given lui menu and returns true if it finds the menu and succeeds in closing it, false otherwise.","example":"player CloseLUIMenu( menu )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu handle","description":"handle to the lui menu.","mandatory":true}]}]},{"name":"CloseMenu","description":"close the specified menu for this client.","example":"player CloseMenu( game[ \"menu_changeclass\" ] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"menu index","description":"The precached menu index of type \"menu\"","mandatory":true}]}]},{"name":"CreateFlashbackClone","description":"clone the player's model for temporary flashback model","example":"body = self CreateFlashbackClone()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"DamageRiotShield","description":"Apply damage to a player riot shield or other weapon that supports damage states.","example":"newhealth = player DamageRiotShield( 100 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DeathStreakActive","description":"Returns true if player's death streak is active","example":"if( player DeathStreakActive() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableDeathStreak","description":"Disable player's death streak","example":"player DisableDeathStreak()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableInvulnerability","description":"Makes player vulnerable to damage. This is default behavior","example":"player DisableInvulnerability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableOffhandWeapons","description":"Disable the player's offhand weapons","example":"player DisableOffhandWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableRoundStartDelay","description":"Enable players weapon after round start delay","example":"player DisableRoundStartDelay()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableUsability","description":"Disables usability for the player","example":"player DisableUsability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableWeaponCycling","description":"Disable the player's weapon cycling","example":"player DisableWeaponCycling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableWeaponFire","description":"Disable the player's weapon fire","example":"player DisableWeaponFire(()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableWeapons","description":"Disable the weapons of the player","example":"self DisableWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"quick","description":"Set the Disable weapons quick flag","mandatory":false}]}]},{"name":"DropItem","description":"Drop an item with the given item name","example":"self DropItem( current )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"item name","description":"the name of the item to drop","mandatory":true},{"name":"dropTag","description":"If specified drop and snap the weapon to this tag","mandatory":false}]}]},{"name":"DropScavengerItem","description":"Drop an item with the given item name. This item will be only available to those with the scavenger perk","example":"self DropScavengerItem( \"scavenger_item_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"item name","description":"the name of the item to drop","mandatory":true}]}]},{"name":"EnableDeathStreak","description":"Enable player's death streak","example":"player EnableDeathStreak()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableInvulnerability","description":"Makes player invulnerable to damage","example":"player EnableInvulnerability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableOffhandWeapons","description":"Enable the player's offhand weapons","example":"player EnableOffhandWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableRoundStartDelay","description":"Disable the players weapon during round start","example":"player EnableRoundStartDelay()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableUsability","description":"Enables usability for the player","example":"player EnableUsability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableWeaponCycling","description":"Enable the player's weapon cycling","example":"player EnableWeaponCycling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableWeaponFire","description":"Enable the player's weapon fire","example":"player EnableWeaponFire()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableWeapons","description":"Enables the weapons of the player","example":"self EnableWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EndLocationSelection","description":"Ends location selection","example":"self endLocationSelection()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"FakeDamageFrom","description":"Make the player take damage from the given direction","example":"self FakeDamageFrom(vDir)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"dir","description":"The direction to take damage from","mandatory":true}]}]},{"name":"finishMeleeHit","description":"Notifies the clients of the melee hit or miss","example":"self finishMeleeHit( eAttacker, sWeapon, vPoint, vDir, iBoneIndex, bHit )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Origin","description":"(vector) The origin of the damage","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"bone index","description":"Which bone was the closest to the hit","mandatory":true},{"name":"shieldHit","description":"Was the hit delivered against a shield","mandatory":true},{"name":"hit","description":"Was the hit successful or a swipe","mandatory":true},{"name":"fromBehind","description":"Was the hit from behind the victim","mandatory":true}]}]},{"name":"FinishPlayerDamage","description":"Does damage to a player - usually as part of the damage callback","example":"self FinishPlayerDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, vDir, sHitLoc, iBone, vDamageOrigin, psOffsetTime, vSurfaceNormal )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Point","description":"Damage point","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"Hit Loc","description":"The location of the hit","mandatory":true},{"name":"Damage Origin","description":"Where the damage originated from.","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true},{"name":"bone index","description":"Which bone was the closest to the hit","mandatory":true},{"name":"Surface Normal","description":"The normal of the surface impacted.","mandatory":true}]}]},{"name":"ForceGrenadeThrow","description":"Forces the player to throw a held grenade","example":"player ForceGrenadeThrow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ForceOffHandEnd","description":"Force the player to not use offhand weapon","example":"self forceoffhandend()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ForceSlick","description":"Sets whether the player is forced to be on a slick surface","example":"player ForceSlick(true)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slick","description":": A boolean. True if the player is on a slick surface, and false otherwise","mandatory":true}]}]},{"name":"FragButtonPressed","description":"Check if the player is pressing the frag button","example":"if ( self FragButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"FreezeControls","description":"Blocks or unblocks control input from this player","example":"player FreezeControls( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"freeze state","description":": true if the player's controls are frozen, false otherwise.","mandatory":true}]}]},{"name":"FreezeControlsAllowLook","description":"Blocks or unblocks control input from this player, but allows the player to look around","example":"level.player FreezeControlsAllowLook( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"freeze state","description":": true if the player's controls are frozen, false otherwise.","mandatory":true}]}]},{"name":"GamepadUsedLast","description":"Check if the player is playing with a gamepad.","example":"if( player GamepadUsedLast() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterBodyModel","description":"Gets the body model for this player as selected in character customization","example":"self GetCharacterBodyModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"modelType","description":"The index of the model type, defaults to CCBODY_MODEL_THIRDPERSON","mandatory":false}]}]},{"name":"GetCharacterBodyRenderOptions","description":"Gets the body render options for this player","example":"self GetCharacterBodyRenderOptions()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterBodyType","description":"Gets the character body type for the player.","example":"bodyIndex = self GetCharacterBodyType( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterHeadModel","description":"Gets the head model for this player","example":"self GetCharacterHelmetModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterHelmetModel","description":"Gets the helmet model for this player as selected in character customization","example":"self GetCharacterHelmetModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"modelType","description":"The index of the model type, defaults to CCBODY_MODEL_THIRDPERSON","mandatory":false}]}]},{"name":"GetControllerUIModelValue","description":"Gets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.","example":"player GetControllerUIModelValue( \"hudItems.regenDelayProgress\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"ui model data path from controller","description":"precached name string for the data which we're trying to get.","mandatory":true}]}]},{"name":"GetCurrentOffHand","description":"Get the current offhand weapon","example":"weapon = self GetCurrentOffhand()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCurrentWeapon","description":"Gets the current player weapon","example":"currentweapon = player GetCurrentWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCurrentWeaponAltWeapon","description":"Gets the alt weapon for the players current weapon. Returns \"none","example":"currentweapon = player GetCurrentWeaponAltWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCurrentWeaponSpinLerp","description":"Gets the current weapon spin ","example":"weapon_spin_lerp = self GetCurrentWeaponSpinLerp()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetEnemyDogTagModel","description":"Get the enemy of the dog tag model currently associated character body","example":"friendly_model = player GetEnemyDogTagModel( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetFractionMaxAmmo","description":"Get fraction of the max ammo","example":"frac = players[i] GetFractionMaxAmmo( lethal_grenade )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give max ammo to","mandatory":true}]}]},{"name":"GetFractionStartAmmo","description":"Give fraction of start ammo to the player for the weapon","example":"start = player GetFractionStartAmmo( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give ammo to","mandatory":true}]}]},{"name":"GetFriendlies","description":"Returns an array of friendly players. The player called on is not included in the array.","example":"friends = self GetFriendlies()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":"true, return only players that are alive, false return all players","mandatory":false}]}]},{"name":"GetFriendlyDogTagModel","description":"Get the friendly of the dog tag model currently associated character body","example":"friendly_model = player GetFriendlyDogTagModel( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetGunAngles","description":"Get the player's gun angles","example":"angles = player GetGunAngles()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetHeroAbilityName","description":"Returns the name of the weapon assigned to the currently selected body","example":"weaponName = self GetHeroAbilityName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetHeroWeaponName","description":"Returns the name of the weapon assigned to the currently selected body","example":"weaponName = self GetHeroWeaponName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetInventoryHeldWeapon","description":"Gets the player's inventory held weapon","example":"inventoryWeapon = player GetInventoryHeldWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetInventoryWeapon","description":"Get the inventory weapon","example":"inventoryWeapon = self GetInventoryWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetIpAddress","description":"Gets the IP address of the player.","example":"ipAddress = self GetIpAddress()","flags":["malicious"],"overloads":[{"calledOn":{"name":"target","description":"The player to get the IP of.","type":{"dataType":"struct","instanceType":"player","isArray":false}},"parameters":[],"returns":{"name":"ip","description":"The IP address of the player.","type":{"dataType":"string","isArray":false}}}],"verifiedInRevision":3},{"name":"GetLeagueTeamID","description":"Get the league team ID","example":"id = player GetLeagueTeamID()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLightingState","description":"Gets the current lighting state for the player","example":"ls = player GetLightingState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLockOnLossRadius","description":"Returns the lock on loss radius for the currently equipped heatseeking launcher.","example":"radius = player GetLockOnRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLockOnOrigin","description":"gets the origin to use for the replay gun lockon on the entity","example":"player GetLockOnOrigin( entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true}]}]},{"name":"GetLockOnRadius","description":"Returns the lock on radius for the currently equipped heatseeking launcher.","example":"radius = player GetLockOnRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLockOnSpeed","description":"Returns the lock on speed in miliseconds for the currently equipped heatseeking launcher.","example":"speed = player GetLockOnSpeed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLUIMenu","description":"Returns a handle to a lui menu.","example":"player GetLUIMenu( \"myMenu\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu name","description":"name of the menu.","mandatory":true}]}]},{"name":"GetLUIMenuData","description":"Gets the current value for the given data name.","example":"player GetLUIMenuData( menu, \"title\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu handle","description":"handle for the lui menu.","mandatory":true},{"name":"lui menu data name","description":"name of the data which had been set on the menu.","mandatory":true}]}]},{"name":"GetMpDialogName","description":"Get the name of the mpdialog bundle of the currently associated character body","example":"mpDialogBundleName = player GetMpDialogName( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetNormalizedCameraMovement","description":"Get the player's camera movement normalized","example":"v_stick = player GetNormalizedCameraMovement()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetNormalizedMovement","description":"Get the player's movement normalized","example":"norm_move = self GetNormalizedMovement()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetOffHandSecondaryClass","description":"Get whether the player is using a flash or smoke","example":"offhand_secondary = self GetOffHandSecondaryClass()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPerks","description":"Gets all the player's active perks.","example":"perks = player GetPerks()","flags":["verified"],"verifiedInRevision":4,"overloads":[{"calledOn":{"name":"player","description":"The player to get the perks of.","type":{"dataType":"struct","instanceType":"player"}},"parameters":[],"returns":{"name":"perks","description":"An array of the `specialty` names of the perks the player currently has. This is empty when the player has no perks.","type":{"dataType":"string","isArray":true}}}]},{"name":"GetPlayerAngles","description":"Get the player view angles","example":"angles = player GetPlayerAngles()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayerAttachmentCosmeticVariantIndexes","description":"Get the player's held weapon acvi ","example":"acvi = self GetPlayerAttachmentCosmeticVariantIndexes( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get acvi from","mandatory":true}]}]},{"name":"GetPlayerCameraPos","description":"Get the player's camera position","example":"vieworg = player GetPlayerCameraPos()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayerGenderType","description":"Returns the gender string of the player","example":"if ( self GetPlayerGenderType() == \"male\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"mode","description":"SessionMode","mandatory":true}]}]},{"name":"GetPlayerMovementState","description":"Returns the player movement state for the match record. ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetPlayerSelectedGesture","description":"Get the equipped gesture ","example":"gesture = player GetPlayerSelectedGesture( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"gestureType","description":"The type of gesture to get","mandatory":true}]}]},{"name":"GetPlayerSelectedTaunt","description":"Get the equipped taunt ","example":"taunt = player GetPlayerSelectedTaunt( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"tauntType","description":"The type of taunt to get","mandatory":true}]}]},{"name":"GetPlayerShowcaseWeapon","description":"Get the showcase weapon of the given player","example":"showcaseWeapon = player GetPlayerShowcaseWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayerViewHeight","description":"Get the player's view height","example":"height = player GetPlayerViewHeight()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"getreplaygunlockonorigin","description":"gets the origin to use for the replay gun lockon on the entity","example":"player GetLockOnOrigin( entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true}]}]},{"name":"GetSnapshotAckIndex","description":"Get the snapshot acknowledgment index","example":"num = self getsnapshotackindex()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetSunShadowSplitDistance","description":"Gets the current sun shadow split difference for the player","example":"distance = player GetSunShadowSplitDistance()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetTargetScreenAngles","description":"Get target screen view angles","example":"angles = self GetTargetScreenAngles( targetpos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"targetpos","description":"The position to get angles for.","mandatory":true}]}]},{"name":"GetVehicleBoostTime","description":"Gets the vehicle's max boost time","example":"boostTime = player GetVehicleBoostTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleBoostTimeLeft","description":"Gets the vehicle's remaining boost time","example":"boostTimeLeft = player GetVehicleBoostTimeLeft()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleFocusEntity","description":"Gets the current vehicle focus entity for the player","example":"focusEnt = player GetVehicleFocusEntity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleMinBoostTime","description":"Gets the vehicle's min boost time needed in order to boost","example":"minBoostTime = player GetVehicleMinBoostTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleOccupied","description":"Returns the vehicle entity that the player occupies. If player isn't in a vehicle then this causes an error.","example":"self GetVehicleOccupied()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetWeaponAcvi","description":"Gets weapon options from held weapon","example":"primaryWeaponAcvi = self GetWeaponAcvi( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true}]}]},{"name":"GetWeaponAmmoClip","description":"Gets the given weapon's magazine ammo count.","example":"ammo = self GetWeaponAmmoClip( weapon )","flags":["verified"],"verifiedInRevision":4,"overloads":[{"calledOn":{"name":"player","description":"The player that owns the weapon.","type":{"dataType":"struct","instanceType":"player"}},"parameters":[{"name":"weapon","description":"The weapon to get the ammo count of.","type":{"dataType":"struct","instanceType":"weapon"},"mandatory":true}],"returns":{"name":"ammo","description":"The number of rounds the weapon has in its magazine.","type":{"dataType":"int","isArray":false}}}]},{"name":"GetWeaponAmmoFuel","description":"Get the weapon's fuel count ","example":"fuel = self GetWeaponAmmoFuel( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get fuel count from","mandatory":true}]}]},{"name":"GetWeaponAmmoStock","description":"Get the weapon's total ammo count ","example":"ammo = self GetWeaponAmmoStock( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get ammo count from","mandatory":true}]}]},{"name":"GetWeaponForWeaponRoot","description":"Returns a weapon that the player is holding that has the same weapon root. Returns undefined if the player is not holding the weapon.","example":"weapon_with_attachments = player GetWeaponForWeaponRoot( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to check","mandatory":true}]}]},{"name":"GetWeaponOptions","description":"Get the weapon's render options ","example":"weaponOptions = self GetWeaponOptions( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get options from","mandatory":true}]}]},{"name":"GetWeaponsList","description":"Gets an array of all weapons that the player has. Alt-mode weapons by default are not included","example":"weapList = player GetWeaponsList()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"include_alt_modes","description":"1/True to include alt-mode weapons","mandatory":false}]}]},{"name":"GetWeaponsListPrimaries","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GiveDedicatedShadow","description":"Sets the model lod bias","example":"player GiveDedicatedShadow( 8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"The entity to enable the dedicated shadow on","mandatory":true}]}]},{"name":"GiveMaxAmmo","description":"Give the weapon max ammo","example":"self GiveMaxAmmo( primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give ammo to","mandatory":true}]}]},{"name":"GiveNextBaseWeapon","description":"Give the player the next base weapon","example":"self GiveNextBaseWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GiveStartAmmo","description":"Give the weapon initial ammo","example":"self GiveStartAmmo( primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give ammo to","mandatory":true}]}]},{"name":"GiveWeapon","description":"Give a weapon to the player","example":"e_player GiveWeapon( w_spike_launcher )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give","mandatory":true},{"name":"options","description":"The weapon options","mandatory":false},{"name":"acvi","description":"The attachment cosmetic variant index","mandatory":false}]}]},{"name":"GiveWeaponNextAttachment","description":"Give the weapon the next attachment","example":"self giveweaponnextattachment( \"muzzle\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"attachment point","description":"The attachment point name","mandatory":true}]}]},{"name":"HasAGrenadePulledBack","description":"check is a client has a grenade (any type including special) currently pulled back","example":"self HasAGrenadePulledBack( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"HasMaxPrimaryWeapons","description":"Returns true if the player has maximum primary weapons","example":"if( self HasMaxPrimaryWeapons() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"HasPerk","description":"test if player has a perk","example":"player HasPerk( \"specialty_gpsjammer\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"perk name","description":"the perk to check","mandatory":true}]}]},{"name":"HasRiotShield","description":"Return true if player has a riot shield in their inventory.","example":"if ( player HasRiotShield() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"HasWeapon","description":"Returns true if the player has the given weapon","example":"if( e_player HasWeapon( w_spike_launcher, true ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to check","mandatory":true},{"name":"ignore_attachments","description":"Only check the root weapon, ignore all the attachments.","mandatory":false}]}]},{"name":"HideViewModel","description":"Hide the player's current view model.","example":"player HideViewModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"InitialWeaponRaise","description":"Setup weaponstate to force first raise animation","example":"self InitialWeaponRaise( \"ak47\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon name","description":"The weapon to try first raise anim with","mandatory":true}]}]},{"name":"InventoryButtonPressed","description":"Check if the player is pressing the inventory button","example":"if ( self InventoryButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsCarryingTurret","description":"Check if player is carrying turret or not.","example":"player IsCarryingTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsChargeShotPending","description":"Returns true if player has a charge shot pending with a charge shot weapon","example":"if( self IsChargeShotPending() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsDroppingWeapon","description":"Returns true if the player is currently dropping their weapon","example":"player IsDroppingWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsFiring","description":"Returns true if the player is currently meleeing","example":"player IsFiring()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsGrappling","description":"Returns true if the player is currently grappling","example":"player IsGrappling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsHost","description":"Returns true if the player is the host","example":"player IsHost()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsHostForBots","description":"Returns true if the passed in entity is the host for bots","example":"player IsHostForBots()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsInMoveMode","description":"Returns true if the player is in either of the given move modes","example":"if ( player IsInMoveMode( \"ufo\", \"noclip\" ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"move_mode_1","description":"The move mode to check","mandatory":true},{"name":"move_mode_2","description":"The move mode to check","mandatory":false}]}]},{"name":"IsInVehicle","description":"Returns whether or not this player is currently occupying a vehicle.","example":"self IsInVehicle()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsLocalToHost","description":"Returns true if the player is on the same physical machine as the host","example":"player IsLocalToHost()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsLookingAt","description":"Returns true if the player is looking at entity","example":"if( isplayer( self.enemy ) && self.enemy islookingat( self ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":"The entity to check","mandatory":true}]}]},{"name":"IsMeleeing","description":"Returns true if the player is currently meleeing","example":"player IsMeleeing()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPlayerOnSameMachine","description":"Returns whether or not this player is on the same machine as the other player.","example":"if ( self IsPlayerOnSameMachine( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player","description":"The player to test against","mandatory":true}]}]},{"name":"IsReloading","description":"Returns true if the player is currently reloading","example":"player IsReloading()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsRemoteControlling","description":"Returns whether or not this player is currently occupying a remote controlled entity.","example":"self IsRemoteControlling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsSwitchingWeapons","description":"Returns true if the player is currently switching weapons","example":"player IsSwitchingWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTalking","description":"Returns true if the player is talking via voice chat","example":"if( player IsTalking() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsThrowingGrenade","description":"Returns true if the player is currently throwing a grenade","example":"player IsThrowingGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsUsingOffHand","description":"Returns true if player is using offhand weapon","example":"if( self IsUsingOffHand() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsWeaponOverheating","description":"Is the players Weapon Overheating?","example":"self IsWeaponOverheating()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"get heatval","description":"If positive pass back the heatval of the weapon (0 to 100).","mandatory":false},{"name":"weapon","description":"If present check this specific weapon otherwise check the player's current weapon.","mandatory":false}]}]},{"name":"IsWeaponViewOnlyLinked","description":"Returns whether or not this player is linked to an enity with weapon view only linking.","example":"self IsWeaponViewOnlyLinked()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"JumpButtonPressed","description":"Check if the player is pressing the 'jump' button.","example":"while( self JumpButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"LinkGuidedMissileCamera","description":"set player eflags for the guided missile","example":"player LinkGuidedMissileCamera()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"LinkToMissile","description":"Links a player camera and controls to a missile","example":"player LinkToMissile( rocket, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{},{"name":"boost_enabled","description":": If true, the player can trigger missile boost","mandatory":false},{"name":"brake_enabled","description":": If true, the player can trigger missile brake","mandatory":false}]}]},{"name":"MeleeButtonPressed","description":"Check if the player is pressing the melee button","example":"if ( self MeleeButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"MurderLine","description":"Get all the enemy players on the line between given points and murder them to death","example":"player MurderLine( origin, endpos, \"kniferang_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"from","description":"The from position","mandatory":true},{"name":"to","description":"The to position","mandatory":true},{"name":"weapon","description":"The weapon used","mandatory":true}]}]},{"name":"NextPlayerRenderOption","description":"Set the next player render option","example":"level.dev_cac_player NextPlayerRenderOption( tag, forward )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"optionName","description":"The tag of the next option","mandatory":true},{"name":"forward","description":"The delta","mandatory":true}]}]},{"name":"OffhandSpecialButtonPressed","description":"Check if the player is pressing the gadget button","example":"if ( self OffhandSpecialButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"OpenLUIMenu","description":"Opens a lui menu( has to be precahced ) and returns a handle to it.","example":"player OpenLUIMenu( \"myMenu\", true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu name","description":"name of the menu.","mandatory":true},{"name":"persistent","description":"the menu will remain open even if the player dies.","mandatory":false}]}]},{"name":"OpenMenu","description":"Open the menu with the given menu index","example":"self openMenu( game[ \"menu_changeclass\" ] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"menu index","description":"The menu index","mandatory":true}]}]},{"name":"OpenMenuNoMouse","description":"Open the menu with the given menu index","example":"self OpenMenuNoMouse( game[ \"menu_changeclass\" ] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"menu index","description":"The menu index","mandatory":true}]}]},{"name":"PickupAmmoEvent","description":"Lets the client know a weapon was picked up","example":"self PickupAmmoEvent( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"PickupWeaponEvent","description":"Lets the client know a weapon was picked up","example":"self PickupWeaponEvent( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":true}]}]},{"name":"PingPlayer","description":"Flashes a player on their teammate's compasses","example":"self PingPlayer()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayBombDefuse","description":"Play the players bomb defuse animation","example":"self PlayBombDefuse()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayBombPlant","description":"Play the players bomb plant animation","example":"self PlayBombPlant()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayClientAirstrike","description":"Plays the client sided part of the airstrike/bombrun","example":"PlayClientAirstrike( pos, yaw, \"marines\", \"axis\", owner, \"left\", height )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of airstrike","mandatory":true},{"name":"yaw","description":"The yaw","mandatory":true},{"name":"teamFaction","description":"The team faction","mandatory":true},{"name":"team","description":"The team","mandatory":true},{"name":"owner","description":"The owner of airstike","mandatory":true},{"name":"exittype","description":"The exit type","mandatory":true},{"name":"height","description":"The height","mandatory":true}]}]},{"name":"PlayClientNapalm","description":"Plays the client sided part of the Napalm","example":"PlayClientNapalm( startPos, plane.yaw, \"vietcong\", \"axis\", plane.owner, \"left\", height )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of Napalm","mandatory":true},{"name":"yaw","description":"The yaw","mandatory":true},{"name":"teamFaction","description":"The team faction","mandatory":true},{"name":"team","description":"The team","mandatory":true},{"name":"owner","description":"The owner of Napalm","mandatory":true},{"name":"exittype","description":"The exit type","mandatory":true},{"name":"height","description":"The height","mandatory":true}]}]},{"name":"PlayerADS","description":"Gets the player weapon position fraction","example":"if ( self PlayerADS() > 0.3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayerKnockback","description":"Turn knockback on and off for a player","example":"self PlayerKnockback( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"true/false","description":"if true, client affected by knockback","mandatory":true}]}]},{"name":"PlayHitMarker","description":"Plays a hit marker event","example":"self PlayHitMarker( \"evt_squad_activate\", 3, \"flakjacket\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"sound name","description":"The name of the sound or hash","mandatory":true},{"name":"damage state","description":"How damaged the victim is","mandatory":false},{"name":"perk feedback","description":"If the victim had any perks active that modified the hit marker","mandatory":false},{"name":"is dead","description":"If the victim has died from this hit marker and needs a red flash","mandatory":false}]}]},{"name":"PlayLocalSound","description":"Plays a sound locally","example":"self playlocalsound( \"evt_squad_activate\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"sound name","description":"The name of the sound or hash","mandatory":true}]}]},{"name":"PrimaryButtonPressedLocal","description":"Check if the local player is pressing the primary button (BUTTON_A)","example":"if ( self PrimaryButtonPressedLocal() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PrimeMovie","description":"Starts priming the cinematic movie to be played.","example":"self PrimeMovie( \"mymovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"moviename","description":"movie name","mandatory":true}]}]},{"name":"ReloadButtonPressed","description":"Check if the player is pressing the 'usereload' button.","example":"while( self reloadButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ReloadWeaponAmmo","description":"Set the weapon's ammoclip from the ammo","example":"self ReloadWeaponAmmo( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to be reloaded","mandatory":true}]}]},{"name":"RemoteControlTurret","description":"Remote control into a turret","example":"player RemoteControlTurret( turret )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"the remote controlled turret.","mandatory":true}]}]},{"name":"RemoteControlTurretOff","description":"Stops remote controlling a turret","example":"player RemoteControlTurretOff( turret )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"the remote controlled turret.","mandatory":true}]}]},{"name":"ResetAnimations","description":"Reset player animations after a body type change","example":"self ResetAnimations())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetCharacterCustomization","description":"Resets all of the character customization to what is in the player stats","example":"self ResetCharacterCustomization()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetFlashBack","description":"Resets the players flashback history","example":"self resetflashback()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetSpreadOverride","description":"Reset the player's aim spread to 255","example":"self ResetSpreadOverride()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"Revive","description":"Revive the player","example":"self Revive())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"RevivePlayer","description":"Callback from script to get player out of last stand, increases health, removes damage timer, should clear screen of damageFX","example":"self RevivePlayer()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"SayAll","description":"Write a client chat message from this client to everybody","example":"self SayAll( saytext )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"message","description":"A localizable message to send to all players","mandatory":true}]}]},{"name":"SayTeam","description":"Write a client chat message from this client to everybody on their team","example":"self SayTeam( sayText )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"message","description":"A localizable message to send to all players on the player's team.","mandatory":true}]}]},{"name":"SecondaryButtonPressedLocal","description":"Check if the local player is pressing the secondary button (BUTTON_B)","example":"if ( self SecondaryButtonPressedLocal() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SecondaryOffhandButtonPressed","description":"Check if the player is pressing the secondary offhand button","example":"if ( self SecondaryOffhandButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SetActionSlot","description":"Sets action slot for the player","example":"self SetActionSlot( 4, \"weapon\", level.DEAD_CONTROL_WEAPON )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slot","description":"The action slot","mandatory":true},{"name":"action slot type","description":"The type of slot. can be \"weapon\"/\"altMode\"/\"\"","mandatory":true},{"name":"weapon","description":"The weapon to set","mandatory":false}]}]},{"name":"SetArenaPoints","description":"Sets the player's arena points","example":"player SetArenaPoints( 19 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"point","description":"points","mandatory":true}]}]},{"name":"SetBlockWeaponPickup","description":"Blocks the player from picking up other weapons while using this weapon","example":"self setBlockWeaponPickup( killstreakWeapon, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to set block for","mandatory":true},{"name":"enabled","description":"True if weapon pickup should be blocked","mandatory":true}]}]},{"name":"SetCarryingObject","description":"Enable or disable the player carrying object flag. Disables doublejump and juke","example":"self SetCarryingObject( true ); // disables doublejump and juke","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"True to enable, false otherwise","mandatory":true}]}]},{"name":"SetCharacterBodyStyle","description":"Sets the character body style for the current body type. Resets all colors for the body style to default.","example":"self SetCharacterBodyStyle( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"character body type index","description":"The index of the character body type","mandatory":true}]}]},{"name":"SetCharacterBodyType","description":"Sets the character body type for the player. Resets all other customization to default for the new body type.","example":"self SetCharacterBodyType( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"character body type index","description":"The index of the character body type","mandatory":true},{"name":"character head type index","description":"The index of the character head type","mandatory":false}]}]},{"name":"SetCharacterHelmetStyle","description":"Sets the character body style for the current helmet type. Resets all colors for the helmet style to default.","example":"self SetCharacterHelmetStyle( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"character body type index","description":"The index of the character body type","mandatory":true}]}]},{"name":"SetClientCGObjectiveText","description":"Sets the objective text only on this client","example":"self SetClientCGObjectiveText( util::getObjectiveScoreText( self.pers[\"team\"] ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"text","description":"The text to set","mandatory":true}]}]},{"name":"SetClientCompass","description":"Sets compass dvar only on this client","example":"self SetClientCompass( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientDrawTalk","description":"Sets cg_drawTalk dvar only on this client","example":"self SetClientDrawTalk( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientFocalLength","description":"Sets cg_focalLength dvar only on this client","example":"self SetClientFocalLength( 23.3622 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The focal length value to set (float)","mandatory":true}]}]},{"name":"SetClientHUDHardcore","description":"Sets ui_hud_hardcore dvar only on this client","example":"self SetClientHUDHardcore( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientMiniScoreboardHide","description":"Sets miniscoreboardhide dvar only on this client","example":"players[i] SetClientMiniScoreboardHide( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"enable","description":"True/1 to hide, false/0 otherwise","mandatory":true}]}]},{"name":"SetClientNumLives","description":"Sets scr_numLives dvar only on this client","example":"self SetClientNumLives( level.numLives )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"numLives","description":"The numlives to set","mandatory":true}]}]},{"name":"SetClientPlayerPushAmount","description":"Sets playerPushAmount dvar only on this client","example":"self SetClientPlayerPushAmount( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"amount","description":"The push amount","mandatory":true}]}]},{"name":"SetClientPlayerSprintTime","description":"Sets player_sprintTime dvar only on this client","example":"self SetClientPlayerSprintTime( level.playerSprintTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"time","description":"The spring time","mandatory":true}]}]},{"name":"SetClientScriptMainMenu","description":"Sets g_scriptMainMenu dvar only on this client","example":"self SetClientScriptMainMenu( game[\"menu_class\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientThirdPerson","description":"Set the client to be third person","example":"self SetClientThirdPerson( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"1 to set, 0 otherwise","mandatory":true}]}]},{"name":"SetClientThirdPersonAngle","description":"Sets cg_thirdPerson dvar only on this client","example":"self SetClientThirdPersonAngle( 354 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"angle","description":"The angle to set","mandatory":true}]}]},{"name":"SetClientUIVisibilityFlag","description":"Sets a HUD visibility flag only on this client","example":"e_player SetClientUIVisibilityFlag( \"hud_visible\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flagName","description":"The name of the flag","mandatory":true},{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetControllerUIModelValue","description":"Sets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.","example":"player SetControllerUIModelValue( \"hudItems.regenDelayProgress\", 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"ui model data path from controller","description":"precached name string for the data which we're trying to set.","mandatory":true},{"name":"ui model value","description":"value for the data which we're trying to set on the controller.","mandatory":true}]}]},{"name":"SetCurrentSpectatorClient","description":"Set the given client as a spectator","example":"self SetCurrentSpectatorClient( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"client","description":"The client to set spectator","mandatory":true}]}]},{"name":"SetCurrentWeaponSpinLerp","description":"Set the current weapon's spin ","example":"self SetCurrentWeaponSpinLerp( 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"spin","description":"The spin value","mandatory":true}]}]},{"name":"SetDisabledTargetHint","description":"Set target not selected hint","example":"self SetDisabledTargetHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetElectrifiedState","description":"Sets the player into the electrified state for 3rd person anim purposes. Different from SetElectrified() which plays the postfx","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"electrified","description":": bool whether the player should be in this state.","mandatory":true}]}]},{"name":"SetEnterTime","description":"Sets the player's session enter time","example":"self setEnterTime( getTime() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"time","description":"The time to set","mandatory":true}]}]},{"name":"SetEverHadWeaponAll","description":"Set the EverHadAllPlayerHeldWeapons flag of the player","example":"self SetEverHadWeaponAll( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flag","description":"True to set the flag","mandatory":true}]}]},{"name":"SetHighlighted","description":"Highlight the player","example":"self SetHighlighted( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"True to highlight, false otherwise","mandatory":true}]}]},{"name":"SetInventoryHeldWeapon","description":"Sets the player's inventoryHeldWeapon.","example":"player SetInventoryHeldWeapon( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The held weapon to be set as inventoryHeldWeapon. Use undefined to clear the inventoryHeldWeapon.","mandatory":true}]}]},{"name":"SetInventoryWeapon","description":"Set the inventory weapon","example":"self SetInventoryWeapon( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to set","mandatory":true}]}]},{"name":"SetLowReady","description":"set the player into low ready weapon state. ","example":"self SetLowReady(true)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"enable","description":"true to set this state","mandatory":true}]}]},{"name":"SetLUIMenuData","description":"Sets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.","example":"player SetLUIMenuData( menu, \"title\", \"Some Title\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu handle","description":"handle to the lui menu opened.","mandatory":true},{"name":"lui menu data name","description":"precached name string for the data which we're trying to set.","mandatory":true},{"name":"lui menu data value","description":"value for the data which we're trying to set on the menu.","mandatory":true}]}]},{"name":"SetModelLodBias","description":"Sets the model lod bias","example":"player SetModelLodBias( 8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bias","description":"bias. Setting of 0 reverts to the model lod bias.","mandatory":true}]}]},{"name":"SetNoLOSOnTargetsHint","description":"Set target not selected hint","example":"self SetNoLOSOnTargetsHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetNoTargetsHint","description":"Set target not selected hint","example":"self SetNoTargetsHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"setOffhandPrimaryClass","description":"Set whether the player is using a grenade or gear.","example":"player setOffhandPrimaryClass( \"claymore_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"name","description":"the weapon name","mandatory":true}]}]},{"name":"SetOffhandSecondaryClass","description":"Set whether the player is using a flash or smoke grenade.","example":"player SetOffhandSecondaryClass( \"concussion_grenade_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"name","description":"the weapon name","mandatory":true}]}]},{"name":"SetOffhandVisible","description":"Enable or disable visibility of the offhand weapon","example":"self SetOffhandVisible( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"True/1 to enable, false otherwise","mandatory":true}]}]},{"name":"SetOrigin","description":"Set the player's origin","example":"player SetOrigin( v_origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"The origin to set","mandatory":true}]}]},{"name":"SetParagonIconId","description":"Sets the player's paragon icon id","example":"player SetParagonIconId( 1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"paragon icon id","description":"the paragon rank id","mandatory":true}]}]},{"name":"SetParagonRank","description":"Sets the player's paragon rank","example":"player SetParagonRank( 1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"paragon rank id","description":"the paragon rank id","mandatory":true}]}]},{"name":"SetPerk","description":"give the specified perk","example":"player SetPerk( \"specialty_gpsjammer\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"perk name","description":"the perk to give","mandatory":true}]}]},{"name":"SetPlacementHint","description":"Sets the placement hint string that will be displayed for this player.","example":"player SetPlacementHint( turret.canBePlaced )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"true if the hint should say that the weapon can be placed, false if not","mandatory":true}]}]},{"name":"SetPlayerAngles","description":"Set the player's view angles","example":"player SetPlayerAngles( v_angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"angles","description":"The view angles to set","mandatory":true}]}]},{"name":"SetPlayerRenderOptions","description":"Sets the player render options","example":"self SetPlayerRenderOptions( playerRenderOptions );\t","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"options","description":"The player render options","mandatory":true}]}]},{"name":"SetRank","description":"Sets the player's rank and prestige level","example":"player SetRank( 1, 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"rank id","description":"the rank id","mandatory":true},{"name":"prestige level","description":"The prestige level","mandatory":false}]}]},{"name":"SetRiotshieldFailHint","description":"Set riot shield fail hint","example":"self SetRiotshieldFailHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetSpawnWeapon","description":"Set the weapon that this player will spawn with","example":"self SetSpawnWeapon( \"ak47\" )during prematch period or grace period in mp)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon name","description":"The name of the weapon to spawn with","mandatory":true}]}]},{"name":"SetSpreadOverride","description":"Set the player's aim spread ","example":"self SetSpreadOverride( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetSprintCooldown","description":"Set the player's sprint cooldown duration","example":"self SetSprintCooldown( 4 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"The duration to set","mandatory":true}]}]},{"name":"SetSprintDuration","description":"Set the player's sprint duration","example":"self SetSprintDuration( 4 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"The duration to set","mandatory":true}]}]},{"name":"SetSunShadowSplitDistance","description":"Sets the sun shadow split distance for the player","example":"player SetSunShadowSplitDistance( 200 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"distance","description":"split distance. Setting of 0 reverts to the default split distance.","mandatory":true}]}]},{"name":"SetTacticalWheel","description":"Sets whether this player will be able to use the cybercom tactical wheel or not","example":"player SetTacticalWheel( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"enabled","description":"turn on or off","mandatory":true}]}]},{"name":"SetTargetAlreadyInUseHint","description":"Set target already in use failure hint","example":"self SetTargetAlreadyInUseHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetAlreadyTargetedHint","description":"Set target already being targeted hint","example":"self SetTargetAlreadyTargetedHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetedEntityEndTime","description":"Set targeted entity end time, for use on the client side in the UI. ","example":"self SetTargetedEntityEndTime( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"endtime","description":"The end time of the targeted entity","mandatory":true}]}]},{"name":"SetTargetedMissilesRemaining","description":"Set targeted entity missiles remaining, for use on the client side in the UI. ","example":"self SetTargetedMissilesRemaining( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"missilesRemaining","description":"The amount of missiles remaining to destroy the target","mandatory":true}]}]},{"name":"SetTargetingAbortedHint","description":"Set targeting aborted hint","example":"self SetDisabledTargetHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetOORHint","description":"Set out of range failure hint","example":"self SetTargetOORHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetWrongTypeHint","description":"Set target validity failure hint","example":"self SetTargetWrongTypeHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetVehicleDamageMeter","description":"Sets the vehicle damage meter","example":"player SetRefEndTime( killstreaEndTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"damage","description":"the amount of damage normalized 0..1","mandatory":true}]}]},{"name":"SetVehicleDrivableDuration","description":"Sets the drivable duration for the players vehicle (intended for use with client side display purposes)","example":"player SetVehicleDrivableDuration( killstreakDuration )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"the drivable duration in milliseconds","mandatory":true}]}]},{"name":"SetVehicleDrivableEndTime","description":"Sets the vehicle drivable end time.","example":"player SetVehicleDrivableEndTime( killstreakEndTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"end time","description":"the drivable end time in milliseconds","mandatory":true}]}]},{"name":"SetVehicleFocusEntity","description":"Sets the focus entity for a player driven vehicle (currently only supported by helicopters). This will attempt to make the vehicle orient towards the focus target.","example":"player SetVehicleFocusEntity( focusEntity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"focus entity","description":"The entity to focus on","mandatory":true}]}]},{"name":"SetVehicleLockedOnByEnt","description":"Sets the vehicle locked on by entity","example":"player SetVehicleLockedOnByEnt( mostDangerousEnemyWithLockOn )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":"an entity that acquired a missile lock on the player's vehicle","mandatory":true}]}]},{"name":"SetVehicleWeaponWaitDuration","description":"Sets the weapon wait duration for the players vehicle (intended for use with client side display purposes)","example":"player SetVehicleWeaponWaitDuration( reloadDuration )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"the weapon reload (or recharge) duration in milliseconds","mandatory":true}]}]},{"name":"SetVehicleWeaponWaitEndTime","description":"Sets the vehicle weapon wait end time.","example":"player SetVehicleWeaponWaitEndTime( weaponReloadEndTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"end time","description":"the weapon wait end time in milliseconds","mandatory":true}]}]},{"name":"SetVelocity","description":"Set the velocity of the player","example":"self setvelocity(force)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"velocity","description":"The velocity to set","mandatory":true}]}]},{"name":"SetViewClamp","description":"Set the view clamp for the player, only works during animscripted for now. Ranges are relative to tag_camera. Left, Right, Top, Bottom","example":"player SetViewClamp( 50, 50, 30, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SetWeaponAmmoClip","description":"Set the weapon's ammo","example":"self SetWeaponAmmoClip( weapon, weapon.clipSize )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true},{"name":"ammo","description":"The ammo count","mandatory":true}]}]},{"name":"SetWeaponAmmoFuel","description":"Set the weapon ammo fuel","example":"self SetWeaponAmmoFuel( weapon, weapondata[\"fuel\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true},{"name":"fuel","description":"The ammo fuel amount","mandatory":true}]}]},{"name":"SetWeaponAmmoStock","description":"Set the weapon's ammo","example":"reviver SetWeaponAmmoStock( level.weaponReviveTool, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true},{"name":"ammo","description":"The new ammo count","mandatory":true}]}]},{"name":"SetWeaponFriendlyHacking","description":"Set the weapon lockon completion percentage","example":"self SetWeaponFriendlyTargetLocked( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"isFriendlyHacking","description":"Set to true if a friendly is hacking the target","mandatory":true}]}]},{"name":"SetWeaponFriendlyTargeting","description":"Set the weapon lockon completion percentage","example":"self SetWeaponFriendlyTargeting( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"isFriendlyTargeting","description":"Set to true if a friendly is targetting","mandatory":true}]}]},{"name":"SetWeaponFriendlyTargetLocked","description":"Set the weapon lockon completion percentage","example":"self SetWeaponFriendlyTargetLocked( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"isFriendlyTargetLocked","description":"Set to true if a friendly is target locked","mandatory":true}]}]},{"name":"SetWeaponHackPercent","description":"Set the weapon hack completion percentage","example":"self SetWeaponHackPercent( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"heat","description":"The heat percent to set","mandatory":true}]}]},{"name":"SetWeaponHeatPercent","description":"Set the weapon heat percentage","example":"self SetWeaponHeatPercent( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"heat","description":"The heat percent to set","mandatory":true}]}]},{"name":"SetWeaponLockOnPercent","description":"Set the weapon lockon completion percentage","example":"self SetWeaponLockOnPercent( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"heat","description":"The heat percent to set","mandatory":true}]}]},{"name":"SetWeaponOverheating","description":"Set the players Weapon Overheating value","example":"self SetWeaponOverheating( weapondata[\"overheat\"], weapondata[\"heat\"], weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"overheat","description":"Whether the weapon is overheating.","mandatory":true},{"name":"heatval","description":"The new heatval of the weapon (0 to 100).","mandatory":true},{"name":"weapon","description":"If present set this specific weapon otherwise set the player's current weapon.","mandatory":false}]}]},{"name":"ShowViewModel","description":"Show the player's current view model.","example":"player ShowViewModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SortHeldWeapons","description":"Sort the playerState heldWeapons to remove empty spaces","example":"e_player SortHeldWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SpawnSpectator","description":"Spawns the player, does not send any notifies","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"origin to spawn","mandatory":true},{"name":"angles","description":"angles to spawn","mandatory":true}]}]},{"name":"SprintButtonPressed","description":"Check if the player is pressing the 'sprint' button.","example":"while( self SprintButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SprintUpRequired","description":"Force the player to release the sprint button before sprinting.","example":"self SprintUpRequired()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StanceButtonPressed","description":"Check if the player is pressing the 'stance' button.","example":"while( self StanceButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StartCameraTween","description":"Start a camera tween, call this right before a camera pop to do a blend.","example":"player StartCameraTween( 0.5 );","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"time","description":"How long to do the blend.\"","mandatory":true}]}]},{"name":"StartRevive","description":"Starts the revive sequence on a player. is the one administering aid to the player this is called on.","example":"playerInLastStand StartRevive( rescuer )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"reviver","description":"the player reviving the player this is called on","mandatory":true}]}]},{"name":"StopCarryTurret","description":"UnLinks the auto turret from the player and sets it on the ground.","example":"player StopCarryTurret( turret, origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"turret entity","mandatory":true},{"name":"origin","description":"The new origin of turret","mandatory":false},{"name":"angles","description":"The new angles of turret","mandatory":false}]}]},{"name":"StopLocalSound","description":"Stops the local sound","example":"targetent StopLocalSound( level.missileDroneSoundStart )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"sound name","description":"The name of the sound","mandatory":true}]}]},{"name":"StopRevive","description":"Stops the revive behavior on a player when the revive did not complete. is the one administering aid to the player this is called on.","example":"playerInLastStand StopRevive( rescuer )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"reviver","description":"the player reviving the player this is called on","mandatory":true}]}]},{"name":"Suicide","description":"Kills the player immediately as a suicide","example":"self suicide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SwitchToOffHand","description":"Switch to the offhand weapon","example":"self SwitchToOffhand( primaryOffhand )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"Weapon to switch to","mandatory":true}]}]},{"name":"SwitchToWeapon","description":"Switch to a different weapon or cycle weapons if no weapon is given","example":"level.player SwitchToWeapon( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon object","description":"The weapon to switch to","mandatory":false}]}]},{"name":"SwitchToWeaponImmediate","description":"Switch to a different weapon or cycle weapons if no weapon is given without playing the dropping animation for current weapon","example":"level.player SwitchToWeaponImmediate( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon object","description":"The weapon to switch to","mandatory":false}]}]},{"name":"TakeAllWeapons","description":"Makes the player take all weapons","example":"player TakeAllWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"TakeWeapon","description":"Take the weapon","example":"e_player TakeWeapon( w_spike_launcher )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to take","mandatory":true},{"name":"ignore_attachments","description":"Only check the root weapon, ignore all the attachments.","mandatory":false}]}]},{"name":"ThrowButtonPressed","description":"Check if the player is pressing the 'throw' button.","example":"while( self ThrowButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"TurnedHuman","description":"Called when client is turned back to human","example":"self TurnedHuman()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"UndoLastStand","description":"Undo the last stand for the client","example":"self UndoLastStand()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"UnlinkFromMissile","description":"Unlinks a player camera from a missile","example":"player UnlinkFromMissile()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"UnlinkGuidedMissileCamera","description":"clear player eflags for the guided missile","example":"player UnlinkGuidedMissileCamera()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"UnSetPerk","description":"takes the specified perk from the player","example":"player UnSetPerk( \"specialty_gpsjammer\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"perk name","description":"the perk to unset","mandatory":true}]}]},{"name":"UpdateWeaponOptions","description":"Update weapon options for a weapon that the player has","example":"player UpdateWeaponOptions( \"m1garand\", player calcWeaponOptions() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon name","description":"The weapon name to give to the player","mandatory":true},{"name":"weapon options","description":"options value computed using calcweaponoptions call","mandatory":false}]}]},{"name":"UseButtonPressed","description":"Check if the player is pressing the use button","example":"if ( self UseButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"VehicleMoveUpButtonPressed","description":"Check if the player is pressing the 'stance' button.","example":"while( self StanceButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponLockCount","description":"returns the number of active lock objects (i.e. those with at least lock started or lock set active)","example":"player WeaponLockCount()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponLockDetect","description":"Sets the tartget as detected. Will clear any existing hard lock. Use WeaponLockStart() to start lock.","example":"player WeaponLockDetect( enemyGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":": An entity.","mandatory":true},{"name":"slot","description":": The slot to operate on (up to MAX_SIMULTANEOUS_LOCKONS)","mandatory":false}]}]},{"name":"WeaponLockFinalize","description":"Locks player's weapon onto an entity. Implies WeaponLockStart(), so this may be called to jump to a hard lock.","example":"player WeaponLockFinalize( enemyGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":": An entity.","mandatory":true},{"name":"slot","description":": The slot to operate on (up to MAX_SIMULTANEOUS_LOCKONS)","mandatory":false}]}]},{"name":"WeaponLockFree","description":"Clears player's weapon lock.","example":"player WeaponLockClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slot","description":"The weapon slot. Default is 0","mandatory":false}]}]},{"name":"WeaponLockNoClearance","description":"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":"player WeaponLockNoClearance( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true},{"name":"slot","description":"The weapon slot. Default is 0","mandatory":false}]}]},{"name":"WeaponLockRemoveSlot","description":"removes the given slot values and compresses the remaining slots (i.e. 1,2,3 with 2 removed becomes 1,3,blank)","example":"player WeaponLockGetFlags()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slot","description":"The weapon slot. Default is 0","mandatory":true}]}]},{"name":"WeaponLockStart","description":"Begins player's weapon lockon sequence (hud effects, etc). Will clear any existing hard lock. Use WeaponLockFinalize() to complete lock.","example":"player WeaponLockStart( enemyGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":": An entity.","mandatory":true},{"name":"slot","description":": The slot to operate on (up to MAX_SIMULTANEOUS_LOCKONS)","mandatory":false}]}]},{"name":"WeaponLockTargetTooClose","description":"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":"player WeaponLockTargetTooClose( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true},{"name":"slot","description":"The weapon slot. Default is 0","mandatory":false}]}]},{"name":"WeaponPlayEjectBrass","description":"Play the eject brass FX for a weapon.","example":"player WeaponPlayEjectBrass()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponSwitchButtonPressed","description":"Check if the player is pressing the weapon switch button","example":"if ( self WeaponSwitchButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ChangeFontScaleOverTime","description":"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 after calling ChangeFontScaleOverTime, then the hud element will transition to the new fontScale over the remaining .","example":"level.introstring1 ChangeFontScaleOverTime( 1.2 ); level.introstring1.fontScale = 0.3; // This will transition the fontScale from whatever it was before to the new value of 0.3 over 1.2 seconds.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to scale the element font in seconds","mandatory":true}]}]},{"name":"ClearTargetEnt","description":"Clear this waypoint from targetting an entity.","example":"waypoint ClearTargetEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"Destroy","description":"Remove this Hud element altogether.","example":"self.bombstopwatch Destroy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"FadeOverTime","description":"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 after calling fadeOverTime, then the hud element will transition to the new color over the remaining .","example":"level.introstring1 FadeOverTime( 1.2 ); level.introstring1.alpha = 0.3; // This will transition the alpha from whatever it was before to the new value of 0.3 over 1.2 seconds.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to fade the element in seconds","mandatory":true}]}]},{"name":"GetTextWidth","description":"Returned the width of the text in the hudelem.","example":"width = elem GetTextWidth()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"MoveOverTime","description":"Set a hud element to move over time.","example":"newStr MoveOverTime( timer )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to move the element in seconds","mandatory":true}]}]},{"name":"NewClientHudElem","description":"Create a new hud element for a particular client","example":"self.kc_topbar = NewClientHudElem(self)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"The client for whom the hud element is created.","mandatory":true}]}]},{"name":"NewDamageIndicatorHudElem","description":"Create a new hud element for a particular client","example":"self.kc_topbar = NewClientHudElem(self)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"The client for whom the hud element is created.","mandatory":true}]}]},{"name":"NewDebugHudElem","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"NewHudElem","description":"Create a new hud element","example":"overlay = NewHudElem()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"NewScoreHudElem","description":"Create a new score hud element for a particular client","example":"self.hud_rankscroreupdate = NewScoreHudElem(self)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"The client for whom the hud element is created.","mandatory":true}]}]},{"name":"NewTeamHudElem","description":"Create a new hud element for a particular team","example":"level.progressbar_allies_neutralize = NewTeamHudElem( \"axis\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The team for whom the hud element is created. Must be 'axis', 'allies' or 'spectator'","mandatory":true}]}]},{"name":"Reset","description":"Reset a HUD element to its default state.","example":"element Reset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"ScaleOverTime","description":"Set a hud element to scale over time.","example":"other.progressbar ScaleOverTime( level.planttime, level.barsize, 8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to scale the element in seconds","mandatory":true},{"name":"width","description":"The new width of the material.","mandatory":true},{"name":"height","description":"The new height of the material.","mandatory":true}]}]},{"name":"SetClock","description":"Set a clock HUD element to count down over a time period.","example":"level.bombstopwatch SetClock( 5, 60, \"hudStopwatch\", 64, 64 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_clock_element","description":null},"parameters":[{"name":"time","description":"The new timer time in seconds to count down","mandatory":true},{"name":"time","description":"The time in seconds represented by a full cycle of the hand, for instance a stopwatch would be 60s.","mandatory":true},{"name":"material","description":"The material for the hud clock","mandatory":true},{"name":"width","description":"The width of the material.","mandatory":false},{"name":"height","description":"The height of the material.","mandatory":false}]}]},{"name":"SetClockUp","description":"Set a clock HUD element to count up over a time period.","example":"level.bombstopwatch SetClockUp( 5, 60, \"hudStopwatch\", 64, 64 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_clock_element","description":null},"parameters":[{"name":"time","description":"The new timer time in seconds to count up","mandatory":true},{"name":"full time","description":"The time in seconds represented by a full cycle of the hand, for instance a stopwatch would be 60s.","mandatory":true},{"name":"material","description":"The material for the hud clock","mandatory":true},{"name":"width","description":"The width of the material.","mandatory":false},{"name":"height","description":"The height of the material.","mandatory":false}]}]},{"name":"SetCOD7DecodeFX","description":"Set the hudelem string to display with a decode effect.","example":"elem SetCOD7DecodeFX( 2000, 600 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"decodeTime","description":"Time for each letter to decode.","mandatory":true},{"name":"decayStart","description":"Time to wait before starting the text decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetGameTypeString","description":"Set the game type string for the game","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"game type","description":"A string containing the game type","mandatory":true}]}]},{"name":"SetMapNameString","description":"Set the map name string","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"map name","description":"A string containing the map name","mandatory":true}]}]},{"name":"SetPerks","description":"Sets a hud element to be a perks element.","example":"hudelement SetPerks( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"client","description":"client we should be showing the perks of","mandatory":true}]}]},{"name":"SetPlayerNameString","description":"Set the player name string for a HUD element","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"player","description":"A player entity","mandatory":true}]}]},{"name":"SetPulseFX","description":"Set the hudelem string to display with a \"Pulse\" effect.","example":"elem SetPulseFX( 40, 2000, 600 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"speed","description":"Time (in milliseconds) each letter takes to type out.","mandatory":true},{"name":"decayStart","description":"Time to wait before starting the string's decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetRedactFX","description":"Set the hudelem string to display with a redact effect.","example":"elem SetRedactFX( 2000, 600, 3000, 400 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"decayStart","description":"Time to wait before starting the text decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true},{"name":"redactDecayStart","description":"Time to wait before starting the redact decay effect.","mandatory":true},{"name":"redactDecayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetShader","description":"Set the material for this Hud Element","example":"waypoint SetShader( \"playbook_objective_stop\", 15, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"materialname","description":"A the name of the material to set","mandatory":true},{"name":"width","description":"The width of the material.","mandatory":false},{"name":"height","description":"The height of the material.","mandatory":false}]}]},{"name":"SetTargetEnt","description":"Set the entity that this waypoint should target. In MP, entity should already be a broadcasting entity, as with Objective_OnEntity().","example":"waypoint SetTargetEnt( level.axis.bombcarrier )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"entity","description":"Entity to Target","mandatory":true}]}]},{"name":"SetTenthsTimer","description":"Set a timer HUD element to count down in tenths of a second","example":"self.kc_timer SetTenthsTimer( self.archivetime - delay )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetTenthsTimerUp","description":"Set a timer HUD element to count up in tenths of a second","example":"self.kc_timer SetTenthsTimerUp( self.archivetime - delay )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetText","description":"Set HUD text for this element.","example":"level.introstring1 SetText(string1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"text","description":"A localized text reference","mandatory":true}]}]},{"name":"SetTimer","description":"Set a timer HUD element to count down","example":"level.reinforcement_hud SetTimer( level.counter )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetTimerUp","description":"Set a timer HUD element to count up","example":"level.reinforcement_hud SetTimerUp( level.counter )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetTypewriterFX","description":"Set the hudelem string to display with a redact effect.","example":"elem SetTypewriterFX( 100, 600, 3000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"letterTime","description":"Time it take for each letter to type in.","mandatory":true},{"name":"decayStart","description":"Time to wait before starting the text decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetValue","description":"Set a value HUD element to a given value.","example":"level.reinforcement_hud SetValue( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_value_element","description":null},"parameters":[{"name":"value","description":"The value to set the element to","mandatory":true}]}]},{"name":"SetWarGameData","description":"Creates a WAR specific HUD progress element","example":"hudelement SetWarGameData( 0, 1, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"momentumProgress","description":", , ","mandatory":true}]}]},{"name":"SetWayPoint","description":"Sets a hud element to be a waypoint.","example":"newdeathicon SetWayPoint( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"constantSize","description":"boolean describing whether the hud element remains the same size","mandatory":true},{"name":"offscreenMaterialName","description":"Material to draw when waypoint is offscreen.","mandatory":false},{"name":"isDistanceShown","description":"boolean turning on/off player distance to waypoint display above the waypoint.","mandatory":false},{"name":"no offscreen","description":"boolean turning on/off arrow indicators when element is offscreen.","mandatory":false}]}]},{"name":"array","description":"create an array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"args","description":"one or more args to add to the array","mandatory":true}]}]},{"name":"ArrayCombine","description":"combine two arrays into and returns one new array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array1","description":"array to operate on","mandatory":true},{"name":"array2","description":"array to operate on","mandatory":true},{"name":"allowdupes","description":"if true then allow duplicate entries, otherwise prune them out when combining","mandatory":true},{"name":"preserve_keys","description":"if true then preserve the keys (only for string keys) otherwise renumber when combining","mandatory":true}]}]},{"name":"ArrayCopy","description":"returns a copy of an array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array1","description":"array to operate on","mandatory":true}]}]},{"name":"ArrayGetClosest","description":"Returns the entity/vector that is closest to the from the .","example":"ent = ArrayGetClosest( player.origin, a_enemies )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The origin to get closest from","mandatory":true},{"name":"array","description":"The array to search in","mandatory":true},{"name":"dist","description":"The minimum distance to check when finding closest (has to be positive)","mandatory":false}]}]},{"name":"ArrayGetFarthest","description":"Returns the entity/vector that is farthest to the from the .","example":"ent = ArrayGetFarthest( player.origin, a_enemies )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The origin to get farthest from","mandatory":true},{"name":"array","description":"The array to search in","mandatory":true},{"name":"dist","description":"The maximum distance when finding farthest (has to be positive)","mandatory":false}]}]},{"name":"ArrayInsert","description":"insert a value into an array at a given index","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to operate on","mandatory":true},{"name":"value","description":"value to insert","mandatory":true},{"name":"index","description":"index at which to insert the value (must be an integer) - moves existing entries as required","mandatory":true}]}]},{"name":"ArrayIntersect","description":"Returns an array of values that are present in both arrays.","example":"newArray = ArrayIntersect( array1, array2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array1","description":"An Array","mandatory":true},{"name":"array2","description":"An Array","mandatory":true},{"name":"matchKeys","description":"Optionally returns an array of matching key/value pairs from the two input arrays (preserving the keys).","mandatory":false}]}]},{"name":"ArrayRemoveIndex","description":"Remove a value from an array at a given index","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to operate on","mandatory":true},{"name":"index","description":"index of value to remove","mandatory":true},{"name":"preserve_keys","description":"defaults to false, if true then it preserves the keys - otherwise creates integer keys","mandatory":false}]}]},{"name":"ArrayRemoveValue","description":"Remove a value from an array (may affect multiple indexes)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to operate on","mandatory":true},{"name":"value","description":"value to remove (may be undefined)","mandatory":true},{"name":"preserve_keys","description":"defaults to false, if true then it preserves the keys - otherwise creates integer keys","mandatory":false}]}]},{"name":"Assert","description":"Assert that the given statement is correct. The function will throw a script error if this is false.","example":"Assert( enemyInSight == true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"statement that is asserted to be correct","mandatory":true},{"name":"desc","description":"string describing the nature of the assert","mandatory":false}]}]},{"name":"AssertMsg","description":"Throws a script error with the given message.","example":"AssertMsg( \"Unhandled enemy type.\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"message","description":"error message","mandatory":true}]}]},{"name":"associativeArray","description":"creates an associativeArray","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"key_i","description":"the string key for the next value","mandatory":false},{"name":"value_i","description":"the value for the previous key","mandatory":false}]}]},{"name":"ErrorMsg","description":"Throws a non-fatal script error with the given message.","example":"ErrorMsg( \"Unhandled enemy type.\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"message","description":"error message","mandatory":true}]}]},{"name":"GetArrayKeys","description":"Returns an array consisting of the keys of the input array.","example":"result = GetArrayKeys( array )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true}]}]},{"name":"GetAttachmentTableIndex","description":"Returns the attachment table index for the attachment name","example":"attachmentIndex = GetAttachmentTableIndex( \"reflex\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"attachmentRef","description":"Attachment Reference","mandatory":true}]}]},{"name":"GetDvarFloat","description":"Gets the value of a dvar.","example":"GetDvarFloat( \"r_eyesAdjust\", 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be an float.","mandatory":false}]}]},{"name":"GetDvarInt","description":"Gets the value of a dvar.","example":"GetDvarInt( \"r_eyesAdjust\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be an integer.","mandatory":false}]}]},{"name":"GetDvarString","description":"Gets the value of a dvar.","example":"GetDvarString( \"r_eyesAdjust\", \"yes\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be a string.","mandatory":false}]}]},{"name":"GetDvarVector","description":"Gets the value of a dvar.","example":"GetDvarVector( \"r_eyesAdjust\", (1,0,0) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be an vector.","mandatory":false}]}]},{"name":"GetFirstArrayKey","description":"Returns the first key of the input array.","example":"key = GetFirstArrayKey( array )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true}]}]},{"name":"GetItemIndexFromRef","description":"Returns the item index for the specified item reference","example":"itemIndex = GetItemIndexFromRef( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemRef","description":"Item Reference","mandatory":true}]}]},{"name":"GetLastArrayKey","description":"Returns the last key of the input array.","example":"key = GetLastArrayKey( array )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true}]}]},{"name":"GetNextArrayKey","description":"Returns the next key of the input array, after the specified key.","example":"key = GetNextArrayKey( array, key )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true},{"name":"key","description":"The given key","mandatory":true}]}]},{"name":"GetPrevArrayKey","description":"Returns the prev key of the input array, before the specified key.","example":"key = GetPrevArrayKey( array, key )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true},{"name":"key","description":"The given key","mandatory":true}]}]},{"name":"GetSubStr","description":"Returns the substring of characters >= and < . is optional.","example":"name = getSubStr( playerwarp_string, 8 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The input string","mandatory":true},{"name":"start index","description":"The start index of the substring","mandatory":true},{"name":"end index","description":"The end index of the substring","mandatory":false}]}]},{"name":"IsArray","description":"Checks whether this entity/variable is an array","example":"if ( isarray ( gun_owner )) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a array","mandatory":true}]}]},{"name":"IsClass","description":"Checks whether this entity/variable is a class object","example":"if ( isclass(self)) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a class","mandatory":true}]}]},{"name":"IsFloat","description":"Checks whether this entity/variable is a float","example":"if ( IsFloat( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a float","mandatory":true}]}]},{"name":"IsFunctionPtr","description":"Checks whether given variable is of type Function Pointer in script, useful to differentiate between Var and FuncPtr in Script.","example":"if ( IsFunctionPtr( myFuncPtr ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable to test","mandatory":true}]}]},{"name":"IsInArray","description":"searches an array to determine if a given value is present in that array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to search","mandatory":true},{"name":"value","description":"value to search for","mandatory":true}]}]},{"name":"IsInt","description":"Checks whether this entity/variable is an int","example":"if ( IsInt( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be an int","mandatory":true}]}]},{"name":"IsString","description":"Checks whether this entity/variable is a string","example":"if ( isstring ( gun_owner )) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a string","mandatory":true}]}]},{"name":"IsStruct","description":"Checks whether this variable is a struct object","example":"if ( isstruct(self)) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a struct","mandatory":true}]}]},{"name":"IsSubStr","description":"Returns true/false if is a substring of . Case sensitive.","example":"has_str = IsSubStr( \"my_string\", \"str\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"istring","description":"Casts a string to an istring","example":"x = istring( String )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A string to cast to an istring","mandatory":true}]}]},{"name":"IsVec","description":"Checks whether this entity/variable is a vector","example":"if ( IsVec( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a vector","mandatory":true}]}]},{"name":"IsWeapon","description":"Checks whether this is a weapon object","example":"if ( IsWeapon( current_weapon ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon_object","description":"An parameter that may be a weapon object","mandatory":true}]}]},{"name":"MakeLocalizedString","description":"Make a localized string of the given string","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The string to translate","mandatory":true}]}]},{"name":"sprintf","description":"Replaces field specifiers in a string with values passed in, returns result string format specifiers take the form of {[n]} in the source string where [n] indicates which value to print, e.g. 0 is the first user arg","example":"sprintf(\"{0} is the first string\",\"first\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The string to translate","mandatory":true},{"name":"args","description":"zero or more arguments","mandatory":false}]}]},{"name":"StrEndsWith","description":"Returns true/false if ends with . Case sensitive.","example":"ends_with = StrEndsWith( \"my_string\", \"_string\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"String to search","mandatory":true},{"name":"substring","description":"Substring to search with.","mandatory":true}]}]},{"name":"StrIsFloat","description":"Check if a string is a float.","example":"StrIsFloat( \"1.2\" ); // true","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to check.","mandatory":true}]}]},{"name":"StrIsInt","description":"Check if a string is an int.","example":"StrIsInt( \"1\" ); // true","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to check.","mandatory":true}]}]},{"name":"StrIsNumber","description":"Check if a string is a number.","example":"StrIsNumber( \"1.2\" ); // true","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to check.","mandatory":true}]}]},{"name":"StrStartsWith","description":"Returns true/false if starts with . Case sensitive.","example":"starts_with = StrStartsWith( \"my_string\", \"my_\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"String to search","mandatory":true},{"name":"substring","description":"Substring to search with.","mandatory":true}]}]},{"name":"StrStrip","description":"Strip whitespace from right and left side of string.","example":"StrStrip( \" hq_cleared \" ); // 'hq_cleared'","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to strip.","mandatory":true}]}]},{"name":"StrTok","description":"Tokenizes by the delimiters . Returns the array of string tokens.","example":"my_string_array = StrTok( \"my_string; my_string_2\", \"; \" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The input string","mandatory":true},{"name":"delim","description":"The delimiter to tokenize by","mandatory":true}]}]},{"name":"StrTok2","description":"Tokenizes by a single delimiter string. doesn't treat the delimiter string as a series of characters, but as a string","example":"my_string_array = StrTok2( \"my_string foo; my_string_2\", \"foo; \" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The input string","mandatory":true},{"name":"delim","description":"The delimiter to tokenize by","mandatory":true},{"name":"case_sensitive","description":"true if test is case sensitive","mandatory":false}]}]},{"name":"TableLookup","description":"look up a row in a table and pull out a particular column from that row","example":"TableLookup( \"mp/statstable.csv\", 0, \"INDEX_KILLS\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search column num","description":"The column number of the stats table to search through","mandatory":true},{"name":"search value","description":"The value to use when searching the ","mandatory":true},{"name":"return value column num","description":"The column number value to return after we find the correct row","mandatory":true}]}]},{"name":"TableLookupColumnCount","description":"look up the number of columns in a table","example":"TableLookup( \"mp/statstable.csv\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true}]}]},{"name":"TableLookupColumnForRow","description":"look up a particular row and column in a table","example":"TableLookupColumnForRow( \"gamedata/tables/mp/exampleStringTable.csv\", 101, 7 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search row num","description":"The row number of the string table to search through","mandatory":true},{"name":"search column num","description":"The column number of the string table to search through","mandatory":true}]}]},{"name":"TableLookupFindCoreAsset","description":"Find core asset index for a stringtable","example":"TableLookupRowNum( \"mp/statstable.csv\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true}]}]},{"name":"TableLookupIString","description":"look up a row in a table and pull out a particular column from that row","example":"TableLookupIString( \"mp/statstable.csv\", 0, \"INDEX_KILLS\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search column num","description":"The column number of the stats table to search through","mandatory":true},{"name":"search value","description":"The value to use when searching the ","mandatory":true},{"name":"return value column num","description":"The column number value to return after we find the correct row","mandatory":true}]}]},{"name":"TableLookupRow","description":"Return an array of strings for the columns in that row","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"row num","description":"The row num of the row in table to return","mandatory":true}]}]},{"name":"TableLookupRowCount","description":"look up the number of rows in a table","example":"TableLookup( \"mp/statstable.csv\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true}]}]},{"name":"TableLookupRowNum","description":"look up a row number in a table","example":"TableLookupRowNum( \"mp/statstable.csv\", 0, \"INDEX_KILLS\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search column num","description":"The column number of the stats table to search through","mandatory":true},{"name":"search value","description":"The value to use when searching the ","mandatory":true}]}]},{"name":"Throw","description":"force a script exception (from a builtin call)","example":"throw( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ToLower","description":"Converts to a lower case string which is returned.","example":"my_string = ToLower( \"MY_STRING\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"(string) Base string","mandatory":true}]}]},{"name":"ToUpper","description":"Converts to a upper case string which is returned.","example":"my_string = ToUpper( \"lower\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"(string) Base string","mandatory":true}]}]},{"name":"AttachPath","description":"Attaches this vehicle to the given path.","example":"bomber AttachPath( aBomberPaths[i] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node","description":"A node on the path to attach.","mandatory":true}]}]},{"name":"CancelAIMove","description":"Tell the vehicle to stop moving towards its current goal position.","example":"eTank CancelAIMove()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearDefaultPitch","description":"Clears the desired default pitch for a vehicle.","example":"level.heli cleardefaultpitch()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearGoalYaw","description":"Clear the goal yaw direction for this vehicle.","example":"level.flak1 ClearGoalYaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearGunnerTarget","description":"Clear the target for the vehicle turret.","example":"eTank ClearGunnerTarget(0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"Which gun, 0-3.","mandatory":false}]}]},{"name":"ClearLookAtEnt","description":"Clear the entity or origin the vehicle is orienting towards.","example":"heli clearLookAtEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearTargetYaw","description":"Clear the target yaw direction for this vehicle.","example":"level.flak1 cleartargetyaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearTurretTarget","description":"Clear the target for the vehicle turret.","example":"eTank ClearTurretTarget()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"ClearVehGoalPos","description":"Clears the target position for this vehicle.","example":"tank ClearVehGoalPos()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"CreateTrack","description":"Set the node enabled or disabled for vehicle pathfinding. SetVehGoalPos will now return true or false if it can find a path.","example":"CreateTrack( track_node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"DisableDriverFiring","description":"Enables or disables the driver's vehicle turret","example":"tank DisableDriverFiring( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"DisableGunnerFiring","description":"Enable or disable gunner firing","example":"tank DisableGunnerFiring( 1, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"The gunner to disable/enable","mandatory":true},{"name":"onoff","description":"true to disable, false otherwise","mandatory":true}]}]},{"name":"DrawTrajectory","description":"Draws the vehicles trajectory.","example":"plane DrawTrajectory( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"show","description":"Whether to draw trajectory or not","mandatory":true}]}]},{"name":"DrivePath","description":"Starts the vehicle driving this path and uses the vehicle physics, not locked to the spline, can only achieve turns that the physics can handle.","example":"huey DrivePath( start_node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node index","description":"A node on the path to attach.","mandatory":false},{"name":"allow free drive","description":"This give the player free driving but script notifies when passing nodes on a vehcile spline","mandatory":false}]}]},{"name":"FinishVehicleDamage","description":"Does damage to an vehicle - usually as part of the damage callback","example":"self FinishVehicleDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, vDir, sHitLoc, psOffsetTime, damageUnderneathVehicle, modelindex, partname, damageteammates )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Point","description":"Point of damage","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"Hit Loc","description":"The location of the hit","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true},{"name":"DamageFromUnderneath","description":"If the hit is underneath the vehicle","mandatory":true},{"name":"modelIndex","description":"which model in the dobj was hit","mandatory":true},{"name":"partIndex","description":"which bone was hit","mandatory":true},{"name":"damageteammates","description":"Whether to damage teammates or not","mandatory":true}]}]},{"name":"FinishVehicleRadiusDamage","description":"Does damage to an vehicle - usually as part of the damage callback","example":"self FinishVehicleRadiusDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, fRadius, fConeRadius, fConeDir, psOffsetTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Inner Damage","description":"Integer specifying the amount of inner damage done","mandatory":true},{"name":"Outer Damage","description":"Integer specifying the amount of outer damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Point","description":"(vector) The Point of the damage","mandatory":true},{"name":"Radius","description":"(float) The radius of the damage","mandatory":true},{"name":"ConeRadius","description":"(float) The radius of the cone damage","mandatory":true},{"name":"ConeDirection","description":"(vector) The direction of the cone damage","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true}]}]},{"name":"FireWeapon","description":"Fire the vehicle's weapon","example":"m_vehicle FireWeapon( 0, m_e_target, v_target_offset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret_index","description":"turret index, 0 being main turret, 1~4 being gunners","mandatory":false},{"name":"target ent","description":"A target entity for guided missiles","mandatory":false},{"name":"target offset","description":"Only used for projectile and bomb weapons","mandatory":false},{"name":"attacker","description":"real attacker who should take credit of this shot","mandatory":false}]}]},{"name":"Flip180","description":"Flips this vehicle 180 (for going forwards / backwards along a path)","example":"huey Flip180()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"FreeVehicle","description":"Frees this vehicle instance. It will unlink any players occupying the vehicle. It will change the vehicle into a vehicle corpse. It will send a death notify on the vehicle. Once called the vehicle cannot move anymore.","example":"self FreeVehicle()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetAllVehicleNodes","description":"Gets all of the vehicle nodes in a level","example":"nodes = GetAllVehicleNodes()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAngularVelocity","description":"Gets the current angular velocity.","example":"self GetAngularVelocity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetAttachPos","description":"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":"pos = self GetAttachPos( node )origin = pos[0]angles = pos[1]","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node index","description":"A node on the path to attach.","mandatory":true}]}]},{"name":"GetBrake","description":"Gets the brake value of a nitrous physics vehicle.","example":"jeep getbrake()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetDefaultAcceleration","description":"Gets the acceleration value set in GDT.","example":"accel = self GetDefaultAcceleration()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"getgoalspeedMPH","description":"Gets the goal speed in miles per hour.","example":"self GetGoalSpeedMPH()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetGoalYaw","description":"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":"level.flak1 GetGoalYaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetGunnerTargetEnt","description":"Gets the target entity for this gunner position.","example":"target = huey GetGunnerTurretEnt( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"Which gun, 0-3.","mandatory":true}]}]},{"name":"GetGunnerTargetVec","description":"Get the target position for this vehicle turret gunner.","example":"endpt = GetGunnerTargetVec( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"which gun 0-3","mandatory":true}]}]},{"name":"GetHandBrake","description":"Gets the hand brake value of a nitrous physics vehicle.","example":"jeep gethandbrake()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetHeliHeightLock","description":"Locks the heli to the height mesh","example":"if ( vehicle GetHeliHeightLock( ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetHeliHeightLockHeight","description":"Gets the mesh height at a given point.","example":"maxheight = GetHeliHeightLockHeight( point )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"point","description":"The point to check at","mandatory":true}]}]},{"name":"GetMaxSpeed","description":"Get the max speed of a vehicle. By default gets the script setting","example":"heli GetMaxSpeed( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"get gdt","description":"true to get the gdt setting and not the script set.","mandatory":false}]}]},{"name":"GetNumVehicles","description":"Gets the number of vehicles entities in the level","example":"vehicleCount = GetNumVehicles()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetOccupantSeat","description":"Get the seat index occupied by the given player. -1 if player isn't in vehicle.","example":"isDriver = 0 == vehicle GetOccupantSeat( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"player","description":"The player to get the seat index for","mandatory":true}]}]},{"name":"GetPathFixedOffset","description":"Gets a fixed offset from the path for a specific vehicle.","example":"offset = huey GetPathFixedOffset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetPathVariableOffset","description":"Gets a variable offset from the path for a specific vehicle.","example":"offset = huey GetPathVariableOffset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetPhysAcceleration","description":"Gets the vehicles acceleration vector.","example":"accel = plane GetPhysAccel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetScriptBrake","description":"Gets the script brake value of a nitrous physics vehicle.","example":"jeep getscriptbrake()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetSeatFiringAngles","description":"Retrieve the angles specifying the direction in which bullets, projectiles, etc. will be emitted from the weapon when it is fired.","example":"turretBarrelAngles = tank GetSeatFiringAngles( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat index","description":"The seat to firing angles for","mandatory":true}]}]},{"name":"GetSeatFiringOrigin","description":"Retrieve the location at the end of the barrel where bullets, projectiles, etc. are emitted when the gun is fired.","example":"turretBarrelOrigin = tank GetSeatFiringOrigin( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat index","description":"The seat to firing origin for","mandatory":true}]}]},{"name":"GetSeatOccupant","description":"Get the entity occupying the given seat index. Undefined if the seat is empty.","example":"driver = vehicle GetSeatOccupant( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true}]}]},{"name":"GetSpeed","description":"Gets the current speed in inches per second.","example":"self GetSpeed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetSpeedMPH","description":"Gets the current speed in miles per hour.","example":"self GetSpeedMPH()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetSteering","description":"Returns the steer factor of the vehicle.","example":"self GetSteering()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetThrottle","description":"Returns the throttle factor of the vehicle.","example":"self GetThrottle()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetTimeFromVehicleNodeToNode","description":"The time it would take to go from start node to end node if traveling the spline speed.","example":"time = GetTimeFromVehicleNodeToNode( start_node, end_node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start_node","description":"The start node of the path","mandatory":true},{"name":"end_node","description":"The end node of the path","mandatory":true}]}]},{"name":"GetTurretHeatValue","description":"Get the current heat value for a vehicle weapon.","example":"heat = self GetTurretHeatValue( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"which gun 0-3","mandatory":true}]}]},{"name":"GetTurretLimitsYaw","description":"Get the furthest relative yaw angles the turret can aim, all numbers are positive","example":"limit = veh GetTurretLimits( 1 ); limitMin = -limit[0]; limitMax = limit[1]","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"GetTurretTargetVec","description":"Get the target position for this vehicle turret or gunner.","example":"endpt = GetTurretTargetVec( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"GetVehDamageMultiplier","description":"Gets the damage multiplier that applies to the damage type.","example":"vehicle GetVehDamageMultiplier( damgType )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"damageType","description":"The type of damage being applied to the vehicle","mandatory":true}]}]},{"name":"GetVehicleAvoidance","description":"Locks the heli to the height mesh","example":"if ( vehicle GetVehicleAvoidance() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetVehicleAvoidanceNodes","description":"Get the positions for nearby avoidance nodes.","example":"nodes = plane GetVehicleAvoidanceNodes( radius )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"radius","description":"A radius to filter out nodes returned.","mandatory":true}]}]},{"name":"GetVehicleNode","description":"Gets a vehicle node with the given name, key pair","example":"node = getvehiclenode(self.target, \"targetname\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"(string) The name to search for","mandatory":true},{"name":"key","description":"(string) The key that name goes with","mandatory":true}]}]},{"name":"GetVehicleNodeArray","description":"Gets an array of vehicle nodes that have the given name, key pair","example":"nodes = GetVehicleNodeArray(self.target, \"targetname\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"(string) The name to search for","mandatory":true},{"name":"key","description":"(string) The key that name goes with","mandatory":true}]}]},{"name":"GetVehicleOwner","description":"Returns the owner of this particular vehicle.","example":"eFlak88user = eFlak88 GetVehicleOwner()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetVehOccupants","description":"Get the occupants of this vehicle in an entity array.","example":"ridersarray = vehicle getvehoccupants()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetWheelSurface","description":"Returns the surface type of the given wheel as a string.","example":"surface = self GetWheelSurface( side )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"wheel","description":"The wheel position, can be 'front_left', 'front_right', 'back_left', 'back_right', 'middle_left', 'middle_right'","mandatory":true}]}]},{"name":"IsDriverFiring","description":"Checks if this driver is firing the vehicle turret","example":"if( tank IsDriverFiring() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsGunnerFiring","description":"Checks if this gun is currently firing.","example":"if( tank IsGunnerFiring( 1 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"The gunner to check","mandatory":true}]}]},{"name":"IsInsideHeliHeightLock","description":"Returns true if Helicopter is inside height mesh","example":"if ( IsInsideHeliHeightLock() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"isremotecontrol","description":"Query whether this vehicle is usable by players","example":"if ( vehicle isvehicleusable( ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsTurretReady","description":"Query whether this vehicle's turret is ready for firing","example":"while ( level.playertank IsTurretReady() != true ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsVehicleImmuneToDamage","description":"This checks the vehicle GDT settings related to bulletdamage, grenadedamage, etc.","example":"if ( vehicle IsVehicleImmuneToDamage( flags, mod, weapon ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true}]}]},{"name":"IsVehicleManualControl","description":"check if vehicle hkai behavior is enabled. Not to be confused with UseVehicle()","example":"vehicle IsVehicleManualControl()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsVehicleSeatOccupied","description":"same as useby except you can specify a seat, 0 driver, 1-4 gunners, 5-10 passengers","example":"lvt IsVehicleSeatOccupied( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true}]}]},{"name":"IsVehicleTurretOverheating","description":"Returns true if the vehicle turret weapon is overheating, else returns false.","example":"if( self IsVehicleTurretOverheating( 1 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"which gun 0-3","mandatory":true}]}]},{"name":"IsVehicleUsable","description":"Query whether this vehicle is usable by players","example":"if ( vehicle isvehicleusable( ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"JoltBody","description":"Jolts the vehicle.","example":"self JoltBody( (self.origin + (0,0,64)), 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"jolt position","description":"The position of the jolt","mandatory":true},{"name":"intensity","description":"The intensity of the jolt","mandatory":true},{"name":"speedFrac","description":"A speed fraction to apply to the jolt. Most be betweeon 0 and 1.","mandatory":false},{"name":"deceleration","description":"The deceleration to apply to this vehicle in miles per hour per second.","mandatory":false}]}]},{"name":"MakeVehicleUnusable","description":"Sets this vehicle to be not usable by the player","example":"car MakeVehicleUnusable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"MakeVehicleUsable","description":"Sets this vehicle to be usable by the player","example":"nFlak makeVehicleUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"PathFixedOffset","description":"Sets a fixed offset for this vehicle to travel on a vehicle path.","example":"huey PathFixedOffset( (0, -200, 0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"offset","description":"The offset to apply. A vector in the form (forward, right, up)","mandatory":true}]}]},{"name":"PathFixedOffsetClear","description":"Clears the vehicles fixed offset.","example":"huey PathFixedOffsetClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"PathMove","description":"Moves the entire path for this vehicle to the specific origin and angles.","example":"huey PathMove( node, origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node index","description":"Which node to move to the new location (it moves the whole path not just this node).","mandatory":true},{"name":"new origin","description":"The new position","mandatory":true},{"name":"new angles","description":"The new angles","mandatory":true}]}]},{"name":"PathMoveClear","description":"Clears the moved path for this vehicle. If not cleared then all paths taken will be moved.","example":"huey PathMoveClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"PathVariableOffset","description":"Sets a variable offset for this vehicle to travel on a vehicle path.","example":"huey PathVariableOffset( (0, 50, 0), 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"offset","description":"The offset to apply. A vector in the form (forward, right, up)","mandatory":true},{"name":"time","description":", The interval at which to choose new offsets","mandatory":true}]}]},{"name":"PathVariableOffsetClear","description":"Clears the vehicles variable offset.","example":"huey PathVariableOffsetClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"RecalcSplinePaths","description":"Recalcs all the nodes int the map","example":"tank2 RecalcSplinePaths()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ReconnectVehicleNodes","description":"Reconnect vehicle nodes","example":"ReconnectVehicleNodes()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetVehicleFromDropDeploy","description":"Reset vehicle properties from drop deploy so that it may behave as normal.","example":"raps ResetVehicleFromDropDeploy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ResumeSpeed","description":"Sets the vehicle to resume its path speed.","example":"level.tank ResumeSpeed( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"acceleration","description":"The acceleration to apply to this vehicle in miles per hour per second.","mandatory":false}]}]},{"name":"ReturnPlayerControl","description":"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":"cobra returnplayercontrol()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"SeatGetWeapon","description":"Returns the weapon name for the specified seat. Undefined if there isn't a weapon. Only driver and gunner seats can have weapons.","example":"weaponname = vehicle SeatGetWeapon( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat index","description":"The seat to get weapon for","mandatory":true}]}]},{"name":"SetAcceleration","description":"Sets the acceleration for this vehicle.","example":"self SetAcceleration( 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"acceleration","description":"The acceleration of the vehicle in miles per hour per second","mandatory":true}]}]},{"name":"SetAirResistance","description":"Sets the speed at which air resistance maxes out.","example":"self SetAirResistance( 60 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"max air resistance speed","description":"speed at which air resistance maxes out (MPH)","mandatory":true}]}]},{"name":"SetAngularVelocity","description":"Sets the angular velocity of a vehicle in degs/s.","example":"self SetAngularVelocity( (0, 90, 0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"angular velocity","description":"The angular velocity to set","mandatory":true}]}]},{"name":"SetBrake","description":"Turns off/on the hand brake of a nitrous physics vehicle.","example":"jeep setbrake(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"bool","description":"True or 1 to turn on the brake, false or 0 otherwise","mandatory":true}]}]},{"name":"SetBuoyancyOffset","description":"set buoyancy offset that changes the height an individual vehicle floats in water","example":"crocodile SetBuoyancyOffset( 20 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"offset","description":"A height offset from water surface.","mandatory":true}]}]},{"name":"SetDamageStage","description":"Set the damage stage of the helicopter","example":"self setdamagestage( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"stage","description":"the damage stage to set","mandatory":true}]}]},{"name":"SetDeceleration","description":"Sets the deceleration for this vehicle.","example":"self SetDeceleration( 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"deceleration","description":"The deceleration of the vehicle in miles per hour per second","mandatory":true}]}]},{"name":"SetDefaultPitch","description":"Set the desired default pitch for a vehicle.","example":"level.heli setdefaultpitch(10)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"pitch","description":"Set the default pitch","mandatory":true}]}]},{"name":"SetDrivePathPhysicsScale","description":"This scales all of the necessary parameters that will help a vehicle drive a path better.","example":"boat SetDrivePathPhysicsScale( 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"scale","description":"The scale to set","mandatory":false}]}]},{"name":"SetGoalYaw","description":"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":"level.flak1 SetGoalYaw( int_value )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"integer","description":"The yaw direction of the target: 0 to 360 integer value","mandatory":true}]}]},{"name":"SetGunnerTargetEnt","description":"Set the target entity for this vehicle gunner.","example":"eLiberator SetGunnerTargetEnt( eFlaktarget, (0,0,0), 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target entity","description":"The target.","mandatory":true},{"name":"target offset","description":"The target offset.","mandatory":false},{"name":"gunner index","description":"Which gun, 0-3.","mandatory":false}]}]},{"name":"SetGunnerTargetVec","description":"Set the target position for this vehicle turret gunner.","example":"level.flak1 SetGunnerTargetVec( vec1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target position","description":"vecter to aim at/ the position of the target","mandatory":true},{"name":"gunner index","description":"which gun 0-3","mandatory":false}]}]},{"name":"SetGunnerTurretOnTargetRange","description":"Set the range at which the gunner_turret_on_target notify will occur.","example":"boat SetGunnerTurretOnTargetRange( 0, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"Which gun, 0-3.","mandatory":true},{"name":"range","description":"In degrees","mandatory":false}]}]},{"name":"SetHeliDogfighting","description":"Sets the vehicle (intended for VTOLs only) to be in dogfighting mode (dogfights with the vehicle's focus entity)","example":"vehicle SetHeliDogfighting( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"true to enable dogfighting, false otherwise","mandatory":true}]}]},{"name":"SetHeliHeightCap","description":"Pulls the heli back down below the height mesh","example":"vehicle SetHeliHeightCap( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"true to enable, false otherwise","mandatory":true}]}]},{"name":"SetHeliHeightLock","description":"Locks the heli to the height mesh","example":"vehicle SetHeliHeightLock( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"true to enable lock, false otherwise","mandatory":true}]}]},{"name":"SetHeliHeightPatchEnabled","description":"Enabled or disables the specified heli height lock path","example":"SetHeliHeightPatchEnabled( \"area51\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"All heli height lock patches with this target name","mandatory":true},{"name":"enabled","description":"Turn it on or off","mandatory":true},{"name":"player","description":"If defined, only modify the setting for that player","mandatory":false}]}]},{"name":"SetHoverParams","description":"Set the hovering parameters.","example":"self SetHoverParams( 50, 1, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"radius","description":"The hovering range.","mandatory":true},{"name":"speed","description":"Speed to hover at (MPH)","mandatory":false},{"name":"accel","description":"Acceleration to hover at (MPH/s)","mandatory":false}]}]},{"name":"SetJitterParams","description":"Set the jitter parameters. Set everything to 0 to stop jittering. Vehicle ignores jitter parameters when on ground","example":"self SetJitterParams( (0,0,20), 0.5, 1.5 ); // Jitter up or down randomly within 20 units, switching every 0.5 to 1.5 seconds","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"range vector","description":"The jitter range vector.","mandatory":true},{"name":"min period","description":"Minimum time in seconds to switch jitter direction. Default 0.5 sec","mandatory":false},{"name":"max period","description":"Maximum time in seconds to switch jitter direction. Default 1.0 sec","mandatory":false}]}]},{"name":"SetLookAtEnt","description":"Set the entity this vehicle will orient towards.","example":"eFlak88 setLookAtEnt( eFlaktarget )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"entity","description":"The target.","mandatory":true}]}]},{"name":"SetLookAtOrigin","description":"Set the origin this vehicle will orient towards.","example":"heli setLookAtOrigin( org )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"entity","description":"The target.","mandatory":true}]}]},{"name":"SetMantleEnabled","description":"Sets the mantle enabled flag on the vehicle","example":"vehicle SetMantleEnabled( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"True to set the mantle enabled, false otherwise","mandatory":true}]}]},{"name":"SetMaxAccelerationScale","description":"Sets the max acceleration scale for this physics vehicle.","example":"self SetMaxAccelerationScale( 2.6 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"scale","description":"The acceleration scale of the physics vehicle","mandatory":true}]}]},{"name":"SetMaxPitchRoll","description":"Sets max pitch and roll angle for this vehicle.","example":"self SetMaxPitchRoll( 30, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"pitch","description":"Max pitch angle","mandatory":true},{"name":"roll","description":"Max roll angle","mandatory":true}]}]},{"name":"SetMaxSpeedScale","description":"Sets the max speed scale for this physics vehicle.","example":"self SetMaxSpeedScale( 2.6 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"scale","description":"The max speed scale of the physics vehicle","mandatory":true}]}]},{"name":"SetMinDesiredTurnYaw","description":"The vehicle will not update its desired yaw until the min turn yaw is reached. Set it to 0 to clear it.","example":"quadtank SetMinDesiredTurnYaw( 45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"yaw","description":"The min desired turn yaw to set","mandatory":true}]}]},{"name":"SetNearGoalNotifyDist","description":"Set distance near goal at which near_goal notification should be sent once.","example":"tank setNearGoalNotifyDist( 50 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"dist","description":"Distance to goal position","mandatory":true}]}]},{"name":"SetPathTransitionTime","description":"Set the time it takes for a vehicle to lerp on to a spline.","example":"boat SetPathTransitionTime( 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"time","description":"The transition time","mandatory":true}]}]},{"name":"SetPhysAcceleration","description":"Sets the vehicles acceleration vector.","example":"plane SetPhysAcceleration( ( 0, 0, -1600) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"acceleration","description":"The vehicle acceleration","mandatory":true}]}]},{"name":"SetPhysAngles","description":"Sets the angles on the phys structure","example":"self SetPhysAngles( VectorToAngles( desired_forward ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"angles vector","description":"The desired angles.","mandatory":true}]}]},{"name":"SetPlaneBarrelRoll","description":"Set the goal Roll direction for this plane. PLANE_ON_CURVE has priority over ROLL if this is not set.","example":"level.plane SetPlaneBarrelRoll( 1, 5.0f )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"plane","description":null},"parameters":[{"name":"number","description":"The number of rolls","mandatory":true},{"name":"time","description":"The goal roll time","mandatory":false}]}]},{"name":"SetPlaneGoalPos","description":"Set the target position, speed, angles for this vehicle.","example":"plane Setplanegoalpos( ( 200, 200, 200 ), ( 30, 0, 90 ), 170.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"plane","description":null},"parameters":[{"name":"goal position","description":"The goal position","mandatory":true}]}]},{"name":"SetRotorSpeed","description":"Sets the helicopters rotor speed.","example":"heli SetRotorSpeed( 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The rotor speed, 0 is stopped 1 is full speed.","mandatory":true}]}]},{"name":"SetSeatOccupied","description":"Sets this seat to be occupied/disabled (for players.","example":"vehicle SetSeatOccupied( 2, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true},{"name":"onoff","description":"true to enable, false otherwise","mandatory":false}]}]},{"name":"SetSpeed","description":"Sets the speed and acceleration for this vehicle.","example":"self SetSpeed( 60, 15, 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed of the vehicle in miles per hour","mandatory":true},{"name":"acceleration","description":"The acceleration of the vehicle in miles per hour per second","mandatory":false},{"name":"deceleration","description":"Deceleration. If not specified, set to be equal to half of accleration","mandatory":false}]}]},{"name":"SetSpeedImmediate","description":"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":"self setspeedimmediate(60, 15, 5)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed of the vehicle in miles per hour","mandatory":true},{"name":"acceleration","description":"The acceleration of the vehicle in miles per hour per second","mandatory":false},{"name":"deceleration","description":"Deceleration. If not specified, set to be equal to half of accleration","mandatory":false}]}]},{"name":"SetSwitchNode","description":"Sets a switch node for this vehicle.","example":"tank2 SetSwitchNode( tank2snode1, tank2snode2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"source node","description":"The switch source node","mandatory":true},{"name":"dest node","description":"The switch destination node.","mandatory":true}]}]},{"name":"SetTargetYaw","description":"Set the target yaw direction for this vehicle. Goal yaw has priority over target yaw.","example":"level.flak1 SetTargetYaw( vec1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"yaw","description":"The yaw direction of the target","mandatory":true}]}]},{"name":"SetTurningAbility","description":"If this is higher, helicopters can make sharper turns to match goal positions better.","example":"self SetTurningAbility( 0.9 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turning ability","description":"Between 0.001 and 1.0. Defaults to 0.5","mandatory":true}]}]},{"name":"SetTurretTargetEnt","description":"Set the target entity for this vehicle turret.","example":"eFlak88 SetTurretTargetEnt( eFlaktarget, eFlaktarget.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target entity","description":"The target.","mandatory":true},{"name":"target offset","description":"The target offset.","mandatory":false}]}]},{"name":"SetTurretTargetRelativeAngles","description":"Set the target entity for this vehicle turret.","example":"eFlak88 SetTurretTargetEnt( eFlaktarget, eFlaktarget.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"relative angles","description":"The target angle","mandatory":true},{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"SetTurretTargetVec","description":"Set the target position for this vehicle turret.","example":"level.flak1 SetTurretTargetVec( vec1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target position","description":"The position of the target","mandatory":true}]}]},{"name":"SetVehGoalPos","description":"Set the target position for this vehicle. Returns true if it can find a path. If it fails to find a path the vehicle will be stopped.","example":"tank SetVehGoalPos( (0, 0, 0), 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"goalpos","description":"The goal position","mandatory":true},{"name":"stopAtGoal","description":"Whether the vehicle should slow down to stop at the goal position","mandatory":false},{"name":"usepath","description":"set to 1 to use pathfinding","mandatory":false}]}]},{"name":"SetVehicleAvoidance","description":"Turns on and off vehicle avoidance","example":"vehicle SetVehicleAvoidance( true, 50 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"True to enable avoidance, false otherwise","mandatory":true},{"name":"radius","description":"The avoidance radius","mandatory":false},{"name":"priority","description":"Vehicles will avoid everything that is the same priority or higher. Default priority is 1.","mandatory":false}]}]},{"name":"SetVehicleForDropDeploy","description":"Set vehicle properties so that it can be dropped into a map.","example":"raps SetVehicleForDropDeploy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"SetVehicleManualControl","description":"Turns on and off vehicle hkai behavior. Not to be confused with UseVehicle()","example":"vehicle SetVehicleManualControl( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"True to enable vehicle hkai behavior, false otherwise","mandatory":true}]}]},{"name":"SetVehicleType","description":"Sets the vehicles type.","example":"plane SetVehicleType(\"f35_vtol\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"type","description":"The type name","mandatory":true}]}]},{"name":"SetVehMaxSpeed","description":"overrides the max speed for this vehicle.","example":"self SetVehMaxSpeed( 45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed to set","mandatory":true}]}]},{"name":"SetVehVelocity","description":"Sets the linear velocity on a vehicle/s.","example":"self SetVehVelocity( (45, 0, 0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"velocity","description":"The vehicle velocity","mandatory":true}]}]},{"name":"SetVehWeapon","description":"Set the vehicle's weapon","example":"chopper setVehWeapon( \"AGM_114\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"weapon name","description":"The name of the weapon","mandatory":true}]}]},{"name":"SetYawSpeed","description":"Sets the yaw speed for this vehicle.","example":"self SetYawSpeed( 120, 60 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed of the vehicle in angles per second","mandatory":true},{"name":"acceleration","description":"The acceleration of the vehicle in angles per second^2","mandatory":true},{"name":"deceleration","description":"Deceleration. If not specified, set to be equal to acceleration","mandatory":false}]}]},{"name":"StartPath","description":"Starts the vehicle following this path.","example":"bomber StartPath()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"StopFireWeapon","description":"Stop firing the vehicle's main weapon","example":"nFlak StopFireWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"SwitchStartNode","description":"Swaps the start node for this vehicle.","example":"tank2 SwitchStartNode( tank2snode1, tank2snode2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"source node","description":"The start source node","mandatory":true},{"name":"dest node","description":"The start destination node.","mandatory":true}]}]},{"name":"TakePlayerControl","description":"You call this function to take control away from a player.","example":"cobra TakePlayerControl()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"UseVehicle","description":"same as useby except you can specify a seat, 0 driver, 1-4 gunners","example":"lvt usevehicle( player, 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"user entity","description":"The player to use the vehicle","mandatory":true},{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true}]}]},{"name":"VehDriverAimAtCrosshairs","description":"Enables or disables the driver turret aiming at the crosshairs (aiming at the crosshairs overrides all other aim targets and is the default behavior)","example":"vehicle VehDriverAimAtCrosshairs( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"AimAtCrosshairs","description":"True to aim the turret at the crosshairs","mandatory":true}]}]},{"name":"EnumerateWeapons","description":"Return an array of weapon names for the weapons of weapon type in fastfile","example":"a_weapons = EnumerateWeapons( \"weapon\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon type","description":"The type of weapon to return(weapon or weaponfull)","mandatory":true}]}]},{"name":"Missile_CreateAttractorEnt","description":"Creates a missile attractor at the origin of an entity","example":"attractor = Missile_CreateAttractorEnt( enemy_chopper, 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity that is to be an attractor","mandatory":true},{"name":"strength","description":"The strength of the attractor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectdist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_CreateAttractorOrigin","description":"Creates a missile attractor at the given location","example":"attractor = Missile_CreateAttractorOrigin( (100, 350, 10), 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The center of the attractor","mandatory":true},{"name":"strength","description":"The strength of the attractor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectDist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_CreateRepulsorEnt","description":"Creates a missile repulsor at the origin of an entity","example":"repulsor = Missile_CreateRepulsorEnt( enemy_chopper, 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity that is to be a repulsor","mandatory":true},{"name":"strength","description":"The strength of the repulsor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectDist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_CreateRepulsorOrigin","description":"Creates a missile Repulsor at the given location","example":"repulsor = Missile_CreateRepulsorOrigin( (100, 350, 10), 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The center of the Repulsor","mandatory":true},{"name":"strength","description":"The strength of the Repulsor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectDist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_DeleteAttractor","description":"Deletes a missile attractor or repulsor","example":"Missile_DeleteAttractor( attractor )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"attractor","description":"The attractor or repulsor","mandatory":true}]}]}],"default":{"languageId":"gsc","gameId":"t7","revision":6,"revisedOn":"2024-11-22T19:49:00.000Z","enums":[{"name":"MeansOfDeath","values":["MOD_UNKNOWN","MOD_CRUSH","MOD_TELEFRAG","MOD_SUICIDE","MOD_DROWN","MOD_HIT_BY_OBJECT","MOD_FALLING","MOD_PROJECTILE","MOD_MELEE","MOD_MELEE_WEAPON_BUTT","MOD_EXPLOSIVE","MOD_PROJECTILE_SPLASH","MOD_GRENADE","MOD_GRENADE_SPLASH","MOD_PISTOL_BULLET","MOD_RIFLE_BULLET","MOD_BURNED","MOD_TRIGGER_HURT"]},{"name":"HitLocation","values":[["none","torso_upper","torso_lower","helmet","head","neck","left_arm_upper","left_arm_lower","left_hand","right_arm_upper","right_arm_lower","right_hand","left_leg_upper","left_leg_lower","left_foot","right_leg_upper","right_leg_lower","right_foot"]]}],"api":[{"name":"ActivateClientExploder","description":"Activates a client-side exploder.","remarks":["This is sent as a reliable command and will not work with killcam or demos."],"example":"ActivateClientExploder( 101 )","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":null,"parameters":[{"name":"exploderId","description":"ID of exploder to activate.","type":{"dataType":"int","isArray":false},"mandatory":true}],"returns":{"void":true}}]},{"name":"ActivateClientRadiantExploder","description":"Activates a client side radiant exploder","example":"ActivateClientRadiantExploder( \"light_switch\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"string id of exploder to activate","mandatory":true}]}]},{"name":"ActorIKEnabled","description":"Determines whether this actor can use IK functions. Returns true if IK is available, otherwise false.","example":"if (guy ActorIKEnabled()) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"AddBonusCardStat","description":"Sets the indicated stat for that bonus card","example":"self AddBonusCardStat( BONUSCARD_OVERKILL, \"kills\", 1, self.class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bonuscard","description":"Bonus Card define from _bonuscards.gsh","mandatory":true},{"name":"statname","description":"The name of the stat you wish to set","mandatory":true},{"name":"statincrease","description":"The amount you would like to increase the stat","mandatory":true},{"name":"currentclassnum","description":"The loadout the player is using","mandatory":true}]}]},{"name":"AddDemoBookmark","description":"adds the information to the demo bookmarking system","example":"AddDemoBookmark( bookmark_string, gettime(), self GetEntityNumber(), 255, 0, inflictorEntNum, inflictorEntType, inflictorBirthTime, false, self.grenade_multiattack_ent GetEntityNumber() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"type","description":"the type of bookmark","mandatory":true},{"name":"time","description":"the time of recording the bookmark","mandatory":true},{"name":"client1","description":"the client related to the bookmark","mandatory":true},{"name":"client2","description":"other client which is associated with the bookmark","mandatory":true},{},{"name":"entityNumber","description":"The entity number","mandatory":true},{"name":"eType","description":"Entity type","mandatory":true},{"name":"birthTime","description":"Birth Time","mandatory":true},{"name":"overrideEntityCamera","description":"Whether to override Entity Camera","mandatory":true},{}]}]},{"name":"AddEntityInfluencer","description":"Adds a new influencer of attached to ","example":"influencer_id = AddEntityInfluencer( name, player, allies_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true},{"name":"entity","description":"Attached to entity. Goes away when entity is deleted. Unless a time is set.","mandatory":true},{"name":"team mask","description":"teams that this influencer will affect","mandatory":true}]}]},{"name":"AddInfluencer","description":"Adds a new influencer of at ","example":"influencer_id = AddInfluencer( name, origin, allies_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true},{"name":"origin","description":"center point of the influencer","mandatory":true},{"name":"team mask","description":"teams that this influencer will affect","mandatory":true}]}]},{"name":"AddOrientedInfluencer","description":"Adds a new influencer of at and ","example":"influencer_id = AddOrientedInfluencer( name, origin, angles, allies_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true},{"name":"origin","description":"center point of the influencer","mandatory":true},{"name":"angles","description":"angles of entity","mandatory":true},{"name":"team mask","description":"teams that this influencer will affect","mandatory":true}]}]},{"name":"AddSpawnPoints","description":"Adds spawnpoints to the spawn system","example":"AddSpawnPoints( \"allies\", \"mp_tdm_spawn\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The team","mandatory":true},{}]}]},{"name":"AddTestClient","description":"Adds a test client (bot) to the map and returns a reference to that client.","example":"ent[i] = AddTestClient()","flags":["verified"],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[],"returns":{"name":"client","description":"Reference to the test client.","type":{"dataType":"struct","instanceType":"player"}}}]},{"name":"AddToInterestPool","description":"Add a script event to the sentient's interest pool.","example":"point = self AddToInterestPool( 500, 10, 5, ai.origin, ai )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"Amount the event adds to the pool. (integer)","mandatory":true},{"name":"priority","description":"How important is the event. (integer)","mandatory":true},{"name":"lifespan","description":"Time the event stays in the pool. (float)","mandatory":true},{"name":"point of interest","description":"Position the AI will investigate. (vector3)","mandatory":true},{"name":"originator","description":"Entity that caused the event.","mandatory":true},{"name":"unique","description":"Only one of this type can exist in the pool. (integer)","mandatory":false}]}]},{"name":"AimAtEntityIK","description":"Set this actor to aim at the specified entity. Call this function without any entity specified to turn it off.","example":"guy AimAtEntityIK( otherguy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"otherguy","description":"the other guy to aim at","mandatory":false}]}]},{"name":"AimAtPosIK","description":"Set this actor to aim at the specified position. Call this function without any position specified to turn it off.","example":"guy AimAtPosIK( pos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"pos","description":"the position to aim at","mandatory":false}]}]},{"name":"AllClientsPrint","description":"Cause all clients to print the localized version of this string.","example":"AllClientsPrint( \"Game Complete\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"the string to print","mandatory":true}]}]},{"name":"AllowedStances","description":"Sets the list of the actor's allowed stances.","example":"self AllowedStances( \"crouch\", \"prone\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor_or_player","description":null},"parameters":[{"name":"stance","description":"(string) A stance, can be 'prone', 'crouch', 'stand'. Any number of stances may be added.","mandatory":true}]}]},{"name":"AllowTacticalInsertion","description":"Sets whether tactical insertions can be placed within the bounding area of a given entity.","example":"my_trigger AllowTacticalInsertion( false )","flags":["verified"],"overloads":[{"calledOn":{"name":"target","description":"The target entity, such as a trigger.","type":{"dataType":"struct","instanceType":"entity"}},"parameters":[{"name":"allow","description":"Whether tactical insertions can be placed inside this entity.","mandatory":true,"type":{"dataType":"bool"}}],"returns":{"void":true}}],"verifiedInRevision":5},{"name":"AllWeaponAttachmentsUnlocked","description":"Are all the weapon attachments unlocked for this weapon?","example":"player AllWeaponAttachmentsUnlocked( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon","mandatory":true}]}]},{"name":"AnimHasNotetrack","description":"queries the given animation for a note track","example":"if ( IsDefined( facialanim ) && AnimHasNotetrack( facialanim, \"dialogue\" ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"an animation","mandatory":true},{"name":"note track","description":"a constant string with the name of the note track","mandatory":true}]}]},{"name":"AnimMappingSearch","description":"Searches animation mapping table to return a animation name when given a animation mapping alias name.","example":"self AnimMappingSearch(\"anim_arrive_cover_left_crouch\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{}]}]},{"name":"AnimRelative","description":"Runs an animscript on an entity.","example":"driver AnimRelative( \"germantruck_driver_closedoor\", org , angles, driver.closedooranim )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"notify","description":"The notify to send","mandatory":true},{"name":"origin","description":"The starting position of the anim script","mandatory":true},{"name":"angles","description":"The starting angle of the anim script","mandatory":true},{"name":"animation","description":"The animation","mandatory":true},{"name":"mode","description":"Valid modes are \"normal\" and \"deathplant\"","mandatory":false},{"name":"root","description":"The root animation","mandatory":false}]}]},{"name":"AnimScripted","description":"Runs an animscript on an entity.","example":"driver AnimScripted( \"germantruck_driver_closedoor\", org , angles, driver.closedooranim )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"notify","description":"The notify to send","mandatory":true},{"name":"origin","description":"The starting position of the anim script","mandatory":true},{"name":"angles","description":"The starting angle of the anim script","mandatory":true},{"name":"animation","description":"The animation","mandatory":true},{"name":"mode","description":"Valid modes are \"normal\" and \"deathplant\"","mandatory":false},{"name":"root","description":"The root animation","mandatory":false},{"name":"rate","description":"The playback rate of animation","mandatory":false},{"name":"blend","description":"The blend time for the animation","mandatory":false},{"name":"lerp","description":"The lerp time for an aligned animation","mandatory":false},{"name":"animation time","description":"The starting animation time in 0-1 range","mandatory":false},{"name":"is_scene_animation","description":"Should be true for player scene animations or scripted animations where the player has no control, can be ignored for non-players","mandatory":false},{"name":"showPlayerWeaponInFirstPerson","description":"determines if the first person player should have his weapon during cinematics","mandatory":false}]}]},{"name":"Announcement","description":"Sends an announcement to all clients.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The announcement.","mandatory":true},{"name":"duration","description":"How long, in seconds, to display the announcement.","mandatory":true}]}]},{"name":"ApplyBallisticTarget","description":"Launch a vehicle with just enough force at a target.","example":"dropRaps ApplyBallisticTarget( (50,50,10) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"targetPos","description":"The position to launch the vehicle towards","mandatory":true}]}]},{"name":"AreAllMissionsAtScore","description":"Returns true if all missions are at the score specified","example":"is_score_achieved = self AreAllMissionsAtScore( 10000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"score","description":"A score that all missions must be at to return true (integer)","mandatory":true}]}]},{"name":"arenagetcurrentseason","description":"Returns the current arena season","example":"ArenaGetCurrentSeason()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ArenaGetSlot","description":"Returns the current arena slot","example":"ArenaGetSlot()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"AreTexturesLoaded","description":"Check to see if start-of-level textures are loaded - if they're not, the streamer forces a black screen.","example":"while( !areTexturesLoaded() ) { wait(0.05); }","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ArraySort","description":"Returns a sorted array of entities by closest or farthest distance from ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to sort","mandatory":true},{"name":"origin","description":"the origin from which to compare","mandatory":true},{"name":"closest","description":"if set to true the array will be sorted by distance closest to , if false by distance farthest from ","mandatory":false},{"name":"max","description":"if set then only the first count of entities will be returned","mandatory":false},{"name":"range","description":"if set then only the entities within will be considered","mandatory":false}]}]},{"name":"ArraySortClosest","description":"Returns a sorted array of entities by closest from ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to sort","mandatory":true},{"name":"origin","description":"the origin from which to compare","mandatory":true},{"name":" count of entities will be returned","mandatory":false},{"name":"minDist","description":"if set then only the entities further than will be considered","mandatory":false},{"name":"maxDist","description":"if set then only the entities closer then 0, the bad place will automatically delete itself after this time. If duration <= 0, the bad place must have a name and will last until manually deleted.","mandatory":true},{"name":"origin","description":"The origin of the box.","mandatory":true},{"name":"halfSize","description":"The halfSize of the box.","mandatory":true},{"name":"team","description":"You must specify at least one team for which this place is bad, but can give several. The allowed teams are 'axis', 'allies', and 'neutral'.","mandatory":true}]}]},{"name":"BadPlace_Cylinder","description":"Creates a bad place cylinder. AI will flee this position if they can, and will not go into it if they can avoid it.","example":"BadPlace_Cylinder( \"moody\", -1, level.moodyfall_mn, level.moodyfall_radius, \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The name of the bad place. If name is not \"\", the bad place can be moved or deleted by using the unique name.","mandatory":true},{"name":"duration","description":"If duration > 0, the bad place will automatically delete itself after this time. If duration <= 0, the bad place must have a name and will last until manually deleted.","mandatory":true},{"name":"origin","description":"The origin of the cylinder.","mandatory":true},{"name":"radius","description":"The radius of the cylinder.","mandatory":true},{"name":"height","description":"The height of the cylinder.","mandatory":true},{"name":"team","description":"You must specify at least one team for which this place is bad, but can give several. The allowed teams are 'axis', 'allies', and 'neutral'.","mandatory":true}]}]},{"name":"BadPlace_Delete","description":"Deletes a bad place. It is okay to delete a bad place name that doesn't exist. It is not okay to delete the special name \"\".","example":"BadPlace_Delete( \"bpFlak1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"bad place identifier","description":"The bad place to delete","mandatory":true}]}]},{"name":"BallSetTarget","description":"Sets the target of the ball to the given entity, and resets if no entity is specified.","example":"self BallSetTarget( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ball","description":null},"parameters":[{"name":"target","description":"The target of the missile","mandatory":true},{"name":"targetOffset","description":"Offset to the target location (vector3)","mandatory":false}]}]},{"name":"Ban","description":"Bans the specified player.","example":"Ban( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"clientnum","description":"The client number of the player to ban.","mandatory":true}]}]},{"name":"BeamTrace","description":"Performs a bullet trace between two points and returns an array of information about the trace result.","example":"a_trace = BeamTrace( org1, org2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start_pos","description":"(point) The start position for the trace.","mandatory":true},{"name":"end_pos","description":"(point) The end position for the trace.","mandatory":true},{"name":"hit_characters","description":"(bool) Tell the trace to hit characters or not.","mandatory":true},{"name":"ignore_ent","description":"(entity) Entity to ingore for trace.","mandatory":true},{"name":"ignore_water","description":"(bool) Ignore water - defaults to false.","mandatory":false},{"name":"ignore_glass","description":"(bool) Ignore glass - defaults to false.","mandatory":false},{"name":"ignore_ent2","description":"(entity) Second entity to ingore for trace.","mandatory":false}]}]},{"name":"BloodImpact","description":"Sets the blood impact type on the character","example":"guy BloodImpact ( \"none\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"value","description":"Has to be one of: \"none\", \"hero\" or \"normal\"","mandatory":true}]}]},{"name":"Bobbing","description":"Causes a script entity to bob around its origin, along a given vector dir","example":"self Bobbing( directionVir, 0.3, 0.4, 0.0f )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"direction vector","description":"The direction of the bobbing","mandatory":true},{"name":"amplitude","description":"The amount of the bobbing in units","mandatory":true},{"name":"period","description":"The period of the bobbing in seconds","mandatory":true},{"name":"phase","description":"The phase offset of the bobbing","mandatory":false}]}]},{"name":"BonusCardActiveCount","description":"Returns how many bonus cards are active, cannot be called on a larry","example":"cardCount = self BonusCardActiveCount( self.class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"classnum","description":"The current class num of the player","mandatory":true}]}]},{"name":"BoundsWouldTelefrag","description":"Returns true if the passed in bounding box would telefrag a player if another player was spawned there.","example":"if ( BoundsWouldTelefrag( vehicle GetAbsMins(), vehicle GetAbsmaxs() ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mins","description":"Mins of bounding box","mandatory":true},{"name":"maxs","description":"Maxs of bounding box","mandatory":true}]}]},{"name":"BulletSpread","description":"uses spread to return a new end position","example":"endpos = BulletSpread( self.origin, target.origin, 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet starting point","mandatory":true},{"name":"end","description":"The bullet ending point","mandatory":true},{"name":"spread","description":"Amount of spread","mandatory":true}]}]},{"name":"BulletTrace","description":"Performs a bullet trace between two points and returns a map array of information about the trace result.","example":"a_trace = BulletTrace( org1, org2, true, undefined )","flags":["verified"],"verifiedInRevision":5,"overloads":[{"calledOn":null,"parameters":[{"name":"startPos","description":"The starting position of the trace.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"endPos","description":"The ending position for the trace.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"hitCharacters","description":"Whether the trace should hit characters.","mandatory":true,"type":{"dataType":"bool"}},{"name":"ignoreEnt","description":"An entity that should be ignored by the trace, which can be `undefined`.","mandatory":true,"type":{"dataType":"struct","instanceType":"entity","nullable":true}},{"name":"ignoreWater","description":"Whether the trace should ignore water surfaces. Defaults to `false`.","mandatory":false,"type":{"dataType":"bool"}},{"name":"ignoreGlass","description":"Whether the trace should ignore glass surfaces. Defaults to `false`.","mandatory":false,"type":{"dataType":"bool"}},{"name":"ignoreEnt2","description":"If specified, a second entity that the trace should ignore.","mandatory":false,"type":{"dataType":"struct","instanceType":"entity","nullable":true}}],"returns":{"name":"result","description":"A map of information about the bullet trace result.","type":{"dataType":"map"}}}]},{"name":"BulletTracePassed","description":"Allows script to do a bullet point trace with ( MASK_SHOT & ~CONTENTS_SKY ) returns true if the trace does not hit anything","example":"passed = BulletTracePassed( grenade.origin, self.origin + (0,0,TROPHY_TRACE_Z), false, self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"hit characters","description":"An entity to ignore","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true},{"name":"ignore entity 2","description":"An entity to ignore","mandatory":false},{"name":"fx vis","description":"check against fx visibility also","mandatory":false},{"name":"ignore water","description":"mask contents_water","mandatory":false}]}]},{"name":"CamAnimScripted","description":"Plays the camera script on a player.","example":"CamAnimScripted( player, \"proto_melee_cam\", gettime(), origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to play animation on","mandatory":true},{"name":"cam_anim","description":"The animation to play","mandatory":true},{"name":"start_time","description":"The start time of the animation","mandatory":true},{"name":"align_origin","description":"The origin to align to","mandatory":true},{"name":"align_angles","description":"The angles to align to","mandatory":true},{"name":"lerp_duration","description":"The lerp duration","mandatory":false},{"name":"camera_name","description":"The camera name","mandatory":false},{"name":"ignoreProcessingInitialNoteTracks","description":"Ignores processing the initial notetracks if the camera time starts earlier","mandatory":false}]}]},{"name":"CanClaimNode","description":"Returns true if the node is unclaimed, false otherwise.","example":"if ( CanClaimNode( cover, team ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"pathnode to check","mandatory":true},{}]}]},{"name":"CanPath","description":"Check if a path can be found between these positions.","example":"if ( self CanPath( self.origin, targetpos ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"ChangeAdvertisedStatus","description":"Changes the advertised status","example":"changeAdvertisedStatus( onOff )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"onOff","description":"(boolean)","mandatory":true}]}]},{"name":"CheckIfSongUnlocked","description":null,"example":"self CheckIfSongUnlocked( \"frag_out\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string)","mandatory":true}]}]},{"name":"CheckNavMeshDirection","description":"Run a trace on NavMesh to get the furthest position a character can move in that direction","example":"pos = CheckNavMeshDirection( (10,20,30), ( 1, 1, 0 ), 25 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"start of the trace","mandatory":true},{"name":"dir","description":"direction to trace","mandatory":true},{"name":"dist","description":"distance to trace","mandatory":true},{"name":"characterRadius","description":"the radius of the capsule used in trace. default to 0.","mandatory":false},{"name":"materialFlags","description":"the flags marking whether a face type can be used","mandatory":false}]}]},{"name":"ClearAnim","description":"Sets an animation's goal weight (and the goal weights of all of its descendents) to zero over the specified time.","example":"self ClearAnim( %root, 0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to clear","mandatory":true},{"name":"time","description":"The blending time for the clear","mandatory":true}]}]},{"name":"ClearAnimLimited","description":"Sets an animation's goal weight to zero over the specified time.","example":"self ClearAnimLimited( %root, 0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to clear","mandatory":true},{"name":"time","description":"The blending time for the clear","mandatory":true}]}]},{"name":"ClearPlayerCorpses","description":"Removes all player corpses from the level","example":"ClearPlayerCorpses( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ClearPlayerGravity","description":"Clears the gravity override for the player.","example":"player ClearPlayerGravity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ClearSpawnPoints","description":"Clears all spawnpoints out of the system","example":"ClearSpawnPoints()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"list","description":"which list of spawnpoints to clear","mandatory":false}]}]},{"name":"ClearSpawnPointsBaseWeight","description":"Clears the objective base weights set in the spawn points","example":"ClearSpawnPointsBaseWeight( team_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team mask","description":"teams that this command will affect","mandatory":true}]}]},{"name":"ClearStowedWeapon","description":"Clears the stowed weapon for the player","example":"self ClearStowedWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ClearTargetEntity","description":"Clears the current target for this vehicle or turret.","example":"roof_turret ClearTargetEntity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"ClearTopScorers","description":"Clears the top scorer for the end game screen.","example":"ClearTopScorers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ClientAnnouncement","description":"Sends an announcement to a single client.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"clientnum","description":"The client number that the announcement is sent to.","mandatory":true},{"name":"string","description":"The announcement.","mandatory":true},{"name":"duration","description":"How long, in seconds, to display the announcement.","mandatory":true}]}]},{"name":"ClientClaimTrigger","description":"Claim a single user trigger.","example":"other ClientClaimTrigger( self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"trigger","description":"A trigger entity.","mandatory":true}]}]},{"name":"ClientPrint","description":"Print a localized version of this string for a given client","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"A client entity.","mandatory":true},{"name":"string","description":"A message to print.","mandatory":true}]}]},{"name":"ClientReleaseTrigger","description":"Release a single user trigger.","example":"other ClientReleaseTrigger( self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"trigger","description":"A trigger entity.","mandatory":true}]}]},{"name":"ClientSysRegister","description":"Declares a system who's state will be communicated over to the client script system when it changes. Takes a unique name, and returns the id of the system.","example":"index = ClientSysRegister(\"FakeFire\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The unique name of the system to be registered","mandatory":true}]}]},{"name":"ClientSysSetState","description":"Sets the state of a pre registered client system for all clients. The state will be communicated to the client script system.","example":"ClientSysSetState(level._ClientSys[\"FakeFire\"], \"Event1Phase1\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"id","description":"The integer id of the client system. Returned from call to ClientSysRegister.","mandatory":true},{"name":"state","description":"Arbitrary string state. Will be sent to the client script system.","mandatory":true}]}]},{"name":"CloneAndRemoveEntity","description":"Creates a new entity at the position/orientation/pose of the original, and kills the original","example":"CloneAndRemoveEntity( ent )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"entity field","mandatory":true}]}]},{"name":"CodeGetClientField","description":"Gets the value for a given client field.","example":"val = CodeGetClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity to search the name in","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeGetPlayerStateClientField","description":"Gets the value for a given player state client field.","example":"val = CodeGetPlayerStateClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeGetUIModelClientField","description":"Gets the value for a given player uimodel client field.","example":"val = CodeGetUIModelClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeGetWorldClientField","description":"Gets the value for a given client field.","example":"val = CodeGetWorldClientField(\"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementClientField","description":"Increments the value for a given client field.","example":"CodeIncrementClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementPlayerStateClientField","description":"Increments the value for a given player state client field.","example":"CodeIncrementPlayerStateClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementUIModelClientField","description":"Increments the value for a given client field.","example":"CodeIncrementUIModelClientField(ent, \"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeIncrementWorldClientField","description":"Increments the value for a given world client field.","example":"CodeIncrementWorldClientField(\"my_field\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true}]}]},{"name":"CodeSetClientField","description":"Sets the value for a given client field.","example":"CodeSetClientField(ent, \"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CodeSetPlayerStateClientField","description":"Sets the value for a given player state client field.","example":"CodeSetPlayerStateClientField(ent, \"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CodeSetUIModelClientField","description":"Sets the value for a given player uimodel client field.","example":"CodeSetUIModelClientField(ent, \"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"A player","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CodeSetWorldClientField","description":"Sets the value for a given world client field.","example":"CodeSetWorldClientField(\"my_field\", 1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"value","description":"Value to transmit.","mandatory":true}]}]},{"name":"CollisionTestPointsInBox","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInCone","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInCylinder","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInPill","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CollisionTestPointsInSphere","description":"Returns an array of collision result structures","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ConnectPaths","description":"Connects the paths that intersect with the entity.","remarks":["If the entity is a `script_brushmodel` then it must have `DYNAMICPATH` set to connect paths."],"example":"vehicle ConnectPaths()","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":{"name":"target","description":"The entity to connect the paths on.","type":{"dataType":"struct","instanceType":"entity","isArray":false}},"parameters":[],"returns":{"void":true}}]},{"name":"ConsumableDecrement","description":"Decrement a specified consumable for the player by the specified amount","example":"self ConsumableDecrement( \"blackjack\", \"awarded\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ConsumableGet","description":"Returns the value of the specified consumable for the player","example":"self ConsumableGet( \"blackjack\", \"awarded\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ConsumableIncrement","description":"Increment a specified consumable for the player by the specified amount","example":"self ConsumableIncrement( \"blackjack\", \"awarded\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ConsumableSet","description":"Set a specified consumable for the player to the specified amount","example":"self ConsumableSet( \"blackjack\", \"awarded\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CountPlayers","description":"Returns a count of the current players, even if they are still connecting to the game.","example":"count = CountPlayers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"- if specifed, returns lists of players on different teams, in team based game modes. Valid values \"allies\", \"axis\", \"neutral\" & \"all\"","mandatory":false}]}]},{"name":"CreateDynEntAndLaunch","description":"Creates and launches a dynent.","example":"CreateDynEntAndLaunch( spawn_models[i], origin, angles, origin, velocity, anim._effect[\"animscript_gibtrail_fx\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{"name":"pos","description":"position to spawn at.","mandatory":true},{"name":"angles","description":"angles to spawn at.","mandatory":true},{"name":"hitpos","description":"the hit position","mandatory":true},{"name":"force","description":"The force of the launch","mandatory":true},{"name":"fx","description":"particle effects to play on this dynent","mandatory":false}]}]},{"name":"CreateStreamerHint","description":"Allows scripter to create a streamer hint entity viewpoint to the player's viewpoint.","example":"streamHintEnt = createStreamerHint( level.player.origin, 0.333 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Location at which to spawn the streamer hint.","mandatory":true},{"name":"factor","description":"The relative importance of this entity's viewpoint to the main viewpoint.","mandatory":true},{"name":"lightingState","description":"The lighting state to stream","mandatory":false}]}]},{"name":"CurrentSessionMode","description":"Returns the current session mode index","example":"sessionMode = CurrentSessionMode()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"CylinderDamage","description":"cylinder_dir_vector should contains the direction and the length of the cylinder relative to the base origin","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cylinder_vec","description":"contains the direction and the length of the cylinder relative to the base origin","mandatory":true},{"name":"origin","description":"Origin of damage","mandatory":true},{"name":"near_radius","description":"Radius of the damage at the near end","mandatory":true},{"name":"far_radius","description":"Radius of the damage at the far end","mandatory":true},{"name":"max_damage","description":"Max damage, this is the damage at the origin","mandatory":true},{"name":"min_damage","description":"Max damage, this is the damage at the edge of the radius","mandatory":true},{"name":"attacker","description":"Attacker the dealt the damage","mandatory":false},{"name":"means_of_death","description":"Means of death of the damage","mandatory":false},{"name":"weapon","description":"Weapon used to damage","mandatory":false}]}]},{"name":"DamageConeTrace","description":"Determines how much the entity can be seen from the given position. Performs multiple 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":"turretDamageFraction = entity damageConeTrace( turret.origin + (0,0,40), turret )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"damage position","description":"The point the sight starts at","mandatory":true},{"name":"ignore entity","description":"An entity to ignore when doing the traces","mandatory":false},{"name":"damage angles","description":"The forward direction of the cone, whose base is at the . Must be normalized.","mandatory":false},{"name":"cone angle","description":"Angle in degrees from the line of sight to the edge of the cone. Defaults to 65.","mandatory":false}]}]},{"name":"DeactivateClientExploder","description":"Deactivates a client side exploder","example":"DeactivateClientExploder( 101 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"id of exploder to deactivate","mandatory":true}]}]},{"name":"DeactivateClientRadiantExploder","description":"Deactivates a client side radiant exploder","example":"DeactivateClientRadiantExploder( \"light_switch\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"string id of exploder to deactivate","mandatory":true}]}]},{"name":"Delete","description":"Removes an entity from the game in the same manner as a trigger_kill","example":"self Delete()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DeletePathNode","description":"Delete a dynamically created path node or cover node","example":"DeletePathNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to delete","mandatory":true}]}]},{"name":"DeployRiotShield","description":"Gets the index in a particular class","example":"DeployRiotShield( owner, shield )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"DepthInWater","description":"Returns the depth (in inches) that the entity is in water. Returns depth in inches, or 0 if the entity isn't in water. Will work for all water types.","example":"depth = get_players()[0] DepthInWater()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DepthOfPlayerInWater","description":"Returns the depth (in inches) that the player is in water. Returns depth in inches, or 0 if the entity isn't in water. Will work for all water types. More effecient than depthinwater but will only work for players","example":"depth = get_players()[0] DepthOfPlayerInWater()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"Detach","description":"detaches an attached model from an entity","example":"self Detach( \"explosivepack\", \"tag_weapon_right\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelname","description":"The model name to detach (string)","mandatory":true},{"name":"tagname","description":"The tag to detach the model from (string)","mandatory":false}]}]},{"name":"DetachAll","description":"detaches all attached models from an entity","example":"self DetachAll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DetachShieldModel","description":"Detaches an attached shield model from a player.","example":"self DetachShieldModel( \"weapon_riot_shield\", \"tag_weapon_left\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"modelname","description":"The model name to detach (string)","mandatory":true},{"name":"tagname","description":"The tag to detach the model from (string)","mandatory":false}]}]},{"name":"Detonate","description":"Detonate the entity and set the owner to the player which is specified.","example":"self Detonate( attacker )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"player","description":"The player who owns the entity","mandatory":false}]}]},{"name":"DirectionalHitIndicator","description":"Create a directional hit indicator","example":"attacker DirectionalHitIndicator( victimArray0, victimArray1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"victims0","description":"A bit array of entities 0-31 that got hit","mandatory":true},{"name":"victims1","description":"A bit array of entities 32-63 that got hit","mandatory":false}]}]},{"name":"DisableAimAssist","description":"Disables Aim assist on the entity. Entity has to be either a brush model or an actor or a vehicle or a script_model.","example":"player DisableAimAssist()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DisableDestructiblePieces","description":"Disables all destructible pieces that have this label set in the destructible gdt","example":"DisableDestructiblePieces( \"heavy_armor\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"label","description":"the name of the field listed in the destructible gdt to disable","mandatory":true}]}]},{"name":"DisableGrenadeSuicide","description":"Stops cooked grenades from killing the player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"DisableGrenadeTouchDamage","description":"Resets the grenade touch damage flag of the entity","example":"self DisableGrenadeTouchDamage()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DisableOffhandSpecial","description":"Disable the ability to activate a player's special offhand weapons","example":"player DisableOffhandSpecial()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableSpawnPointList","description":"disables spawn point list for a the team_mask","example":"DisableSpawnPointList()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"list","description":"list to disable","mandatory":true},{"name":"team mask","description":"teams that this command will affect","mandatory":true}]}]},{"name":"DisconnectPaths","description":"Disconnects the paths that intersect with the entity.","remarks":["If the entity is a `script_brushmodel` then it must have `DYNAMICPATH` set to disconnect paths."],"example":"level.ArmoredCar DisconnectPaths()","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":{"name":"target","description":"The entity to disconnect the paths on.","type":{"dataType":"struct","instanceType":"entity","isArray":false}},"parameters":[{"name":"detailLevel","description":"How detailed the cut part matches the entity. 0 or omitted: Box. 1: Convex hull fitting rough shape. 2: [SUPER EXPENSIVE] Use collision shape directly.","type":{"dataType":"int","isArray":false},"mandatory":false},{"name":"moveAllowed","description":"Sets whether the silhouette moves with the entity (defaults to true).","type":{"dataType":"bool","isArray":false},"mandatory":false}],"returns":{"void":true}}]},{"name":"DoDamage","description":"Does damage to this entity","example":"player DoDamage(25, gasEffectArea.origin, player.lastPoisonedBy, grenade_obj, 0, \"MOD_EXPLOSIVE\", 0, GetWeapon(\"tabun_gas_mp\"), -1, false)","flags":["verified"],"verifiedInRevision":5,"overloads":[{"calledOn":{"name":"target","description":"The entity that the damage should be dealt upon.","mandatory":true,"type":{"dataType":"struct","instanceType":"entity"}},"parameters":[{"name":"health","description":"The amount of damage to do.","mandatory":true,"type":{"dataType":"int"}},{"name":"sourcePosition","description":"The source location that the damage comes from.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"attacker","description":"The entity that dealt the damage (such as an AI or player).","mandatory":false,"type":{"dataType":"struct","instanceType":"entity"}},{"name":"inflictor","description":"The entity that the damage came from (such as a grenade or turret).","mandatory":false,"type":{"dataType":"struct","instanceType":"entity"}},{"name":"hitLoc","description":"The location of the damage, which defaults to `none`.","mandatory":false,"type":{"dataType":"enum","instanceType":"HitLocation"}},{"name":"mod","description":"The means of death string. If not specified, the means of death will be `MOD_UNKNOWN`.","mandatory":false,"type":{"dataType":"enum","instanceType":"MeansOfDeath"}},{"name":"dFlags","description":"Any flags associated with the damage being dealt. Defaults to 0 (no flags).","mandatory":false,"type":{"dataType":"int"}},{"name":"weapon","description":"The weapon used to deal the damage.","mandatory":false,"type":{"dataType":"struct","instanceType":"weapon"}},{"name":"destructiblePieceIndex","description":"The destructible piece index from the destructible def GDT.","mandatory":false,"type":{"dataType":"int"}},{"name":"forcePain","description":"When set to `true`, the target entity's pain time is reset to zero, forcing them to produce a pain reaction to the damage.","mandatory":false,"type":{"dataType":"bool"}}],"returns":{"void":true}}],"remarks":["For the `dFlags` parameter, each flag corresponds to a particular bit position, allowing them to be combined. These are defined in `shared.gsh`."]},{"name":"DoesWeaponReplaceSpawnWeapon","description":"Returns true if the new weapon is an alt mode of the spawn weapon. Only certain alt variations are valid (not-gl)","example":"if ( DoesWeaponReplaceSpawnWeapon( self.spawnWeapon, newWeapon ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"DontInterpolate","description":"pop the entity's position instantaneously to where it moves this time step, rather than smoothly moving there from the previous position","example":"entity DontInterpolate()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"DoubleXPTimerFired","description":"Used to decrement consumable double xp promotions","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DrawNode","description":"Draws a node","example":"DrawNode( self.node)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"pathnode","mandatory":true}]}]},{"name":"DropNodEToFloor","description":"Drop the node to the floor.","example":"DropNodeToFloor( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"node to drop","mandatory":true}]}]},{"name":"EACPathSet","description":"Sets the value of a eac path drone.","example":"SetEACPATH( origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vec3","description":"The value.","mandatory":true}]}]},{"name":"Earthquake","description":"Create an earthquake shaking effect at the given location.","example":"Earthquake( 0.22, 7, player.origin, 150 )","flags":["verified"],"overloads":[{"calledOn":{"name":"target","description":"When specified, the earthquake is shown only to the target player.","mandatory":false,"type":{"dataType":"struct","instanceType":"player"}},"parameters":[{"name":"scale","description":"Magnitude scalar of the earthquake. Must be greater than 0.","mandatory":true,"type":{"dataType":"number"}},{"name":"duration","description":"The duration of the earthquake. Must be greater than 0.","mandatory":true,"type":{"dataType":"number"}},{"name":"origin","description":"The source location of the earthquake.","mandatory":true,"type":{"dataType":"vec3"}},{"name":"radius","description":"The radius of the earthquake. Must be greater than 0.","mandatory":true,"type":{"dataType":"number"}}],"returns":{"void":true}}],"verifiedInRevision":5},{"name":"EnableAimAssist","description":"Enables Aim assist on the entity. Entity has to be either a brush model or an actor or a vehicle or a script_model.","example":"player EnableAimAssist()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"EnableAllDestructiblePieces","description":"Enables all destructible pieces that were previously disabled","example":"EnableAllDestructiblePieces()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"EnableGrenadeSuicide","description":"Enables cooked grenades killing the player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"EnableGrenadeTouchDamage","description":"Sets the grenade touch damage flag of the entity","example":"self EnableGrenadeTouchDamage()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"EnableInfluencer","description":"Enables or disables the given influencer","example":"EnableInfluencer( influencer_id, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer to enable/disable","mandatory":true},{"name":"enable","description":"True to enable. False to disable","mandatory":true}]}]},{"name":"EnableLinkTo","description":"enables linkto for an entity","example":"self.bombtrigger EnableLinkTo()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"EnableNavMeshTrigger","description":"Enables/disables a given navmesh trigger","example":"EnableNavMeshTrigger( \"some_trigger\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"The targetname of the trigger entity.","mandatory":true},{"name":"enable","description":"Whether to enable disable the given volume for pathfinding.","mandatory":true}]}]},{"name":"EnableObstacle","description":"Enables or disables the hkai obstacle associated with a given entity.","example":"ent EnableObstacle( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"enable","description":"Whether to enable or disable the obstacle","mandatory":true}]}]},{"name":"EnableOffhandSpecial","description":"Enable the ability to activate a player's special offhand weapons","example":"player EnableOffhandSpecial()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableSpawnPointList","description":"enables spawn point list for a the team_mask","example":"EnableSpawnPointList()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"list","description":"list to enable","mandatory":true},{"name":"team mask","description":"teams that this command will affect","mandatory":true}]}]},{"name":"EndCamAnimScripted","description":"Ends the camera script on a player.","example":"EndCamAnimScripted( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{}]}]},{"name":"EndExtraCamAnimScripted","description":"Ends the extracam camera script on a player.","example":"EndExtraCamAnimScripted( player, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player","description":"The player to play animation on","mandatory":true},{"name":"extra_cam_index","description":"The extra camera index","mandatory":true}]}]},{"name":"ExitLevel","description":"exits the current level","example":"ExitLevel( false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"save persistent","description":"if true then player info is retained","mandatory":false}]}]},{"name":"ExperimentsGetVariant","description":"Gets the variant for a user for an experiment","example":"variant = player ExperimentsGetVariant( experimentName )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ExtraCamAnimScripted","description":"Plays the camera script on an extracam player.","example":"ExtraCamAnimScripted( player, 0, \"proto_melee_cam\", gettime(), origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to play animation on","mandatory":true},{"name":"extra_cam_index","description":"The extra camera index","mandatory":true},{"name":"cam_anim","description":"The animation to play","mandatory":true},{"name":"start_time","description":"The start time of the animation","mandatory":true},{"name":"align_origin","description":"The origin to align to","mandatory":true},{"name":"align_angles","description":"The angles to align to","mandatory":true},{"name":"lerp_duration","description":"The lerp duration","mandatory":false},{"name":"camera_name","description":"The camera name","mandatory":false},{"name":"ignoreProcessingInitialNoteTracks","description":"Ignores processing the initial notetracks if the camera time starts earlier","mandatory":false}]}]},{"name":"FakeFire","description":"Simulates gun fire. Sound and radar blip.","example":"decoy FakeFire( player, position, \"turret_mp\", 20 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"owner","description":"The player who fakes fire","mandatory":true},{"name":"origin","description":"the origin of the fake fire","mandatory":true},{"name":"weapon","description":"The weapon used","mandatory":true},{"name":"shot count","description":"Number of shots fired","mandatory":true}]}]},{"name":"FindAnimByName","description":"Find specified animation( using animation name ) in a specified animtree( using atr name).","example":"animnamehash = FindAnimByName(\"generic_human\", \"chicken_dance\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"tree","description":"Anim tree name","mandatory":true},{"name":"anim","description":"Name of anim","mandatory":true}]}]},{"name":"FindPath","description":"Check if a path can be found between these positions.","example":"if ( self FindPath( self.origin, potentialpos ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":".","mandatory":true},{"name":"end","description":".","mandatory":true}]}]},{"name":"FlashbackFinish","description":"Finishes the flashback","example":"self FlashbackFinish()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"FlashbackStart","description":"Starts the flashback and returns the new origin","example":"newpos = self FlashbackStart( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon in the player loadout.","mandatory":true}]}]},{"name":"ForcePainOn","description":"toggles pain.forcePain to true; next damage reaction guarenteed","example":"ai ForcePainOn()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"FXBlockSight","description":"Uses a general entity and a radius to set a line of sight blocker on the server for some AI. Destroyed when the entity is freed.","example":"FXBlockSight( fxent, 64 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"the entity to use for the origin for tje line of sight blocker","mandatory":true},{"name":"radius","description":"the radius of the 'smoke screen' blocker","mandatory":true}]}]},{"name":"GadgetActivate","description":"turns gadget on in slot.","example":"self GadgetActivate( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to activate. (integer)","mandatory":true},{"name":"weapon","description":"The gadget weapon","mandatory":true}]}]},{"name":"GadgetCharging","description":"Sets the gadget charging state.","example":"self GadgetCharging( slot, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot. (integer)","mandatory":true},{"name":"value","description":"undefined to get current state, true to set or false to unset. (boolean)","mandatory":false}]}]},{"name":"GadgetDeactivate","description":"turns gadget off in slot.","example":"self GadgetDeactivate( slot, weapon, GADGET_OFF_PENALTY_SHUT_OFF )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to deactivate. (integer)","mandatory":true},{"name":"weapon","description":"The gadget weapon","mandatory":true},{"name":"penalty","description":"The power penalty type","mandatory":false}]}]},{"name":"GadgetFlickering","description":"Tests a gadget is flickering and can optionally set flickering.","example":"self GadgetFlickering( slot, true, 200 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test or apply flickering state. (integer)","mandatory":true},{"name":"flicker","description":"Set gadget to flickering state if true (boolean)","mandatory":false},{"name":"length","description":"Set gadget flickering length (integer)","mandatory":false}]}]},{"name":"GadgetGetSlot","description":"Get gadget slot for weapon.","example":"self GadgetGetSlot( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon in the player loadout.","mandatory":true}]}]},{"name":"GadgetIsActive","description":"Returns true if the gadget is active.","example":"self GadgetIsActive( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test. (integer)","mandatory":true}]}]},{"name":"GadgetIsPrimed","description":"Returns true if the gadget is primed.","example":"self GadgetIsPrimed( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test. (integer)","mandatory":true}]}]},{"name":"GadgetIsReady","description":"Returns true if the gadget is ready.","example":"self GadgetIsReady( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to test. (integer)","mandatory":true}]}]},{"name":"GadgetPowerChange","description":"Applies a power change to the gadget power.","example":"self GadgetPowerChange( slot, -20 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot apply the power change. (integer)","mandatory":true},{"name":"change","description":"The amount to change the power by. (float)","mandatory":true}]}]},{"name":"GadgetPowerGet","description":"Gets the power remaining for gadget.","example":"power = self GadgetPowerGet( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot (integer)","mandatory":true}]}]},{"name":"GadgetPowerReset","description":"Applies a power reset.","example":"self GadgetPowerReset( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot apply the power reset. (integer)","mandatory":true}]}]},{"name":"GadgetPowerSet","description":"Sets the power override to value. Works always.","example":"self GadgetPowerSet( slot, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot apply the power change. (integer)","mandatory":true},{"name":"value","description":"The amount to set power to. (float)","mandatory":true}]}]},{"name":"GadgetSetActivateTime","description":"Set the activation time of this gadget.","example":"self GadgetSetActivateTime( slot, time )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot. (integer)","mandatory":true},{"name":"time","description":"The activation time. (integer)","mandatory":true}]}]},{"name":"GadgetSetEntity","description":"Set the entity used by this gadget.","example":"self GadgetSetEntity( slot, ent )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot.","mandatory":true},{"name":"entity","description":"The entity used by the gadget.","mandatory":true}]}]},{"name":"GadgetStateChange","description":"changes the gadget state in a slot.","example":"self GadgetStateChange( slot )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"slot","description":"The gadget slot to activate. (integer)","mandatory":true},{"name":"weapon","description":"The gadget weapon","mandatory":true},{"name":"state","description":"The state to change it to","mandatory":true}]}]},{"name":"GadgetTargetResult","description":null,"example":"GadgetTargetResult(true)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"hit_miss","description":"hit or miss","mandatory":true}]}]},{"name":"GameModeIsMode","description":"Returns true/false if the current game mode is the given mode","example":"if ( GameModeIsMode( level.GAMEMODE_WAGER_MATCH ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gamemode","description":"(int)","mandatory":true}]}]},{"name":"GeneratePointsAroundCenter","description":"generate uniformly distributed points around a center in 2D (XY) plane","example":"array = GeneratePointsAroundCenter( enemy.origin, 500, 80, 100, 40, (-0.3,0,0) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Position to start the search around.","mandatory":true},{"name":"maxSearchRadius","description":"the maximum radius away from origin.","mandatory":true},{"name":"innerSpacing","description":"the distance between points at the minRadius.","mandatory":true},{"name":"minRadius","description":"the minimum radius away from origin. should be between 0 and maxRadius (both inclusive).","mandatory":false},{"name":"outerSpacing","description":"if defined, the distance between points will be Lerped from to [outerSpacing], to create a gradual distribution from minRadius to maxRadius.","mandatory":false},{"name":"distributionBias","description":"(vec2) if defined, the density of the points will be changed gradually along the direction of this vector. the magnitude will be use as scalar, with 1 being the norm scale.","mandatory":false}]}]},{"name":"GenerateScriptEvent","description":"Creates a script event at the actor's origin, with default radius","example":"self GenerateScriptEvent()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"Source position of the event.","mandatory":false},{"name":"radius","description":"Size of the event.","mandatory":false},{"name":"name","description":"Name of the event.","mandatory":false}]}]},{"name":"GetAbsMaxs","description":"Get absolute maximum bounds of the entity in world space.","example":"absMaxs = wallModel GetAbsMaxs()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAbsMins","description":"Get absolute minimum bounds of the entity in world space.","example":"absMins = wallModel GetAbsMins()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetActorArray","description":"Returns an array of the human AI","example":"aiarray = GetActorArray( \"ralph\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetActorSpawnerArray","description":"Returns an array of all of the actor spawners in a level.","example":"spawners = GetSpawnerArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetActorSpawnerTeamArray","description":"Returns an array of all of the spawners in a level","example":"enemies = GetActorSpawnerTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetActorTeamArray","description":"Returns an array of the human AI","example":"aiarray = GetActorTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetActorTeamCountRadius","description":"Returns number of human actor AI within a sphere on a given set of teams","example":"nearbyOthersCount = GetActorTeamCountRadius( self.origin, 500, \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Center of sphere","mandatory":true},{"name":"radius","description":"Radius of sphere","mandatory":true},{"name":"team","description":"any number of team names may be added, either 'axis', 'allies', or 'neutral' (no team implies all teams)","mandatory":false}]}]},{"name":"GetActorWeaponOptions","description":"Return's the actors current weapon options, ex: weapon camo option.","example":"self GetActorWeaponOptions()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAIArchetypeArray","description":"Returns an array of the AI for the given archetype and optionally given team","example":"aiarray = GetAIArchetypeArray( \"human\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', 'neutral', or 'all'. Defaults to 'all'.","mandatory":false}]}]},{"name":"GetAIArray","description":"Returns an array of the human AI","example":"aiarray = GetAIArray( \"my_ai\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetAICount","description":"Returns the current ai count.","example":"aicount = GetAICount()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAILimit","description":"Returns the max ai count set by script.","example":"ailimit = GetAILimit()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAimAngles","description":"Returns an array with the angles of the aimTag and the relative aiming delta angles from this orientation.","example":"aim_angles = ent GetAimAngles( shootPos, \"tag_aim\", (0, 30, 0), (15, 10, 0), (60, 60, 0), (5, 5, 0), 11 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{},{},{},{},{},{},{}]}]},{"name":"GetAISpeciesArray","description":"Returns an array of the AI","example":"aiarray = GetAISpeciesArray( \"axis\", \"all\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', 'neutral', or 'all'. Defaults to 'all'.","mandatory":false},{"name":"species","description":"species of AI to get, 'human', 'dog', 'robot' or 'all'. Defaults to 'human'.","mandatory":false}]}]},{"name":"GetAITeamArray","description":"Returns an array of the human AI and vehicle AI","example":"aiarray = GetAITeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetAITriggerFlags","description":"Returns the spawn flags that will allow AI to activate triggers","example":"spawn(\"trigger_radius\", (0,0,0), GetAITriggerFlags())","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAllCharacterBodies","description":"Returns all character indices, even disabled ones, for the current session mode (or specified session mode)","example":"heroIndices = GetAllCharacterBodies()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sessionMode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetAllCharacterHeads","description":"Returns all character indices, even disabled ones, for the current session mode (or specified session mode)","example":"heroIndices = GetAllCharacterHeads()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetAllNodes","description":"Gets all of the nodes in a level","example":"nodes = GetAllNodes()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAmmoCount","description":"Returns the count of ammo left","example":"n_ammo = self GetAmmoCount( w_weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon for which we need ammo count","mandatory":true}]}]},{"name":"GetAngleDelta","description":"Get the angle delta of the animation","example":"angleDelta = getAngleDelta( arrivalAnim, 0, normalizedLength )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation name","description":"Name of the animation","mandatory":true},{"name":"start time","description":"Start time of the animation","mandatory":false},{"name":"end time","description":"End time of the animation","mandatory":false}]}]},{"name":"GetAngleFromBits","description":"Gets the angle (0 - 360) from the (compressed) bits","example":"yaw = GetAngleFromBits( bits, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAngles","description":"Get the rotation of the entity","example":"angles = self GetAngles()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAnimForCharacter","description":"Returns the name of the animation to use for the character pose in the frontend","example":"frontendVignetteAnim = GetAnimForCharacter( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetAnimFrameCount","description":"Get total number of frames for the given animation.","example":"FrameNum = GetAnimFrameCount(climbAnim)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"a primitive animation: calling this function on a non-primitive animation will fail","mandatory":true}]}]},{"name":"GetAnimLength","description":"Gets the length of an animation","example":"cycleTime = GetAnimLength( climbAnim )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"a primitive animation: calling this function on a non-primitive animation will fail","mandatory":true}]}]},{"name":"GetAnimTagOrigin","description":"Returns the local tag position within the animation at the specified normalized time, has no consideration to bone hierarchy.","example":"tagPosition = GetAnimTagOrigin( arrivalAnim, 0, \"tag_sync\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation name","description":"Name of the animation.","mandatory":true},{"name":"normalized time","description":"0.0 to 1.0 time within the animation.","mandatory":true},{"name":"tag name","description":"Name of the tag to look up within the animation.","mandatory":true}]}]},{"name":"GetAnimTime","description":"Get the normalized animation time for the given animation.","example":"if ( (self GetAnimTime( %walk_and_run_loops ) ) < 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"animation to manipulate","mandatory":true}]}]},{"name":"GetAnyNodeArray","description":"Gets an array of nodes within given radius","example":"node = GetCoverNodeArray( self.origin, 256 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"search origin","mandatory":true},{"name":"radius","description":"radius to search within","mandatory":true}]}]},{"name":"GetArchetypeFromClassname","description":"Given classname, returns archetype name if its an AITYPE or VEHICLE.","example":"GetArchetypeFromClassname(\"spawner_enemy_54i_human_sniper_sniperrifle\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAssignedTeam","description":"returns the player's team as assigned by matchmaking. 0 = No Team, 1 = OpFor, 2 = Allies, 3 = Spectator.","example":"team = GetAssignedTeam( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player","mandatory":true}]}]},{"name":"GetAssignedTeamName","description":"returns the player's team as assigned by matchmaking. 0 = No Team, 1 = OpFor, 2 = Allies, 3 = Spectator.","example":"team = GetAssignedTeam( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player","mandatory":true}]}]},{"name":"GetAtrLoaded","description":"return an array of anim tree name loaded onto the server.","example":"trees = GetAtrLoaded()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAttachIgnoreCollision","description":"Returns the ignore collision flag of the attached model at the given attachment slot","example":"model_ignore_collision = self GetAttachIgnoreCollision( index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelindex","description":"The index of the model attached to the entity, starting at 0, so for instance 3 will get the fourth model attached. (integer)","mandatory":true}]}]},{"name":"GetAttachmentCosmeticVariantForWeapon","description":"Get the AttachmentCosmeticVariantIndexes data to be passed in to GetWeapon","example":"acvi = self GetAttachmentCosmeticVariantForWeapon( class_num, \"primary\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot (primary or secondary)","mandatory":true}]}]},{"name":"GetAttachmentCosmeticVariantIndexes","description":"Get the AttachmentCosmeticVariantIndexes data to be passed in to GetWeapon","example":"GetAttachmentCosmeticVariantIndexes( \"mp7_mp\", \"acog\", 2, \"grip\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponname","description":"the name of the base weapon to return","mandatory":true},{"name":"attachmentname_1","description":"the name of the first attachment","mandatory":false},{"name":"variantindex_1","description":"the index of the cosmetic variant to use for the first attachment","mandatory":false},{"name":"attachmentname_2","description":"the name of the second attachment","mandatory":false},{"name":"variantindex_2","description":"the index of the cosmetic variant to use for the second attachment","mandatory":false},{"name":"attachmentname_3","description":"the name of the third attachment","mandatory":false},{"name":"variantindex_3","description":"the index of the cosmetic variant to use for the third attachment","mandatory":false},{"name":"attachmentname_4","description":"the name of the fourth attachment","mandatory":false},{"name":"variantindex_4","description":"the index of the cosmetic variant to use for the fourth attachment","mandatory":false},{"name":"attachmentname_5","description":"the name of the fifth attachment","mandatory":false},{"name":"variantindex_5","description":"the index of the cosmetic variant to use for the fifth attachment","mandatory":false},{"name":"attachmentname_6","description":"the name of the sixth attachment","mandatory":false},{"name":"variantindex_6","description":"the index of the cosmetic variant to use for the sixth attachment","mandatory":false},{"name":"attachmentname_7","description":"the name of the seventh attachment","mandatory":false},{"name":"variantindex_7","description":"the index of the cosmetic variant to use for the seventh attachment","mandatory":false},{"name":"attachmentname_8","description":"the name of the eighth attachment","mandatory":false},{"name":"variantindex_8","description":"the index of the cosmetic variant to use for the eighth attachment","mandatory":false}]}]},{"name":"GetAttachmentNames","description":"Returns array containing the names for each type of attachment.","example":"attachmentNames = GetAttachmentNames()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAttachModelName","description":"Returns the name of the attached model at the given attachment slot","example":"model_name = self GetAttachModelName( index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelindex","description":"The index of the model attached to the entity, starting at 0, so for instance 3 will get the fourth model attached. (integer)","mandatory":true}]}]},{"name":"GetAttachSize","description":"Returns the number of attached models for this entity.","example":"size = self GetAttachSize()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetAttachTagName","description":"Returns the tagname of the attached model at the given attachment slot","example":"tag_name = self GetAttachTagName( index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"modelindex","description":"The index of the model attached to the entity, starting at 0, so for instance 3 will get the fourth model attached. (integer)","mandatory":true}]}]},{"name":"GetBaseWeaponItemIndex","description":"Returns the base weapon item index from the statstable","example":"baseWeaponName = GetBaseWeaponItemIndex( \"m16_acog_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"full weapon name e.g. m16_acog_mp.","mandatory":true}]}]},{"name":"GetBestInfluencepos","description":"returns the influence map position for ai, this is custom logic to return the closest posistion between the passed in thresholds","example":"dir = self GetBestInfluencePos( index, low, high)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"index","description":"which influence map to use","mandatory":true},{"name":"low","description":"the low threshold value to check against","mandatory":true},{"name":"high","description":"the high threshold value to check against","mandatory":true}]}]},{"name":"GetBestSpawnPoint","description":"Returns a sorted array of spawnpoints in order from best to worst for the given team","example":"GetSortedSpawnPoints()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point team","description":"Team that we need the points for","mandatory":true},{"name":"influencer team","description":"Influencer teams to compare the points against","mandatory":true},{"name":"vis team","description":"Team mask to use for enemy vis tests","mandatory":true},{"name":"player","description":"Player that we want the points for. The first parameter will still be used for the team.","mandatory":false},{"name":"predictedSpawn","description":"true if this is a predicted spawn request (used by texture streaming).","mandatory":false},{"name":"array of lists","description":"if provided, the spawn point will be chosen from one of these lists. If a list is disabled already for a given team, it will not be considered.","mandatory":false}]}]},{"name":"GetBitsForAngle","description":"Gets the compressed bits for an angle with granularity","example":"bits = GetBitsForAngle( angle, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetBrushModelCenter","description":"Get the center of the Brush Model entity","example":"center = GetBrushModelCenter( self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The brush model entity","mandatory":true}]}]},{"name":"GetBuildKitAttachmentCosmeticVariantIndexes","description":"Get attachment cosmetic variant indexes for the weapon from the player's build kit","example":"acvi = self GetBuildKitAttachmentCosmeticVariantIndexes( ar_standard )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"weapon object","mandatory":true},{"name":"upgraded","description":"bool whether this should be the upgraded version. If so extclip and fmj will be added","mandatory":false}]}]},{"name":"GetBuildKitWeapon","description":"Get weapon object (including attachments) for the weapon from the player's build kit","example":"weapon = self GetBuildKitWeapon( ar_standard )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"weapon object","mandatory":true},{"name":"upgraded","description":"bool whether this should be the upgraded version. If so extclip and fmj will be added","mandatory":false}]}]},{"name":"GetBuildKitWeaponOptions","description":"Get weapon options for the weapon from the player's build kit","example":"weapon_options = self GetBuildKitWeaponOptions( ar_standard, packapunch_camo_index )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"weapon object","mandatory":true},{"name":"camo_index","description":"camo index to override the one from the build kit, typically a packapunch camo index","mandatory":false}]}]},{"name":"GetCamAnimTime","description":"Gets the duration of an xcam in milliseconds.","example":"GetCamAnimTime( \"proto_melee_cam\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cam_anim","description":"The animation to play","mandatory":true}]}]},{"name":"GetCentroid","description":"Gets the centroid of an entity","example":"centroid = self GetCentroid()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetCharacterAssetName","description":"Returns the asset name for a character for the current session mode","example":"heroName = GetCharacterAssetName( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterBodyModelColorCount","description":"Returns the body model count for a character for the current session mode","example":"heroBodyModelCount = GetCharacterBodyModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"bodyStyleIndex","description":"The index of the body style in the character","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterBodyModelCount","description":"Returns the body model count for a character for the current session mode","example":"heroBodyModelCount = GetCharacterBodyModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionMode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterBodyStyleIndex","description":"Returns the index of the body style designated by the given display name","example":"bodyStyleIndex = GetCharacterBodyStyleIndex( true, \"Technomancer\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gender","description":"Whether or not to use the male bodytype","mandatory":true},{"name":"bodyStyleDisplayName","description":"The name of the body style","mandatory":true}]}]},{"name":"GetCharacterDisplayName","description":"Returns the display name for a character for the current session mode","example":"heroName = GetCharacterDisplayName( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterFields","description":"Returns info for the character pose playerbodytype","example":"heroFields = GetCharacterFields( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterHeadRenderOptions","description":"Calculates the packed helmet render option - to be passed to SetBodyRenderOptions()","example":"helmetRenderOptions = GetCharacterHeadRenderOptions( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"headIndex","description":"The index of the character in the current game-mode's character table","mandatory":true}]}]},{"name":"GetCharacterHelmetHidesHead","description":"Returns whether or not the characters head should be hidden based on the helmet","example":"hideHead = GetCharacterHelmetHidesHead( 0, 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"helmetIndex","description":"The index of the helmet belonging to that character","mandatory":true},{"name":"sessionMode","description":"The session mode ( mp cp zm )","mandatory":true}]}]},{"name":"GetCharacterHelmetModelColorCount","description":"Returns the helmet model count for a character for the current session mode","example":"heroHelmetModelCount = GetCharacterHelmetModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"helmetStyleIndex","description":"The index of the helmet style in the character","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterHelmetModelCount","description":"Returns the helmet model count for a character for the current session mode","example":"heroHelmetModelCount = GetCharacterHelmetModelCount( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetCharacterHelmetRenderOptions","description":"Calculates the packed helmet render option - to be passed to SetBodyRenderOptions()","example":"helmetRenderOptions = GetCharacterHelmetRenderOptions( 0, 1, 1, 2, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"helmetIndex","description":"The index of the helmet belonging to that character","mandatory":true},{"name":"colorIndex1","description":"The index of accent color 1","mandatory":true},{"name":"colorIndex2","description":"The index of accent color 2","mandatory":true},{"name":"colorIndex3","description":"The index of accent color 3","mandatory":true}]}]},{"name":"GetCharacterModeRenderOptions","description":"Calculates the packed mode render option - to be passed to SetBodyRenderOptions()","example":"modeRenderOptions = GetCharacterModeRenderOptions( SESSIONMODE_MULTIPLAYER )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"session_mode","description":"Session Mode enum index","mandatory":true}]}]},{"name":"GetClassIndexFromName","description":"Gets the index in a particular class","example":"GScr_GetClassIndexFromName( \"CLASS_SMG\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetClientFieldVersion","description":"Returns the version of the specifiec client field, in the specified client field set - or 0 if the field isn't registered.","example":"if(GetClientFieldVersion( \"world\", \"fog_volume_active\" ))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetClosestPointOnNavMesh","description":"Get a point on NavMesh that's closest to the given position within radius. Returns the adjusted position if found one, or undefined if not found. If distFromBoundary is defined, the point found on NavMesh will then be moved again to get it away from boundary","example":"posOnNavMesh = GetClosestPointOnNavMesh( (10,20,30), 25, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to start the search around.","mandatory":true},{"name":"searchRadius","description":"Radius to search within. If not provided, a default value proximately equal to player size will be used.","mandatory":false},{"name":"distFromBoundary","description":"Distance to keep away from NavMesh boundary. This distance can NOT be guaranteed. If not provided, it will be treated as 15 (AI default radius).","mandatory":false},{"name":"materialFlags","description":"the flags marking whether a face type can be used","mandatory":false}]}]},{"name":"GetClosestPointOnNavVolume","description":"Get a point on nav volume that's closest to the given position within radius. Returns the adjusted position if found one, or undefined if not found.","example":"posOnNavVolume = self GetClosestPointOnNavVolume( (10,20,30), 25 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"flying_ai","description":null},"parameters":[{"name":"position","description":"Position to start the search around.","mandatory":true},{"name":"searchRadius","description":"Radius to search within. If not provided, a default value proximately equal to player size will be used.","mandatory":false}]}]},{"name":"GetContractName","description":"Gets the name of the specified contract","example":"contractName = GetContractName( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"Contract ID","mandatory":true}]}]},{"name":"GetContractRequiredCount","description":"Gets the required count for the specified contract","example":"contractName = GetContractRequiredCount( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"Contract ID","mandatory":true}]}]},{"name":"GetContractRequirements","description":"Returns an array of contract requirements. Each requirement takes up two indices, 'reqType' and 'reqData'.","example":"mapNames = GetContractRequirements( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"The index of the contract","mandatory":true}]}]},{"name":"GetContractResetConditions","description":"Gets the reset conditions of the specified contract","example":"resetConditions = GetContractResetConditions( contractIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"contractIndex","description":"Contract ID","mandatory":true}]}]},{"name":"GetControllerType","description":"returns the controller type of the player","example":"player GetControllerType()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetCorpseAnim","description":"Get the animation that the corpse will play","example":"deathAnim = self GetCorpseAnim()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCorpseArray","description":"Returns an array of all of the items in a level.","example":"origins = GetCorpseArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetCounterTotal","description":"Gets the counter count for the given counter","example":"count = GetCounterTotal( \"global_comebacks\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"counterType","description":"The counter type","mandatory":true}]}]},{"name":"GetCoverNodeArray","description":"Gets an array of cover nodes within given radius","example":"node = GetCoverNodeArray( self.origin, 256 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"search origin","mandatory":true},{"name":"radius","description":"radius to search within","mandatory":true}]}]},{"name":"GetCrateHeadObjective","description":"Returns the equipment head objective as described in the grenadeweapon gdt.","example":"crateObjective = GetCrateHeadObjective( uav )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetCurrentEventId","description":"Gets the id from the current event.","example":"eventId = self GetCurrentEventId()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventName","description":"Gets the name of the current event.","example":"eventId = self GetCurrentEventName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventOriginator","description":"Gets the originator from the current event if any","example":"target = self GetCurrentEventOriginator()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventType","description":"Gets the type from the current event.","example":"type = self GetCurrentEventType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentEventTypeName","description":"Gets the type string name from the current event.","example":"type = self GetCurrentEventTypeName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetCurrentGunRank","description":"Get the gun current rank","example":"rank - GetCurrentGunRank(0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"index","description":"the index of the gun to get","mandatory":true}]}]},{"name":"GetCustomTeamName","description":"Get the team name","example":"name = GetCustomTeamName( teamid )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"teamid","description":"TeamID","mandatory":true}]}]},{"name":"GetCyberComAbilityName","description":"Gets the cybercom ability name given the flag, type","example":"GetCyberComAbilityName( flag, type )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"flag field","mandatory":true}]}]},{"name":"GetCyberComWeapon","description":"Gets the cybercom gadget weapon given the flag, type, and if upgraded","example":"GetCyberComWeapon( flag, type, upgraded )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"flag field","mandatory":true},{"name":"type","description":"type of weapon","mandatory":true},{"name":"upgraded","description":"true if the weapon is upgraded","mandatory":true}]}]},{"name":"GetDamageableEntArray","description":"Returns the entities that can be damaged. Can optionally take an origin, radius, and a flag to check 3D.","example":"entities = GetDamageableEntArray( maxDist, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"origin to check against","mandatory":false},{"name":"radius","description":"max distance to origin","mandatory":false},{"name":"checkZ","description":"if true then check distance in 3d","mandatory":false}]}]},{"name":"GetDebugEye","description":"Gets the debug position of the eye for an AI or Player","example":"eyePos = player GetDebugEye()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player or actor","description":null},"parameters":[]}]},{"name":"GetDecorations","description":"Gets an array of booleans that represents all the decorations the player has earned","example":"medals = e_player GetDecorationsEarned()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":" only_decorations_earned ","description":"Only get the decorations that the player has earned","mandatory":false}]}]},{"name":"GetDefaultClassSlot","description":"Gets the item in a particular default class slot","example":"GetDefaultClassSlot( \"cqb\", \"primary\" ); // Returns primary weapon reference","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"classname","description":"the classname of the item","mandatory":true},{"name":"slotname","description":"The slot to check","mandatory":true}]}]},{"name":"GetDroppedWeapons","description":"Returns an array containing all the dropped weapons in the level","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetEnemies","description":"Returns an array of enemies.","example":"enemies = self GetEnemies()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEnt","description":"Looks up entities by key and name","example":"spawner = GetEnt( \"doorguy1\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true},{"name":"ignore spawners","description":"if true then you won't get a spawner back","mandatory":false}]}]},{"name":"GetEntArray","description":"Looks up entities by key and name and a return an array of the matched entities","example":"spawners = GetEntArray( \"doorguy1\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":false},{"name":"key","description":"key that name goes with","mandatory":false},{"name":"ignore spawners","description":"if true then you won't get a spawner back","mandatory":false}]}]},{"name":"GetEntArrayFromArray","description":"Searches given array entities by key and name and a return an array of the matched entities","example":"spawners = GetEntArrayFromArray( array, \"doorguy1\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array of entities","mandatory":true},{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true}]}]},{"name":"GetEntByNum","description":"Gets an entity from its entity number","example":"entity = GetEntByNum( entnum )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity number","description":"(integer) The number of the entity to get","mandatory":true}]}]},{"name":"getEnterButton","description":"Gets the enter button.","example":"getEnterButton()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetEntityAnimRate","description":"get the entity animation rate - ZOMBIES ONLY","example":"rate = self GetEntityAnimRate()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEntityNumber","description":"Get the entity number of the entity","example":"hitEntNum = hitEnt getEntityNumber()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEntityType","description":"Get the type of entity","example":"inflictorEntType = grenade getEntityType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEntNavMaterial","description":"get NavMesh material at where the entity stands","example":"material = GetEntNavMaterial( ai_actor )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"ai_or_vehicle","description":"An AI character or an AI vehicle","mandatory":true}]}]},{"name":"GetEntNum","description":"Get the entity number for this entity","example":"self GetEntNum()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEquipmentHeadObjective","description":"Returns the equipment head objective as described in the grenadeweapon gdt.","example":"headObjective = GetEquipmentHeadObjective( bouncingbettty )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetEventPointOfInterest","description":"Gets the point of interest from the current event.","example":"point = self GetEventPointOfInterest()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetEye","description":"Get the eye position of the entity.","example":"eye_pos = self GetEye()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetEyeApprox","description":"Get the eye position of the entity with some added offset.","example":"approx_eye_pos = self GetEyeGetEyeApprox()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetFirstTouchFraction","description":"Returns the trace fraction of a capsule trace against the other entity","example":"fraction = GetFirstTouchFraction( player, trigger, old_origin, current_origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other entity","description":"Entity to check against","mandatory":true},{"name":"start","description":"Starting point of the trace","mandatory":true},{"name":"end","description":"Ending point of the trace","mandatory":true}]}]},{"name":"GetFlowGraphDef","description":"returns a struct representing the flow graph definition asset","example":"flowGraphDef = GetFlowGraphDef( \"my_flow_graph\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The name of the flow graph asset","mandatory":true}]}]},{"name":"GetFogSettings","description":"Get the current fog settings as an array.","example":"fogsettings = getfogsettings()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetFreeActorCount","description":"Get number of free actors.","example":"GetFreeActorCount()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetFreerunTrackIndex","description":"Returns the unique id for this mission","example":"level.index = GetFreerunTrackIndex( \"mp_Freerun_01\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetGameTypeEnumFromName","description":"Returns the enum value corresponding to the current game type from global leaderboard gametype entries.","example":"gameTypeEnum = GetGameTypeEnumFromName( \"tdm\", false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gameTypeName","description":"game type name e.g. \"tdm\".","mandatory":true},{"name":"isHardcore","description":"True if the hardcore mode is on","mandatory":true}]}]},{"name":"GetGametypeSetting","description":"Gets the value of a gametype setting.","example":"GetGametypeSetting( \"scoreLimit\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"setting","description":"The setting name as a string.","mandatory":true}]}]},{"name":"GetGrappleTargetArray","description":"Returns an array of all of the grapple targets","example":"enemies = GetGrappleTargetArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetGroundEnt","description":"Gets the entity beneath the calling entity","example":"ground_ent = self GetGroundEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetInfluenceAt","description":"Returns the influence value at the origin position on the influence map, undefined if no value can be found.","example":"GetInfluenceAt(influenceMapIndex, origin)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influenceMapIndex","description":"Index of the influence map","mandatory":true},{"name":"origin","description":"The location to check for influence value","mandatory":true}]}]},{"name":"GetInfluenceFacePos","description":"Returns the faces pos on the influence map","example":"pos = GetInfluenceFacePos( faceIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetInfluenceNumFaces","description":"Returns the number faces on the influence","example":"numFaces = GetInfluenceNumFaces()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetInfluencerPreset","description":"Adds a new influencer of at and ","example":"preset_array = GetInfluencerPreset( name )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"valid spawn influencer preset name.","mandatory":true}]}]},{"name":"GetInfluencerTimeoutRemaining","description":"Gets the remaining influencer timeout in milliseconds. Returns a negative number if no timeout.","example":"GetInfluencerTimeout( influencer_id )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer id","mandatory":true}]}]},{"name":"GetInterestPoolAwareness","description":"Gets the current interest pool awareness level regardless of actual awareness level.","example":"interestAwareness = self GetInterestPoolAwareness()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[]}]},{"name":"GetInterestPoolValue","description":"Gets the sentient's interest pool value.","example":"value = self GetInterestPoolValue()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"GetItemArray","description":"Returns an array of all of the items in a level.","example":"origins = GetItemArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetItemAttachment","description":"Gets the attachment for a particular item","example":"GetItemAttachment( 10, 1 ); // returns attachment 1 for item 10","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"The item index","mandatory":true},{"name":"attachmentNum","description":"The attachment number for the index","mandatory":true}]}]},{"name":"GetItemAttachmentAllocationCost","description":"Gets the allocation cost of an attachment for a particular item","example":"GetItemAttachmentAllocationCost( 10, 1 ); // returns allocation cost of attachment 1 for item 10","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"The item index","mandatory":true},{"name":"attachmentNum","description":"The attachment number for the index","mandatory":true}]}]},{"name":"GetItemGroupFromItemIndex","description":"Returns the ref for a specified item index","example":"ref = GetItemGroupFromItemIndex( itemIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"Item index","mandatory":true}]}]},{"name":"GetLastOutWaterTime","description":"Returns the last time the player was not completely submerged","example":"time = player GetLastOutWaterTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLightColor","description":"Gets the current color of the light, as an RGB vector.","example":"color = self GetLightColor()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightExponent","description":"Gets the current exponent of the light.","example":"exponent = self GetLightExponent()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightFovOuter","description":"Gets the current outer fov of a spot light.","example":"fov = self GetLightFovOuter()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightIntensity","description":"Gets the current intensity of the light.","example":"intensity = self GetLightIntensity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLightRadius","description":"Gets the current radius of the light.","example":"radius = self GetLightRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[]}]},{"name":"GetLinkedEnt","description":"Get the entity that the calling entity is linked to","example":"linked_ent = self GetLinkedEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetLoadoutAllocation","description":"Get how many allocation points are spent in the custom class","example":"allocationSpent = self GetLoadoutAllocation( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"GetLoadoutGunSmithVariantIndex","description":"Get the GunSmith Variant index of the primary weapon, pass 1 as an option to get the secondary","example":"gunSmithPrimaryIndex = self GetLoadoutGunSmithVariantIndex( 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"getSecondary","description":"defaults to false, if set will get you the variant index of the secondary","mandatory":false}]}]},{"name":"GetLoadoutItem","description":"Get the index of the item in the custom class","example":"primary = self GetLoadoutItem( 0, primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot","mandatory":true}]}]},{"name":"GetLoadoutItemRef","description":"Get the reference of the item in the custom class","example":"primary = self GetLoadoutItemRef( 0, primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot","mandatory":true}]}]},{"name":"GetLoadoutPerks","description":"Get the list of specialties in the custom class","example":"primary = self GetLoadoutPerks( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"GetLoadoutWeapon","description":"Get the full weapon name (including attachments) of the item in the custom class","example":"primary = self GetLoadoutWeapon( 0, primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true},{"name":"loadoutSlot","description":"Loadout Slot (primary or secondary)","mandatory":true}]}]},{"name":"GetLobbyClientCount","description":"Returns the number of connected or connecting clients","example":"clientCount = GetClientCount()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMapAtIndex","description":"Get the name of the map at the given index in a mode's maptable. Returns undefined if the given index doesn't index the given maptable","example":"GetMapAtIndex( \"cp_mi_sing_blackstation\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"index","description":"the index of the map you're looking for.","mandatory":true},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapFields","description":"Get the outro movie of the current map in the maptable. Returns undefined if currentmap wasn't found","example":"fields = GetMapFields( GetNextMap(\"cp_mi_sing_blackstation\") )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapIntroMovie","description":"Get the intro movie of the current map in the maptable. Returns undefined if currentmap wasn't found","example":"world.nextIntroMovie = GetMapIntroMovie( GetNextMap(\"cp_mi_sing_blackstation\") )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapOrder","description":"Get the index of the current map in the maptable. Returns -1 if currentmap wasn't found","example":"if( GetMapOrder( \"cp_mi_sing_blackstation\" ) > GetMapOrder( world.highestMapCompletion ) { world.highestMapCompletion = \"cp_mi_sing_blackstation\"; }","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMapOutroMovie","description":"Get the outro movie of the current map in the maptable. Returns undefined if currentmap wasn't found","example":"world.nextOutroMovie = GetMapIntroMovie( GetNextMap(\"cp_mi_sing_blackstation\") )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetMaxs","description":"Get maximum bounds of the entity","example":"maxs = wallModel GetMaxs()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetMaxVehicles","description":"Return the maximum number of vehicles that can be instantiated simultaneously. This is platform-specific.","example":"vehicleSlotsFree = GetMaxVehicles() - level.vehicles_list.size","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMeleeChainCount","description":"Gets the number of melee kills achieved by the player within their current streak.","example":"entity GetMeleeChainCount( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"getmicrosecondsraw","description":"Gets raw system microseconds; used for profiling, only gives lower 32 bits as script doesn't support uint64_t properly right now","example":"start_time = GetMicrosecondsRaw()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMillisecondsRaw","description":"Gets raw system milliseconds; use for profiling long routines as it is only an integer","example":"start_time = GetMillisecondsRaw()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetMins","description":"Get minimum bounds of the entity","example":"mins = wallModel GetMins()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetMissileOwner","description":"Returns the entity that owns this missile","example":"javelinOwner = GetMissileOwner( thisMissile )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[]}]},{"name":"GetMissionName","description":"Returns the name of the mission this map is part of","example":"level.mission = GetMissionName( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetMissionUniqueID","description":"Returns the unique id for this mission","example":"level.unique_id = GetMissionUniqueID( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetMissionVersion","description":"Returns the unique id for this mission","example":"level.unique_id = GetMissionVersion( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetMoveDelta","description":"Gets the move delta for the animation","example":"localDeltaVector = GetMoveDelta( animation, 0, 1, entity )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation name","description":"Name of the animation","mandatory":true},{"name":"start time","description":"Normalized start time of the animation","mandatory":false},{"name":"end time","description":"Normalized end time of the animation","mandatory":false},{"name":"entity","description":"The entity should be passed if the animation name is a string to look up the animation from the entity's anim tree","mandatory":false}]}]},{"name":"GetMoverEnt","description":"Gets the moving entity the player is sitting on .","example":"if(player GetMoverEnt())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetMoveSpeedScale","description":"Gets the speed scale multiplier for the entity","example":"speed_modifier = self GetMoveSpeedScale()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetNavMeshFaceNormal","description":"Returns the face normal vector of the closest navmesh point to the passed in position, within the search radius.","example":"navmeshNormal = GetNavMeshFaceNormal( (10,20,30), 25 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to start the search around.","mandatory":true},{"name":"searchRadius","description":"Radius to search within.","mandatory":true}]}]},{"name":"GetNavMeshTriggersForPoint","description":"Returns a list of the names of navmesh triggers that a given point resides in","example":"targetNames = GetNavMeshTriggersForPoint( pos )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"The test position.","mandatory":true}]}]},{"name":"GetNearestNode","description":"Returns the node nearest to this origin or undefined if no close node exists.","example":"node = GetNearestNode( guy.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"location to search for the nearest node","mandatory":true}]}]},{"name":"GetNearestPathPoint","description":"Returns the nearest point on the navmesh for the given origin and radius or undefined if no point can be found.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The point from which to search from","mandatory":true},{"name":"radius","description":"The maximum radius in which to search","mandatory":true}]}]},{"name":"GetNextMap","description":"Get the name of the next map in the maptable. Returns \"\" if this is the last map, undefined if currentmap wasn't found","example":"GetNextMap( \"cp_mi_sing_blackstation\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false},{"name":"dlcindex","description":"dlc1..N if DLC. If ommitted, use \"base\".","mandatory":false},{"name":"sessionmodeabbrev","description":"cp,mp,zm. If ommitted, use current game mode abbreviation","mandatory":false}]}]},{"name":"GetNextTraversalNodeOnPath","description":null,"example":"GetNextTraversalNodeOnPath(1)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"the index for the starting node","mandatory":true}]}]},{"name":"GetNode","description":"Gets a node with the given name, key pair","example":"node = GetNode( self.target, \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true}]}]},{"name":"GetNodeArray","description":"Gets an array of nodes that have the given name, key pair","example":"node = GetNodeArray( self.target, \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true}]}]},{"name":"GetNodeArraySorted","description":"Gets an array of nodes that have the given name, key pair, within given radius, sorts them","example":"nodes = GetNodeArraySorted(self.target, \"targetname\", self.origin, 256 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name to search for","mandatory":true},{"name":"key","description":"key that name goes with","mandatory":true},{"name":"pos","description":"search origin","mandatory":true},{"name":"r","description":"the radius to sort in","mandatory":true}]}]},{"name":"GetNodeEdge","description":"Returns an array of points which corresponds to the node volume's traversal edge. The traversal edge is represented as a piecewise linear function.","example":"points = GetNodeEdge( myNode )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"node volume","mandatory":true}]}]},{"name":"GetNodeIndexOnPath","description":null,"example":"GetNodeIndexOnPath(node)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to get the other node for","mandatory":true}]}]},{"name":"GetNodeOwner","description":"Get the owner of the node.","example":"node_owner = GetNodeOwner( node ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"which node to get the owner of.","mandatory":true}]}]},{"name":"GetNodeRegion","description":"Returns the region of the give node, if there is one. Returns undefined otherwise.","example":"if ( GetNodeRegion( myNode ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"pathnode to check","mandatory":true}]}]},{"name":"GetNodesInRadius","description":"Gets all of the nodes (max of 256) within a cylinder, in unsorted order","example":"nodes = GetNodesInRadius( guy.origin, 512, 0, 128, \"Path\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"location to search for nodes at","mandatory":true},{"name":"max radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"min radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"max height","description":"maximum height difference to origin. Defaults to 512","mandatory":false},{"name":"node type","description":"node type to search for, if not specified, returns all node types. 'Cover' will return all cover nodes","mandatory":false},{"name":"max nodes","description":"the maximum number of nodes to return up to 256","mandatory":false},{"name":"region index","description":"the region index the nodes should belong to","mandatory":false}]}]},{"name":"GetNodesInRadiusSorted","description":"Gets all of the nodes (max of 256) within a cylinder, sorted by closest to ","example":"nodes = GetNodesInRadiusSorted( guy.origin, 512, 0, 128, \"Path\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"location to search for nodes at","mandatory":true},{"name":"max radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"min radius","description":"maximum distance of nodes to return","mandatory":true},{"name":"max height","description":"maximum height difference to origin. Defaults to 512","mandatory":false},{"name":"node type","description":"node type to search for, if not specified, returns all node types. 'Cover' will return all cover nodes","mandatory":false},{"name":"max nodes","description":"the maximum number of nodes to return up to 256","mandatory":false}]}]},{"name":"GetNormalHealth","description":"Get health in a normalized range of 0 to 1","example":"normal_health = self GetNormalHealth()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetNorthYaw","description":"Get North Yaw","example":"northvector = (cos(getnorthyaw()), sin(getnorthyaw()), 0)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetNotetracksInDelta","description":"Get a list of notetracks and times within a specific time delta of a specific time in an animation","example":"notetrackArray = GetNotetracksInDelta( anim, 0.4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"the animation for which notetrack information is needed","mandatory":true},{"name":"time","description":"The time in the animation around which notetrack information is needed in the range 0-1","mandatory":true},{"name":"time_delta","description":"The amount of time around the time provided to check for notetracks in seconds defaults to 0.15","mandatory":false}]}]},{"name":"GetNotetrackTimes","description":"Gets an array of the times during an animation that the given notetrack occurs. The times returned are fractional (0 to 1).","example":"exitAlignTimes = GetNotetrackTimes( exitAnim, \"exit_align\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"an animation","mandatory":true},{"name":"note track","description":"a constant string with the name of the note track","mandatory":true}]}]},{"name":"GetNumberOfCollectiblesForLevel","description":"Returns the number of collectibles for the given level","example":"collectibleCount = GetNumberOfCollectiblesForLevel( GetRootMapName() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetNumChallengesComplete","description":"Returns the number of challenges completed in a given mission","example":"is_default = self GetNumChallengesComplete( \"angola\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"mission_name","description":"(string) The name of the mission to check completed challenges in","mandatory":true}]}]},{"name":"GetNumConnectedPlayers","description":"Returns the number of players that are connected to our game. Ignores bots by default.","example":"num_players_and_bots = GetNumConnectedPlayers( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"include bots","description":"The optional check to include test clients (bots). (bool)","mandatory":false}]}]},{"name":"GetNumExpectedPlayers","description":"Returns the number of players that we're expecting to join our game.","example":"num_players = GetNumExpectedPlayers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetNumParts","description":"Return number of bones in the model","example":"numParts = GetNumParts( model )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"model","description":"The model to get parts for","mandatory":true}]}]},{"name":"GetNumZBarrierPieces","description":"Returns number of pieces in specified zbarrier ent.","example":"numPieces = ent GetNumZBarrierPieces())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetOrigin","description":"Get the origin of the entity.","example":"origin = self GetOrigin()","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":{"name":"entity","description":"The entity to get the origin of.","type":{"dataType":"struct","instanceType":"entity","isArray":false}},"parameters":[],"returns":{"name":"origin","type":{"dataType":"vec3","instanceType":null,"isArray":false},"description":"The origin of the entity as a 3D vector."}}]},{"name":"GetOtherNodeInNegotiationPair","description":"Returns the other node of the passed in negotiation node. Returns the begin node if end is passed and vice versa.","example":"end_node = GetOtherNodeInNegotiationPair( begin_node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to get the other node for","mandatory":true}]}]},{"name":"GetPartName","description":"Get the bone name for the model and index","example":"boneName = GetPartName( model, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"model","description":"The model to get parts for","mandatory":true},{"name":"index","description":"The bone index","mandatory":true}]}]},{"name":"GetPathfindingRadius","description":"Returns the radius used for pathfinding operations.","example":"radius = ent GetPathfindingRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetPathMetric","description":"Get path metric for the path from the ai to origin","example":"path_metric = level.ai_for_pathing GetPathMetric( dropPos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"origin","description":"the goal for the path","mandatory":true}]}]},{"name":"GetPlayerGravity","description":"Gets the gravity or gravity override value for the player.","example":"player GetPlayerGravity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayers","description":"Returns an array of the currently connected players.","example":"players = GetPlayers()","flags":["verified"],"remarks":["When used without the team parameter, this function is analogous to the variable `level._players` and can be used interchangeably."],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"If specified, returns a list of players on a specific team. Valid values: `allies`, `axis`, `neutral`, and `all`.","mandatory":false,"type":{"dataType":"string"}}],"returns":{"name":"players","type":{"dataType":"struct","instanceType":"player","isArray":true},"description":"A list of connected players."}}]},{"name":"GetPlayerSelectedGestureName","description":"Get the equipped gesture animation name","example":"gesture = player GetPlayerSelectedGestureName( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"gestureType","description":"The type of gesture to get","mandatory":true}]}]},{"name":"GetPlayerSelectedTauntName","description":"Get the equipped taunt animation name","example":"taunt = player GetPlayerSelectedTauntName( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"tauntType","description":"The type of taunt to get","mandatory":true}]}]},{"name":"GetPlayerSpawnId","description":"Returns the current spawn id for the player (used for debugging purposes only)","example":"spawnId = GetPlayerSpawnId( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player that we are spawning in","mandatory":true}]}]},{"name":"GetPlayerSpeed","description":"Gets the speed value for the player.","example":"player GetPlayerSpeed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPointInBounds","description":"Returns a point within an entity's bounds.","example":"targetForwardPnt = helo GetPointInBounds( 1.0, 0.0, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"ratio_ForwardBack","description":"1.0 is full forward, -1.0 is full backwards.","mandatory":true},{"name":"ratio_LeftRight","description":"1.0 is full left, -1.0 is full right.","mandatory":true},{"name":"ratio_UpDown","description":"1.0 is full up, -1.0 is full down.","mandatory":true}]}]},{"name":"GetRandomCompatibleAttachmentsForWeapon","description":"Returns an array of compatible attachments. If num desired attachments are specified then that many attachments will be returned if possible","example":"GetRandomCompatibleAttachmentsForWeapon( weaponObject, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"The weapon name.","mandatory":true},{"name":"num desired attachments","description":"Max number of compatible attachments desired. If the number is more than available attachments for the weapon, it will just not return that many.","mandatory":false}]}]},{"name":"GetRandomPointOnNavVolume","description":"Get a random point on nav volume. Returns the position if found one, or undefined if not found.","example":"random = self GetRandomPointOnNavVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"flying_ai","description":null},"parameters":[]}]},{"name":"GetRefFromItemIndex","description":"Returns the ref for a specified item index","example":"ref = GetRefFromItemIndex( itemIndex )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemIndex","description":"Item index","mandatory":true}]}]},{"name":"GetReflectionLocs","description":"Gets array of the locations of all of the reflection_probes in the level","example":"reflection_locs = GetReflectionLocs()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetReflectionOrigin","description":"Given a position, returns the position of the reflection probe in use there","example":"probe_pos = GetReflectionOrigin( camera_pos )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetRetrievableWeapons","description":"Returns an array of weapons that need watchers so they can be retrieved by the player.","example":"retrievableWeapons = GetRetrievableWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetRootMapName","description":"Returns the root map of a mission","example":"level.rootMap = GetRootMapName( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"GetRoundsPlayed","description":"Get rounds played in match state","example":"GetRoundsPlayed( game[\"roundsplayed\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"The number of rounds played","mandatory":true}]}]},{"name":"GetScriptBundle","description":"Returns the script bundle struct.","example":"settings = GetScriptBundle( \"doorsettings\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptBundleList","description":"Returns the script bundle list array.","example":"settings = GetScriptBundleList( \"doorsettings\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptBundleNames","description":"Returns all the names of the script bundles of the specified type in an array.","example":"settings = GetScriptBundleNames( \"scene\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptBundles","description":"Returns a list of script bundles based on the type.","example":"settings = GetScriptBundles( \"scenes\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetScriptMoverArray","description":"Returns an array of all of the script_origins in a level.","example":"origins = GetScriptMoverArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetShootAtPos","description":"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":"targetPos = self.enemy GetShootAtPos(self)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"attacker","description":"The entity that will be shooting","mandatory":false}]}]},{"name":"GetSkiptoName","description":"Get the skip to name with the given index","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetSkipTos","description":"Get all skip tos for the level","example":"skiptos = GetSkipTos()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetSnapshotIndexArray","description":"Returns an array of the indices of current snapshots for all connected clients.","example":"snapindices = GetSnapshotIndexArray( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetSpawnerArray","description":"Returns an array of all of the spawners in a level.","example":"spawners = GetSpawnerArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetSpawnerTeamArray","description":"Returns an array of all of the spawners in a level","example":"enemies = GetSpawnerTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of additional team names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetSpawnStructForCharacter","description":"Returns the targetname of the script_struct to use for the character pose in the frontend","example":"frontendVignetteAnim = GetSpawnStructForCharacter( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetSpecialistIndex","description":"Returns the specialist index for the player","example":"specialistIndex = player GetSpecialistIndex()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetStance","description":"Gets the stance of the player. It only works for the player.","example":"stance = player GetStance()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetStartAngles","description":"Get the starting angles for an animation, in world coordinates, given its current position, and angles","example":"org1 = GetStartAngles( climborg, climbang, buddyanim1, [0.5] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The current origin of the animation in world coordinates","mandatory":true},{"name":"angle","description":"The current angle set of the animation in world coordinates","mandatory":true},{"name":"animation","description":"The currently running animation","mandatory":true},{"name":"animation time","description":"The animation time in 0-1 range","mandatory":false}]}]},{"name":"GetStartOrigin","description":"Get the starting origin for an animation, in world coordinates, given its current position, and angles","example":"org1 = GetStartOrigin( climborg, climbang, buddyanim1, [0.5] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The current origin of the animation in world coordinates","mandatory":true},{"name":"angle","description":"The current angle set of the animation in world coordinates","mandatory":true},{"name":"animation","description":"The currently running animation","mandatory":true},{"name":"animation time","description":"The starting animation time in 0-1 range","mandatory":false}]}]},{"name":"GetStartTime","description":"Returns the start time for the current round.","example":"GetStartTime()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetStowedWeapon","description":"Gets the stowed weapon for the player","example":"stowed = self GetStowedWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTagAngles","description":"Gets the angles of the tag","example":"angles = self GetTagAngles( \"tag\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTagOrigin","description":"Gets the origin of the tag","example":"origin = self GetTagOrigin( \"tag\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTargetEntity","description":"Gets the target entity of this turret or vehicle weapon","example":"target = roof_turret GetTargetEntity( ); target = tank GetTargetEntity( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"gunnerIndex","description":"the gunner index if called on a vehicle","mandatory":false}]}]},{"name":"GetTargetOrigin","description":"Gets the target origin of this turret or vehicle weapon","example":"origin = roof_turret GetTargetOrigin( ); origin = tank GetTargetOrigin( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"gunnerIndex","description":"the gunner index if called on a vehicle (integer)","mandatory":false}]}]},{"name":"GetTeam","description":"Return true if the team of an entity if it can be found, undefined otherwise.","example":"orig_team = self GetTeam()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTeamPlayersAlive","description":"Returns the number of players still alive on a given team","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"A string value, either 'axis' or 'allies' or 'team3'","mandatory":true}]}]},{"name":"GetTeamSatellite","description":"Gets whether a team has Satellite or not","example":"GetTeamSatellite( \"allies\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true}]}]},{"name":"GetTeamScore","description":"Get a team's score","example":"if ( GetTeamScore( \"allies\" ) > getTeamScore(\"axis\") ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true}]}]},{"name":"GetTeamSpyplane","description":"Gets whether a team has Spyplane or not","example":"GetTeamSpyplane( \"allies\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true}]}]},{"name":"GetTime","description":"Gets the level time in Milliseconds from the start of the level.","example":"nextNodeTime = GetTime() + 500","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetTotalServerPauseTime","description":"Gets the total time the server has been paused since the map started.","example":"val = GetTotalServerPauseTime()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"gettotalunlockedweaponattachments","description":"Get total number of attachments that are unlocked for the weapon specified","example":"player GetTotalUnlockedWeaponAttachements( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon","mandatory":true}]}]},{"name":"GetTouchingVolume","description":"Get the entities that are inside the bounds given","example":"entities = GetTouchingVolume( self.origin, mins, maxs )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Position of bounding box","mandatory":true},{"name":"mins","description":"The minimum extents of the bounding box","mandatory":true},{"name":"maxs","description":"The maximum extents of the bounding box","mandatory":true}]}]},{"name":"GetTriggerAccumulate","description":"Returns the accumulate value from the trigger","example":"self GetTriggerAccumulate()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"GetTurretArcLimits","description":"Return turret info for arc mins and maxs","example":"limits turret GetTurretArcLimits()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"GetTurretOwner","description":"Gets the \"owner\" of this turret","example":"turret_user = roof_turret GetTurretOwner()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"GetTurretTarget","description":"Gets the current target of this turret","example":"target = roof_turret GetTurretTarget()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"GetUpgradedPieceNumLives","description":"Returns the number of lives, or pull reps it should take a zombie to dislodge this piece, if it's upgraded.","example":"piece.numLives = ent GetUpgradedPieceNumLives(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetUTC","description":"Gets the UTC time.","example":"val = GetUTC()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetValidCoverPeekOuts","description":"Returns an array of directions an AI can peek out from a cover node. Possible values are 'over', 'left', and 'right'.","example":"GetValidCoverPeekOuts( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"pathnode","description":null},"parameters":[]}]},{"name":"GetVehicleArray","description":"Returns an array of all of the vehicles in a level","example":"enemies = GetVehicleArray( \"drones\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetVehicleSpawnerArray","description":"Returns an array of all of the vehicle spawners in a level","example":"enemies = GetVehicleSpawnerArray( \"bob\", \"targetname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Name to search for.","mandatory":false},{"name":"key","description":"The key to search for.","mandatory":false}]}]},{"name":"GetVehicleSpawnerTeamArray","description":"Returns an array of all of the vehicle spawners in a level with the specified team","example":"enemies = GetVehicleSpawnerTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"a team name, either 'axis', 'allies', or 'neutral'","mandatory":true},{"name":"team","description":"any number of teams names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetVehicleTeamArray","description":"Returns an array of all of the vehicles in a level that are not sentients","example":"enemies = GetVehicleTeamArray( \"axis\", \"neutral\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"any number of teams names may be added, either 'axis', 'allies', or 'neutral'","mandatory":false}]}]},{"name":"GetVehicleTriggerFlags","description":"Returns the spawn flags that will allow vehicles to activate triggers","example":"spawn(\"trigger_radius\", (0,0,0), GetVehicleTriggerFlags())","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetVelocity","description":"Returns the entity's velocity.","example":"vel = thing GetVelocity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"An entity.","mandatory":true}]}]},{"name":"GetVisibleNode","description":"Returns the farthest visible node on the path from to or undefined if no path exists.","example":"node = GetVisibleNode( guy.origin, enemy.origin, guy )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting origin of the path","mandatory":true},{"name":"end","description":"ending origin of the path","mandatory":true},{"name":"ignore entity","description":"An entity to ignore during pathnode trace checks","mandatory":false}]}]},{"name":"GetVisibleNodes","description":"Returns an array of nodes visible to this node","example":"nodes = GetVisibleNodes( cover.node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"pathnode to check","mandatory":true}]}]},{"name":"GetVrCamAngles","description":"Get the VR camera angles of the player","flags":["unlisted"],"overloads":[{"calledOn":null,"parameters":[]}],"verifiedInRevision":5},{"name":"GetVrCamPos","description":"Get the VR camera position of the player","flags":["unlisted"],"overloads":[{"calledOn":null,"parameters":[]}],"verifiedInRevision":5},{"name":"GetWallRunWallNormal","description":"Returns the normal of the wall the player is running on (or was running on)","example":"wall_normal = player GetWallRunWallNormal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetWatcherWeapons","description":"Returns array of weapons that need watchers so they will die when the player respawns","example":"watcherWeapons = GetWatcherWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetWaterHeight","description":"Returns the height of the water at this position","example":"height = getwaterheight( self.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pos","description":"Query position","mandatory":true}]}]},{"name":"GetWeapon","description":"Get the requested weapon object based on game mode agnostic weapon name string.","overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the base weapon to return.","type":{"dataType":"string"},"mandatory":true},{"name":"attachmentName1","description":"The first attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName2","description":"The second attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName3","description":"The third attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName4","description":"The fourth attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName5","description":"The fifth attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false},{"name":"attachmentName6","description":"The sixth attachment name for the weapon.","type":{"dataType":"string","isArray":false},"mandatory":false}],"returns":{"name":"weaponObject","type":{"dataType":"struct","instanceType":"weapon","isArray":false},"description":"The requested weapon object with the specified attachments."}},{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the base weapon to return.","type":{"dataType":"string"},"mandatory":true},{"name":"attachmentNames","description":"An array of attachment names to return.","type":{"dataType":"string","isArray":true},"mandatory":false}],"returns":{"name":"weaponObject","type":{"dataType":"struct","instanceType":"weapon","isArray":false},"description":"The requested weapon object with the specified attachments."}}],"example":"GetWeapon(\"ar_standard\", \"acog\")","flags":["verified"],"verifiedInRevision":3},{"name":"GetWeaponAccuracy","description":"Returns accuracy at the distance from the current enemy.","example":"getweaponaccuracy( self, \"ak47\" ), getweaponaccuracy( ai, ai.primaryweapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity. Must be AI.","mandatory":true},{"name":"weapon name","description":"The weapon name.","mandatory":true}]}]},{"name":"GetWeaponAttachments","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetWeaponForCharacter","description":"Returns the weapon at the given index","example":"modelName = GetWeaponForCharacter( 0, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetWeaponForwardDir","description":"Returns the weapon's forward direction","example":"weapon GetWeaponForwardDir()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"weapon","description":null},"parameters":[]}]},{"name":"GetWeaponModelForCharacter","description":"Returns the name of the weapon model of at the given index","example":"modelName = GetWeaponModelForCharacter( 0, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetWeaponMuzzlePoint","description":"Returns the weapon's muzzle point","example":"weapon GetWeaponMuzzlePoint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"weapon","description":null},"parameters":[]}]},{"name":"GetWeaponOptic","description":"Gets the weapon optic attachment name","example":"attachmentName = player GetWeaponOptic( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"Weapon name","mandatory":true}]}]},{"name":"GetWeaponWorldModel","description":"Returns weaopn world model","example":"model = GetWeaponWorldModel(\"lmg\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"GetWeaponXCam","description":"Get the weapon XCam","example":"weapon GetWeaponXCam( GetWeapon( weaponName ), \"cam_cac_weapon\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon object","description":"The weapon entity","mandatory":true},{"name":"camera","description":"The camera to get","mandatory":true}]}]},{"name":"GetXCamForCharacter","description":"Returns the name of the xcam to use for the character pose in the frontend","example":"frontendVignetteAnim = GetXCamForCharacter( characterIndex, \"mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"characterIndex","description":"The index of the character in the current game-mode's character table","mandatory":true},{"name":"sessionmode","description":"Session Mode Index","mandatory":true}]}]},{"name":"GetXModelCenterOffset","description":"Calculates the offset to the center of the model from the origin","example":"offset = GetXModelCenterOffset( \"modelname\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"modelname","description":"The name of the xmodel","mandatory":true}]}]},{"name":"GetXuid","description":"Gets the 64-bit Steam ID (SteamID64) of the given player.","example":"xuid = self GetXuid(1)","flags":["verified"],"verifiedInRevision":5,"overloads":[{"calledOn":{"name":"player","description":"The player to get the XUID of.","mandatory":true,"type":{"dataType":"struct","instanceType":"player"}},"parameters":[{"name":"formatToDecimal","description":"When set to `true`, the XUID is returned in decimal format. Otherwise, it is returned in hexadecimal format.","mandatory":false,"type":{"dataType":"bool"}}],"returns":{"name":"xuid","description":"A string containing the XUID of the player in the requested format.","type":{"dataType":"string"}}}]},{"name":"GetZBarrierArray","description":"Returns an array of all of the zbarrier objects in a level.","example":"zbarriers = GetZBarrierArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetZBarrierAttackSlotHorzOffset","description":"Returns the horizontal offset used to offset the position of each attack slot relative to the zbarrier object. Odd numbers will start in the center of the barrier and offset to each side. Even numbers will start each side of the center - with no central spot specified.","example":"horzOffset = ent GetZBarrierAttackSlotHorzOffset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetZBarrierNumAttackSlots","description":"Returns the number of attack slots used by this zbarrier.","example":"numSlots = ent GetZBarrierNumAttackSlots()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetZBarrierPieceAnimLengthForState","description":"Returns the length in seconds for the animation associated with the supplied state for a piece, in seconds.","example":"wait(ent GetZBarrierPieceAnimLengthForState(0, \"opening\", 0.9))","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"index","description":"The index of the piece we care about.","mandatory":true},{"name":"state","description":"Name of state of interest - choices are 'open', 'closed', 'opening', 'closing'.","mandatory":true},{"name":"scalar","description":"Scalar applied to animation length.","mandatory":false}]}]},{"name":"GetZBarrierPieceAnimState","description":"Returns the anim state name to be used for zombies tearing this board down.","example":"anim_state = ent GetZBarrierPieceAnimState(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetZBarrierPieceAnimSubState","description":"Returns the anim sub-state name to be used for zombies tearing this board down.","example":"anim_state = ent GetZBarrierPieceAnimSubState(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetZBarrierPieceIndicesInState","description":"Returns an array of integer indices of the zbarriers pieces that are in the specified state.","example":"open_pieces = ent GetZBarrierPieceIndicesInState(\"open\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"state","description":"Name of state of interest - choices are 'open', 'closed', 'opening', 'closing'.","mandatory":true}]}]},{"name":"GetZBarrierPieceState","description":"Returns the state of the piece indexed in the zbarrier ent. States are open, opening, closed and closing.","example":"pieceState = ent GetZBarrierPieceState(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"GetZBarrierReachThroughAttackAnimState","description":"Returns the anim state name for reach through attacks used by this zbarrier.","example":"attackStateName = ent GetZBarrierReachThroughAttackAnimState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetZBarrierTauntAnimState","description":"Returns the anim state name for taunts used by this zbarrier.","example":"tauntStateName = ent GetZBarrierTauntAnimState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"Ghost","description":"Used when the entity should be sent over the network to clients but not be drawn","example":"model Ghost()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"Gib","description":"Gib an entity","example":"self gib( \"normal\", temp_array )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"gibtype","description":"Type of gib","mandatory":true},{}]}]},{"name":"GlassRadiusDamage","description":"Damages glass in the radius","example":"GlassRadiusDamage( origin, range, max_damage, min_damage, means_of_damage )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Origin of damage","mandatory":true},{"name":"radius","description":"Radius of damage","mandatory":true},{"name":"max_damage","description":"Max damage, this is the damage at the origin","mandatory":true},{"name":"min_damage","description":"Max damage, this is the damage at the edge of the radius","mandatory":true},{"name":"means_of_death","description":"Means of death passed to the glass system from script, defaults to MOD_EXPLOSIVE","mandatory":false}]}]},{"name":"GrenadeExplosionEffect","description":"Create a grenade explosion effect at the position","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position of the fx","mandatory":true}]}]},{"name":"GroundTrace","description":"Allows script to do a point trace with MASK_SHOT + MASK_ITEM. Returns hit position, hit entity, hit surface normal.","example":"trace = GroundTrace(magicBulletOrigin.origin, eyePos, true, undefined)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"hit characters","description":"When set to true, this will trace for character hits","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true},{"name":"ignore water","description":"Optionally ignore water. (bool)","mandatory":false},{"name":"ignore glass","description":"Optionally ignore glass. (bool)","mandatory":false}]}]},{"name":"HasASM","description":"Check if this entity has an ASM.","example":"if ( HasASM( self ) ) {","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"HasPart","description":"Returns whether the entity has the given tagname as part of its skeleton.","example":"has_part = self HasPart( \"tag_weapon\", \"weapon_saw\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"tagname","description":"The tag to search for. (string)","mandatory":true},{"name":"modelname","description":"The optional model name to help specify the part location. (string)","mandatory":false}]}]},{"name":"HeliTurretDogTrace","description":"Determines if you helicopter turret can see the dog.","example":"if (0 == (copter HeliTurretSightTrace(heli_turret_point, dog, lastHit))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"place that check if you can see if being performed","mandatory":true},{"name":"dog","description":"the dog that the helicopter wants to see","mandatory":true},{"name":"hitNum","description":"if you run this more than once make sure to populate this with the return of the last as it will increase efficiency","mandatory":true}]}]},{"name":"HeliTurretSightTrace","description":"Determines if you helicopter turret can see an the players eyes.","example":"if (0 == (copter HeliTurretSightTrace(heli_turret_point, player, lastHit))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"place that check if you can see if being performed","mandatory":true},{"name":"player","description":"the player that the helicopter wants to see","mandatory":true},{"name":"hitNum","description":"if you run this more than once make sure to populate this with the return of the last as it will increase efficiency","mandatory":true}]}]},{"name":"Hide","description":"Hide the entity","example":"self Hide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"HideFromTeam","description":"Hides the entity from a particular team","example":"self HideFromTeam( friend_team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"The team to show the entity to.","mandatory":true}]}]},{"name":"hideinfovolume","description":"Stops an info volume from being drawn","example":"InfoVolumeDebug_HideVolume( info_volume GetEntityNumber() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entnum","description":"the entity number of the info volume","mandatory":true}]}]},{"name":"HideMiscModels","description":"Hide all misc models with this targetname","example":"HideMiscModels( \"crash_destruct\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"targetname of misc model(s).","mandatory":true}]}]},{"name":"HidePart","description":"Hide part of an entity.","example":"self HidePart( \"tag_weapon\", \"weapon_saw\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"tagname","description":"The tag to hide. All surfaces with a vertex weighted to the tag will be hidden and have no bullet collision. (string)","mandatory":true},{"name":"modelname","description":"The optional model name to help specify the part location. (string)","mandatory":false},{"name":"bApplyToChildren","description":"Optional flag to specify if we should apply the operation to children bones as well. (boolean)","mandatory":false}]}]},{"name":"HideZBarrierPiece","description":"Stops the indexed piece from being drawn.","example":"ent HideZBarrierPiece(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"IncrementCounter","description":"Increments the counter","example":"IncrementCounter( \"global_comebacks\", level.globalComebacks )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"counterType","description":"The counter type","mandatory":true},{"name":"increment","description":"The increment type","mandatory":true}]}]},{"name":"incrementSpecificWeaponPickedUpCount","description":"increment the count of the times we've picked up this weapon (uniquely identified by weapon+attachemnts; see function: areWeaponsEqual )","example":"self incrementSpecificWeaponPickedUpCount( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"the weapon","mandatory":true}]}]},{"name":"InfoVolumeDebugInit","description":"Initializes the info volume debug array","example":"DebugInfoVolume()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"InLastStand","description":"Check the last stand state for the client","example":"if ( self InLastStand() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"IPrintLn","description":"Writes a line of text to the bottom left corner of the screen.","example":"IPrintLn( \"Where have all the cowboys gone?\" )","flags":["verified"],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"Text to be written.","type":{"dataType":"string"},"mandatory":true}],"returns":{"void":true}}]},{"name":"IPrintLnBold","description":"Writes a line of text to the center of the screen.","example":"IPrintLnBold( \"Mitchell!\" )","flags":["verified"],"verifiedInRevision":2,"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"Text to be written.","type":{"dataType":"string"},"mandatory":true}],"returns":{"void":true}}]},{"name":"IsActor","description":"Checks whether this entity is an ai character","example":"if ( IsActor( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an ai character","mandatory":true}]}]},{"name":"IsActorCorpse","description":"Checks whether this entity is an actor corpse","example":"if ( IsActorCorpse( corpse ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that might be a corpse","mandatory":true}]}]},{"name":"IsActorSpawner","description":"Checks whether this entity is an actor spawner","example":"if ( IsActorSpawner( ent ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an actor spawner","mandatory":true}]}]},{"name":"IsAI","description":"Checks whether this entity is an ai character","example":"if ( IsAI( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an ai character","mandatory":true}]}]},{"name":"IsAirborne","description":"Checks whether this entity is an airborne unit","example":"if ( IsAirborne( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object","mandatory":true}]}]},{"name":"IsAlive","description":"Checks whether this entity is alive","example":"if ( IsAlive( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that might be alive or dead","mandatory":true}]}]},{"name":"IsAnimLooping","description":"Gets whether an animation is looped or not","example":"boolLoop = IsAnimLooping( climbAnim )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"animation","description":"an animation that needs to be identified as a looping or not","mandatory":true}]}]},{"name":"IsArchetypeLoaded","description":"Returns true if a given archetype is loaded in the level.","example":"if ( IsArchetypeLoaded( ARCHETYPE_WARLORD ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsArenaMode","description":"Returns true if we are in arena mode","example":"if ( IsArenaMode() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsAssetLoaded","description":"Check whether or not an asset is loaded.","example":"IsAssetLoaded( \"weapon\", \"rpg\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"assetType","description":"\"weapon\" or \"material\"","mandatory":true},{"name":"assetName","description":"The name of the asset - should match zone_source","mandatory":true}]}]},{"name":"IsBonusCardActive","description":"Returns if the bonus card is enabled and active in the class, cannot be called on a larry","example":"primary = self IsBonusCardActive( BONUSCARD_PRIMARY_GUNFIGHTER_INDEX, self.class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bonuscard","description":"BonusCard index from bonuscard.gsh","mandatory":true},{"name":"classnum","description":"The current class num of the player","mandatory":true}]}]},{"name":"IsBot","description":"Returns true if the entity is a bot controlled player","example":"if( self IsBot() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsCamAnimLooping","description":"Returns whether or not a specific camera anim loop.","example":"IsCamAnimLooping( \"proto_melee_cam\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cam_anim","description":"The animation to play","mandatory":true}]}]},{"name":"IsClientCacheStable","description":"Is the players client cache stable, have we loaded all other clients' resources.","example":"player IsClientCacheStable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsCorpse","description":"Checks whether this entity is a corpse","example":"if ( IsCorpse( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that might be a corpse","mandatory":true}]}]},{"name":"IsCoverNode","description":"returns true if the node is of type NODE_TYPEFLAGS_COVER_ONLY","example":"IsCoverNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to delete","mandatory":true}]}]},{"name":"IsDangerous","description":"Returns true if the pathnode is dangerous for the given team","example":"if ( node IsDangerous( team ) ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"pathnode","description":null},"parameters":[{"name":"team","description":"Name of the team.","mandatory":true}]}]},{"name":"IsDedicated","description":"Returns true/false if we are running on the dedicated server","example":"if ( IsDedicated() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsDoubleJumping","description":"Returns true if the player is double jumping.","example":"if(player DoubleJumping())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsEMPJammed","description":"Returns true if this player is jammed by the emp, false otherwise","example":"if ( player IsEMPJammed() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsEntity","description":"Checks whether given variable is of type entity.","example":"if ( IsEntity( variable ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable to test","mandatory":true}]}]},{"name":"IsEventServiced","description":"Set the specified event to serviced.","example":"serviced = self IsEventServiced( 100 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"eventId","description":"The identifier of the event (integer)","mandatory":true}]}]},{"name":"IsFiringTurret","description":"Checks whether this turret is firing. The entity must be a turret","example":"turret IsFiringTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"IsFlared","description":"Check is a player is under the influence of a flare","example":"if ( player IsFlared() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsGadgetMeleeCharging","description":"Is the player in the process of melee charging ","example":"self IsGadgetMeleeCharging()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsGlobalStatsServer","description":"Returns true if the game is a global stats ranked server","example":"level.ranked |= IsGlobalStatsServer()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsGodMode","description":"Checks whether this entity is in god mode","example":"if ( IsGodMode( player ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object to check for god mode","mandatory":true}]}]},{"name":"IsHidden","description":"return true if entity is hidden","example":"self IsHidden()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsInSecondChance","description":"To check if player is needs revive","example":"if ( self IsInSecondChance() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsInsideHeightLock","description":"Returns whether the entity is inside the height lock or not","example":"if( self IsInsideHeightLock() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsLaserOn","description":"check if the entity has laser turned on.","example":"if ( IsLaserOn( entity ) ) { ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsLinkedTo","description":"Returns true if the entity is linked to the other entity","example":"if (ent IsLinkedTo( other )) { // dostuff }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other","description":"Entity","mandatory":true}]}]},{"name":"IsLoadingCinematicPlaying","description":"Is the player playing the loading cinematic","example":"player IsLoadingCinematicPlaying()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsLocalGame","description":"Returns true if the game local only","example":"level.local = IsLocalGame()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsMantling","description":"Return true if the player is mantling, false otherwise.","example":"self IsMantling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsMapSubLevel","description":"Returns whether or not the map is a sublevel of a mission","example":"level.isSubLevel = IsMapSubLevel( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"IsMature","description":"Checks if a player has his Graphic Content Flag is on","example":"IsMature( player )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to check if his Graphic Content Flag is on","mandatory":true}]}]},{"name":"ismissileinsideheightlock","description":"Returns whether the entity is inside the height lock or not","example":"if( self IsInsideHeightLock() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsMovingPlatform","description":"Returns whether platform is a moving platform or not","example":"platform IsMovingPlatform()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsNavVolumeLoaded","description":"Checks whether nav volume is loaded","example":"if ( IsNavVolumeLoaded() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsNodeEnabled","description":"returns true if the node is enabled, false otherwise","example":"IsNodeEnabled( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to check","mandatory":true}]}]},{"name":"IsNodeOccupied","description":"See if anyone has claimed a particular node.","example":"if ( IsNodeOccupied( node ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"which node to check.","mandatory":true}]}]},{"name":"IsOnGround","description":"Returns true if entity is on ground","example":"if( self IsOnGround() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsOnLadder","description":"Return true if the player is on a ladder, false otherwise.","example":"self IsOnLadder()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsOnSlide","description":"Return true if the player is in the player movement slide.","example":"self IsOnSlide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPathfinder","description":"Checks whether this entity is registered with navigation system so it can do pathfinding and position query","example":"if ( IsPathfinder( tank ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity to check","mandatory":true}]}]},{"name":"IsPaused","description":"Returns whether a given entity is paused as part of a world pause.","example":"if ( ent IsPaused() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsPlayer","description":"Checks whether this entity is the player","example":"if ( IsPlayer( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be the player","mandatory":true}]}]},{"name":"IsPlayerNumber","description":"Returns true if the passed in int is a valid client number","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsPlayerSwimming","description":"Return if a player is swimming","example":"depth = get_players()[0] IsPlayerSwimming()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPlayerUnderwater","description":"Return if a player is underwater","example":"depth = get_players()[0] IsPlayerUnderwater()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPlayingAnimScripted","description":"Returns true if the entity is playing in scripted animation.","example":"if(player IsPlayingAnimScripted())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsPointInNavVolume","description":"Checks if a given point is within the specified navigation volume.","example":"result = IsPointInNavVolume( (10,20,30), \"small volume\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to evaluate.","mandatory":true},{"name":"navVolumeName","description":"Either \"navvolume_small\" or \"navvolume_big\".","mandatory":true}]}]},{"name":"IsPointOnNavMesh","description":"Checks if a given point is valid on the NavMesh. This check performs all the necessary validation such as away from boundary, correct material, navmesh trigger, etc.","example":"isValid = IsPointOnNavMesh( (10,20,30), self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"Position to evaluate.","mandatory":true},{"name":"entity / radius","description":"the point is for this entity to path to, or an estimate radius of the expected character radius. default to radius 0. Note: not passing in the entity can cause false positive when point is on NavMesh but too close to boundary / on wrong material / in disabled navmesh trigger; or false negative when big character's origin is far below NavMesh but still within tolerant height.","mandatory":false}]}]},{"name":"IsPoisoned","description":"Check is a player is under the influence of gas","example":"if ( player IsPoisoned() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsRagdoll","description":"Return true if the entity is a ragdoll body, false otherwise.","example":"if( player IsRagdoll() ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player_or_playercorpse","description":null},"parameters":[]}]},{"name":"IsSentient","description":"Checks whether this entity is a sentient, that is normally either an ai actor, ai vehicle or the player","example":"if ( IsSentient( vehicle.riders[j] ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be a sentient character","mandatory":true}]}]},{"name":"IsSlamming","description":"Returns true if the player is slamming.","example":"if(player IsSlamming())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsSliding","description":"Returns true if the player is sliding.","example":"if(player IsSliding())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsSpawner","description":"Checks whether this entity is a spawner","example":"if ( IsSpawner( ent ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"An entity object that may be a spawner","mandatory":true}]}]},{"name":"IsSpawnPointVisible","description":"Returns true or false if a point is visible to the given team","example":"if ( IsSpawnPointVisible( point_position, point_angles, \"axis\", player ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point","description":"Spawnpoint origin that needs to be checked","mandatory":true},{"name":"angles","description":"Spawnpoint angles that needs to be checked","mandatory":true},{"name":"team","description":"Team that we need to check against the point","mandatory":true},{"name":"ignore player","description":"The player that we are spawning in","mandatory":true}]}]},{"name":"IsSplitScreen","description":"Returns true if the game is a splitscreen game","example":"level.splitscreen = IsSplitScreen()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsSprinting","description":"Returns true if the player is sprinting.","example":"if(player IsSprinting())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsStarterPack","description":"Returns true if the player has starter pack","example":"if ( self IsStarterPack() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsStartingClassDefault","description":"Returns true if the starting class is the default class for the level","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsStreamerReady","description":"Is the players streamer ready.","example":"player IsStreamerReady()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTestClient","description":"Returns true if the player is a test client (Does not have a remote user).","example":"if( self IsTestClient() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTouching","description":"Returns true if is touching ","example":"if( player IsTouching( e_goal_volume ) ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other entity","description":"Entity.","mandatory":true}]}]},{"name":"IsTouchingSwept","description":"Returns true if is touching ","example":"if( player IsTouchingSwept( e_goal_volume ) ) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"other entity","description":"Entity.","mandatory":true}]}]},{"name":"IsTouchingVolume","description":"Returns true if entity is touching the volume.","example":"if ( crate_ent IsTouchingVolume( origin + (0,0,40), mins, maxs ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"origin","description":"Origin of the volume","mandatory":true},{"name":"volume mins","description":"The min extents of the volume","mandatory":true},{"name":"volume maxs","description":"The max extents of the volume","mandatory":true}]}]},{"name":"IsTraversing","description":"Returns true if the player is traversing.","example":"if(player IsTraversing())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTriggerEnabled","description":"Returns true if trigger is enabled. False otherwise","example":"if( trig isTriggerEnabled() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"IsTurretFiring","description":"Checks if this turret is firing","example":"if( IsTurretFiring( roof_turret ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"IsTurretLockedOn","description":"Checks whether this turret is locked onto a target. The entity must be a turret","example":"turret IsTurretLockedOn()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"IsUsingNavVolume","description":"Checks whether this entity is using Nav Volume. Note this is a relatively low level check. For general gameplay check whether an entity is flying, consider using IsAirborne.","example":"if ( IsUsingNavVolume( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object","mandatory":true}]}]},{"name":"isUsingT7Melee","description":"Returns true T7 Melee system is being used","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsValidGametype","description":"Returns true if the string is a valid game type","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"game type","description":"a string to check","mandatory":true}]}]},{"name":"IsVehicle","description":"Checks whether this entity is an ai character","example":"if ( IsVehicle( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity object that may be an ai character","mandatory":true}]}]},{"name":"IsVehicleSpawner","description":"Checks whether this entity is a vehicle spawner","example":"if ( IsVehicleSpawner( ent ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"An entity object that may be a vehicle spawner","mandatory":true}]}]},{"name":"isvr","description":"check if this player has VR enabled","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsWallRunning","description":"Returns true if the player is wall running.","example":"if(player IsWallRunning())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsWallrunNode","description":"returns true if the node has the PNF_WALLRUN flag set","example":"IsWallrunNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The node to check","mandatory":true}]}]},{"name":"IsWorldPaused","description":"returns whether or not the world is currently paused","example":"if ( IsWorldPaused() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"IsZBarrier","description":"Returns true if the entity called on is a zbarrier.","example":"if(ent IsZBarrier())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsZBarrierClosed","description":"Returns true if the state of all of the zbarrier's pieces is 'closed'.","example":"closed = ent IsZBarrierClosed())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsZBarrierOpen","description":"Returns true if the state of all of the zbarrier's pieces is 'open'.","example":"open = ent IsZBarrierOpen())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ItemWeaponSetAmmo","description":"Set the weapon ammo to the given clip ammo and reserve ammo. Can give an alternate weapon index","example":"weap ItemWeaponSetAmmo( clip, extra, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"item","description":null},"parameters":[{"name":"clipAmmo","description":"Ammo for the clip","mandatory":true},{"name":"reserveAmmo","description":"Reserve ammo","mandatory":true},{"name":"altIndex","description":"Alternate weapon index","mandatory":false}]}]},{"name":"Kick","description":"Kicks the specified player.","example":"Kick( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"clientnum","description":"The client number of the player to kick.","mandatory":true}]}]},{"name":"Kill","description":"Kills this entity. If the entity could not be killed, errors. Automatically sets setCanDamage( true ).","example":"level.player kill()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"source position","description":"The position that the damage comes from. Defaults to entity's origin","mandatory":false},{"name":"attacker","description":"The entity that dealt the damage (such as an AI or player)","mandatory":false},{"name":"inflictor","description":"The entity that the damage came from (such as a grenade or turret)","mandatory":false},{"name":"weapon","description":"weapon to do damage with","mandatory":false}]}]},{"name":"KillClientRadiantExploder","description":"Deactivates a client side radiant exploder","example":"DeactivateClientRadiantExploder( \"light_switch\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exploder id","description":"string id of exploder to deactivate","mandatory":true}]}]},{"name":"KillServer","description":"kills the server","example":"KillServer()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"LaserOff","description":"Turns off entity's laser sight.","example":"self LaserOff()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"LaserOn","description":"Turns on entity's laser sight.","example":"self LaserOn()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"Launch","description":"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":"self Launch( (x, y, z) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"initial velocity","description":"The initial velocity of the launch.","mandatory":true},{"name":"initial angular velocity","description":"The initial angular velocity of the launch.","mandatory":false}]}]},{"name":"LaunchRagdoll","description":"Launch this ragdoll.","example":"self LaunchRagdoll( (0,0,100) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"force","description":"launch force","mandatory":true},{"name":"bonename","description":"bone name to apply the force to","mandatory":false}]}]},{"name":"LaunchVehicle","description":"Launch this physics vehicle.","example":"panzer LaunchVehicle( (0,0,100) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"force","description":"launch force","mandatory":true},{}]}]},{"name":"LerpViewAngleClamp","description":"Only works if the player is currently linked to another entity and angles aren't locked. Lerps the current view angle constraints to the provided ones over the specified time.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"time","description":"Lerp duration in seconds. A value of 0 means instantaneous.","mandatory":true},{"name":"accel time","description":"Acceleration time.","mandatory":true},{"name":"decel time","description":"Decelaration time.","mandatory":true},{"name":"right arc","description":"Angle to clamp view to the right.","mandatory":true},{"name":"left arc","description":"Angle to clamp view to the left.","mandatory":true},{"name":"top arc","description":"Angle to clamp view to the top.","mandatory":true},{"name":"bottom arc","description":"Angle to clamp view to the bottom.","mandatory":true}]}]},{"name":"LinkNodes","description":"Connects node1 to node2. Call it again with arguments flipped if you want a two-way connection.","example":"LinkNodes( node_moving_elev_left, node_moving_elev_right )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"first node to link","mandatory":true},{"name":"node2","description":"second node to link","mandatory":true}]}]},{"name":"LinkTo","description":"Attaches one entity to another","example":"self.rightturret LinkTo( self, \"tag_gunRight\", (0,0,0), (0,0,0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach this thing to","mandatory":true},{"name":"tag","description":"The tag to attach the entity to","mandatory":false},{"name":"originOffset","description":"The positional offset from the base position","mandatory":false},{"name":"anglesOffset","description":"The angular offset from the base angles","mandatory":false}]}]},{"name":"LinkToBlendToTag","description":"Attaches one entity to another, gradually lerping entity to the parents orientation","example":"self.rightturret LinkToBlendToTag( self, \"tag_gunRight\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach this thing to","mandatory":true},{"name":"tag","description":"The tag to attach the entity to","mandatory":false},{"name":"only yaw","description":"Tells if blending only the yaw. Default to true.","mandatory":false},{"name":"collision physics","description":"Sets whether we should use collision physics. Defaults to false.","mandatory":false}]}]},{"name":"LinkToUpdateOffset","description":"Attaches one entity to another, gradually lerping entity to the parents orientation","example":"self.rightturret LinkToUpdateOffset( originsOffset, anglesOffset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{"name":"origin_offset","description":"The origin offset","mandatory":true},{"name":"angles_offset","description":"The angles offset","mandatory":false}]}]},{"name":"LinkTraversal","description":"Creates a user edge connecting two path nodes","example":"LinkTraversal( beginNode )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"Negotiation begin node","mandatory":true}]}]},{"name":"LoadSentientEventParameters","description":"Loads the global sentient event parameters for a given scriptbundle sentient events asset. (all AI will use these)","example":"LoadSentientEventParameters( \"sentientevents\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"scriptBundle","description":"String name of the script bundle to load","mandatory":true}]}]},{"name":"LocalToWorldCoords","description":"Transform the given local coordinate point to a world coordinate point","example":"ramboPoint = self LocalToWorldCoords( delta )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"local coordinate","description":"The point in local coordinates (vector3)","mandatory":true}]}]},{"name":"LookAtEntity","description":"Set this actor to look at the specified entity. Call this function without any entity specified to turn it off.","example":"guy LookAtEntity( otherguy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"otherguy","description":"the other guy to look at","mandatory":false}]}]},{"name":"LookAtPos","description":"Set this actor to look at the specified position. Call this function without any position specified to turn it off.","example":"guy LookAtPos( pos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"pos","description":"the position to look at","mandatory":false}]}]},{"name":"LUINotifyEvent","description":"Sends a notify from script to LUI.","example":"LUINotifyEvent( &\"update_objectives\", 1, &\"LEVEL_GOTO_NEXT_PLACE\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player","description":"the player to notify. If not specified, all players are notified.","mandatory":false},{"name":"lui event name","description":"as an IString","mandatory":true},{"name":"num of args","description":"number of parameters","mandatory":true},{"name":"args","description":"argument to pass to LUI","mandatory":true}]}]},{"name":"LUINotifyEventToSpectators","description":"Sends a notify from script to LUI.","example":"LUINotifyEventToSpectators( &\"update_objectives\", 1, &\"LEVEL_GOTO_NEXT_PLACE\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"lui event name","description":"as an IString","mandatory":true},{"name":"num of args","description":"number of parameters","mandatory":true},{"name":"args","description":"argument to pass to LUI","mandatory":true}]}]},{"name":"MagicBullet","description":"Creates a magic bullet at the source","example":"MagicBullet( GetWeapon(\"sniper_hyperion\"), level.sniper_loc.origin, target GetTagOrigin( \"tag_eye\" ), level.sniper_boss)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"Weapon type of the bullet","mandatory":true},{"name":"source","description":"Where the bullet will be spawned","mandatory":true},{"name":"destination","description":"Where the bullet will be fired at","mandatory":true},{"name":"attacker","description":"Set the owner of the bullet to this","mandatory":false},{"name":"targetent","description":"The target of the bullet","mandatory":false},{"name":"targetOffset","description":"Offset the target by this vector","mandatory":false}]}]},{"name":"MagicGrenade","description":"Creates a \"Magic\" grenade from an actor.","example":"self MagicGrenade( self.origin, target.origin, 2.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"target position","description":"The target point of the grenade toss","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false},{"name":"weapon","description":"The grenade weapon to use (defaults to equipped grenade weapon)","mandatory":false}]}]},{"name":"MagicGrenadeManual","description":"creates a \"Magic\" grenade from an actor","example":"self MagicGrenadeManual( self.origin, target.origin, 2.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"velocity","description":"The initial velocity vector for the grenade movement","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false}]}]},{"name":"MagicGrenadeManualPlayer","description":"creates a \"Magic\" grenade from a player","example":"self MagicGrenadeManualPlayer( self.origin, target.origin, 2.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"velocity","description":"The initial velocity vector for the grenade movement","mandatory":true},{"name":"weapon","description":"The grenade weapon to base on","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false}]}]},{"name":"MagicGrenadePlayer","description":"Creates a \"Magic\" grenade from a player.","example":"MagicGrenadePlayer( \"sticky_grenade_mp\", self.origin, toss_velocity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The grenade weapon to use","mandatory":true},{"name":"origin","description":"The starting point of the grenade toss","mandatory":true},{"name":"velocity","description":"The initial velocity vector for the grenade movement","mandatory":true}]}]},{"name":"MagicGrenadeType","description":"Fire a 'magic grenade', from the source location towards the destination point.","example":"ent MagicGrenadeType( \"fraggrenade\", self.origin, myVelocity )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the weapon","mandatory":true},{"name":"sourceLoc","description":"The grenade starting point","mandatory":true},{"name":"velocity","description":"The velocity of the grenade","mandatory":true},{"name":"time to blow","description":"The grenade fuse time in seconds","mandatory":false}]}]},{"name":"MagicMissile","description":"Launches a weapon from the given position with the given velocity. Velocity determines direction.","example":"bomb = player MagicMissile( \"artillery_mp\", (100,100,0), ( 0.1, 0.1, 0.1 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"attacker","description":null},"parameters":[{"name":"weapon","description":"- Weapon name.","mandatory":true},{"name":"position","description":"- Position to launch from.","mandatory":true},{"name":"velocity","description":"- Direction and force of launch.","mandatory":true},{"name":"targetent","description":"The target of the bullet","mandatory":false}]}]},{"name":"MakeFakeAI","description":"Create a drone from script model, that can be moved around with simple commands","example":"guy MakeFakeAI()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model","description":null},"parameters":[]}]},{"name":"MakeGrenadeDud","description":"Turns a grenade into a dud","example":"grenade MakeGrenadeDud()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"grenade","description":null},"parameters":[]}]},{"name":"MakePathfinder","description":"Register a vehicle with Havok so it can do pathfinding and position query","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"MakeSentient","description":"Turn a vehicle or script mover into a sentient.","example":"heli MakeSentient()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"MakeTurretUnusable","description":"Sets a turret to be unable to be used","example":"roof_turret MakeTurretUnusable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"MakeTurretUsable","description":"Sets a turret able to be used","example":"roof_turret MakeTurretUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"MakeUnusable","description":"Sets this entity to be not usable by the player","example":"mover MakeUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"MakeUsable","description":"Sets this entity to be usable by the player","example":"mover MakeUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"The team that is allowed to use the object. Only for script movers.","mandatory":false}]}]},{"name":"Map","description":"Loads a new map","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"The map to load","mandatory":true},{"name":"save persistent","description":"if true then player info is retained","mandatory":false}]}]},{"name":"Map_Restart","description":"Restarts the map","example":"Map_Restart( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"save persistent","description":"if true then player info is retained","mandatory":false}]}]},{"name":"MapExists","description":"Returns true if the map with the given name exists on the server","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"The map to check.","mandatory":true}]}]},{"name":"MarkDestructibleDestroyed","description":"set destructible destroyed","example":"barrel MarkDestructibleDestroyed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"destructible","description":null},"parameters":[]}]},{"name":"MarkNoVehicleNavMeshFaces","description":"Update the novehicle flag on navmesh faces. This should only be used in MP map for now.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"matchRecordOvertimeRound","description":"call after matchRecordRoundStart to mark the round as an overtime round (only first overtimee round is actually recorded)","example":"matchRecordOvertimeRound()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"matchRecordRoundStart","description":"need a hook for round starts, to get time stamps","example":"matchRecordRoundStart()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Matrix4x4TransformPoints","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MaySpawnEntity","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MaySpawnFakeEntity","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Missile_DroneSetVisible","description":"Set the missile or drone to be visible","example":"self Missile_DroneSetVisible( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True to set visible, false otherwise","mandatory":true}]}]},{"name":"Missile_GetTarget","description":"Sets the target of the missile to the given entity, and resets if no entity is specified.","example":"target = missile Missile_GetTarget()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[]}]},{"name":"missile_settarget","description":"Sets the target of the missile to the given entity, and resets if no entity is specified.","example":"self missile_settarget( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{"name":"target","description":"The target of the missile","mandatory":false},{"name":"targetOffset","description":"Offset to the target location (vector3)","mandatory":false}]}]},{"name":"MissionFailed","description":"Restarts the map","example":"MissionFailed()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MissionHasAccolades","description":"Returns whether or not this mission has any accolades associated with it","example":"level.has_accolades = MissionHasAccolades( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"MissionHasCollectibles","description":"Returns whether or not this mission has any collectibles in it","example":"level.has_collectibles = MissionHasCollectibles( \"cp_mi_cairo_ramses2\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"currentmap","description":"the name of the current map. If ommitted, use Dvar sv_mapname","mandatory":false}]}]},{"name":"MissionRestart","description":"Restarts the mission, which might take you to a different BSP if this is a sublevel","example":"MissionRestart()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"MoveGravity","description":"Fling this entity.","example":"self MoveGravity( break_vector, time )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"initial velocity","description":"The initial velocity to fling this entity at","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true}]}]},{"name":"MoveSlide","description":"Launches the entity in the given velocity. When on the ground it will slide smoothly. Call StopMoveSlide to make it stop moving.","example":"self MoveSlide( 16, anglesToForward( self.angles ) * 10 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"center","description":"The center of the entity's collision with the ground","mandatory":true},{"name":"radius","description":"The radius of the entity's collision with the ground","mandatory":true},{"name":"initial velocity","description":"The initial velocity to move the entity at","mandatory":true}]}]},{"name":"MoveTo","description":"Move this entity to the given point.","example":"dummy MoveTo( dest_org, .5, .05, .05 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The point to move the entity to","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating","mandatory":false}]}]},{"name":"MoveX","description":"Move this entity to the given world x value","example":"train MoveX( -4400, 60, 15, 20 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The x value to move the entity to, as a floating point number","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"MoveY","description":"move this entity to the given world y value","example":"hangardoor MoveY( 320, 10 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The y value to move the entity to, as a floating point number","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"MoveZ","description":"Move this entity to the given world z value","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"point","description":"The z value to move the entity to, as a floating point number","mandatory":true},{"name":"time","description":"The time to move the entity in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"NavPointSightFilter","description":"Given an array of navmesh points, filters the array based on navmesh visibility to an origin.","example":"points = NavPointSightFilter( points, nearest )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"points","description":"Array of navmesh points","mandatory":true},{"name":"origin","description":"Origin to check visibility from","mandatory":true},{"name":"checksight","description":"True to check sight, false otherwise","mandatory":false}]}]},{"name":"NeedsRevive","description":"Used for mini maps to display compass icon","example":"self NeedsRevive( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"bool","description":"does player need to be reived","mandatory":true}]}]},{"name":"NodesAreLinked","description":"Returns true if node1 is connected to node2.","example":"NodesAreLinked( node_moving_elev_left, node_moving_elev_right )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"first node","mandatory":true},{"name":"node2","description":"second node","mandatory":true}]}]},{"name":"NodesVisible","description":"Returns true if these nodes are visible to one another, false otherwise.","example":"if ( NodesVisible( cover, guy.node ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"pathnode to check","mandatory":true},{"name":"node2","description":"pathnode to check against node1","mandatory":true}]}]},{"name":"NotSolid","description":"Unsets the solid flag, so that this object is no longer collidable.","example":"self NotSolid()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ent","description":null},"parameters":[]}]},{"name":"NumRemoteClients","description":"Returns the number of remote clients connected to the game. Very useful for scaling content for coop play, and network balancing.","example":"num_remote_clients = NumRemoteClients()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Obituary","description":"Create an obituary for a character","example":"Obituary( self, attacker, sWeapon, sMeansOfDeath )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"victim","description":"The victim entity","mandatory":true},{"name":"attacker","description":"The attacker entity","mandatory":true},{"name":"weapon","description":"The weapon name","mandatory":true},{"name":"weapon","description":"The means of death as a string","mandatory":true}]}]},{"name":"Objective_Add","description":"Add a new objective, with ability to specify all the info for the objective","example":"Objective_Add( objective_number, \"active\", closest.bomb.origin, objective_text, self.objective )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The number of the objective to add","mandatory":true},{"name":"state","description":"A string value representing the state of the objective. Valid states are \"empty\", \"active\", \"invisible\", \"done\", \"current\" and \"failed\"","mandatory":true},{"name":"position/onEntity","description":"The position of the objective - or - entity to be tracked.","mandatory":false},{"name":"displayName","description":"The text to use for the objective. This should be a valid localized text reference","mandatory":false},{"name":"entity","description":"The owner entity","mandatory":false}]}]},{"name":"Objective_ClearAllUsing","description":"Clears the objective of all players using status.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_ClearEntity","description":"Clears the entity previous set on the objective","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_ClearPlayerUsing","description":"Sets the objective to be not being used by the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player who is no longer using the objective","mandatory":true}]}]},{"name":"Objective_Delete","description":"Deletes the objective","example":"Objective_Delete( objective_number )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_GetGamemodeFlags","description":"Gets the gamemode flags for the objective.","example":"flags = Objective_GetGamemodeFlags( myObjNumber )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true}]}]},{"name":"Objective_Icon","description":"Set the objective icon","example":"objective_icon( crateObjID, \"compass_supply_drop_black\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"icon","description":"The icon name","mandatory":true}]}]},{"name":"Objective_OnEntity","description":"Sets the objective to get its position from an entity.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"entity","description":"The entity to set the objective to","mandatory":true}]}]},{"name":"Objective_Position","description":"Set the objective position","example":"objective_position( self.objectiveID, self.curOrigin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"position","description":"The position to set","mandatory":true}]}]},{"name":"Objective_Set3D","description":"Sets flag determining if 3D state for an objective is drawn.","example":"Objective_Set3D( myObjNum, true, undefined, undefined, undefined, (0,0,70) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"use3D","description":"true if should render in hud","mandatory":true},{"name":"unused","description":"not used","mandatory":false},{"name":"unused","description":"not used","mandatory":false},{"name":"unused","description":"not used","mandatory":false},{"name":"unused","description":"not used","mandatory":false}]}]},{"name":"Objective_SetColor","description":"Sets a color for the objective that the icon will then be drawn with.","example":"Objective_SetColor( myObjNumber, 1.0, 0.0, 0.0, 1.0 )Objective_SetColor( myObjNumber, \"FriendlyBlue\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"r/colorName","description":"Red float value for objective, or color name set from the UIEditor as an IString.","mandatory":true},{"name":"g","description":"Green float value for objective.","mandatory":false},{"name":"b","description":"Blue float value for objective.","mandatory":false},{"name":"a","description":"Alpha float value for objective. Default of 1.0 if not specified.","mandatory":false}]}]},{"name":"Objective_SetFlag","description":"Sets the gamemode flags for the objective.","example":"Objective_SetFlag( myObjNumber, \"active\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective to alter","mandatory":true},{"name":"flag","description":"- active, fadeoutonscreen, perk, drawdistance, drawname, in3d, clipToMap, primary","mandatory":true},{"name":"true/false","description":"turn the flag on or off","mandatory":true}]}]},{"name":"Objective_SetGamemodeFlags","description":"Sets the gamemode flags for the objective. This function only works for modes not using 3d objectives (mp).","example":"Objective_SetGamemodeFlags( myObjNumber, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"flags","description":"script managed flags.","mandatory":true}]}]},{"name":"Objective_SetInvisibleToAll","description":"Sets the objective to be invisible to all players.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_SetInvisibleToPlayer","description":"Sets the objective to be invisible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player to whom the objective is now invisible","mandatory":true}]}]},{"name":"Objective_SetInvisibleToPlayerByIndex","description":"Sets the objective to be invisible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"entnum","description":"The entity number of the player to whom the objective is now invisible","mandatory":true}]}]},{"name":"Objective_SetPlayerUsing","description":"Sets the objective to being used by the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player who is using the objective","mandatory":true}]}]},{"name":"Objective_SetProgress","description":"Sets the progress for the objective.","example":"Objective_SetProgress( myObjNumber, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"percent","description":"percent float value for objective [0-1].","mandatory":true}]}]},{"name":"Objective_SetSize","description":"Sets a size for the objective that the icon will then be drawn at. Min is MIN_OBJECTIVE_ICON_SIZE = 5","example":"Objective_SetSize( myObjNumber, myTrigger )Objective_SetSize( myObjNumber, 20, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The ID of the objective.","mandatory":true},{"name":"entity/float","description":"The entity to get the size from or a sizeX.","mandatory":true},{"name":"float","description":"If sizeX was used in prvious arg, this is sizeY.","mandatory":false}]}]},{"name":"Objective_SetUIModelValue","description":"Set a UI Model Value for an objective","example":"Objective_SetUIModelValue( 0, \"killedCount\", 4 ); or Objective_SetUIModelValue( 0, \"killedCount\", \"Four\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"lui menu data name","description":"precached name string for the data which we're trying to set.","mandatory":true},{"name":"lui menu data value","description":"value for the data which we're trying to set on the objective.","mandatory":true}]}]},{"name":"Objective_SetVisibleToAll","description":"Sets the objective to be visible to all players.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true}]}]},{"name":"Objective_SetVisibleToPlayer","description":"Sets the objective to be visible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"player","description":"The player to whom the objective is now visible","mandatory":true}]}]},{"name":"Objective_SetVisibleToPlayerByIndex","description":"Sets the objective to be visible to the specified player.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"entnum","description":"The entity number of the player to whom the objective is now visible","mandatory":true}]}]},{"name":"Objective_State","description":"Set a state for the objective","example":"Objective_State( obj_id, \"active\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"state","description":"The state to set","mandatory":true}]}]},{"name":"Objective_Team","description":"Sets the team that the objective is for. Allows having different objectives for each team","example":"Objective_Team( 0, \"allies\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"team","description":"The team that the objective is for. Valid entries are 'allies', 'axis', 'team3', or 'none'","mandatory":true}]}]},{"name":"Objective_VisibleTeams","description":"Sets the team that the objective is visible too for. Allows having different objectives for each team","example":"Objective_VisibleTeams( 0, 01101101 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_number","description":"The ID of the objective to alter","mandatory":true},{"name":"team","description":"The team that the objective is for. Valid entries are 'allies', 'axis', 'team3', or 'none'","mandatory":true}]}]},{"name":"OffhandWeaponsEnabled","description":"Determine if offhand weapons are enabled for the player","example":"enabled = player OffhandWeaponsEnabled()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"OverrideSpawnflags","description":"Sets the spawnflags on this entity. Used for patching.","example":"entity OverrideSpawnflags( 64 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"PathDistance","description":"Returns the approximate/semi-accurate path distance between two points or undefined if no path can be found.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":".","mandatory":true},{"name":"end","description":".","mandatory":true},{"name":"generatePathForAccurateDist","description":"If set to true, a real path will be generated and the total length of the path segments will be returned.","mandatory":false},{"name":"pathEnt","description":"Only used when generatePathForAccurateDist is set. pathEnt will be used for generating a path, so it will respect the movement type. Only supported for actors.","mandatory":false},{"name":"pathDistanceType","description":"The method of pathdistance calculation. Two options are PATHDIST_APPROXIMATE(using getApproximateFuturePositions), PATHDIST_CORNERPREDICTED (using getCornerPredictor).","mandatory":false},{"name":"maxCornerPredictions","description":"Maximum number of cornerPrediction steps when PATHDIST_CORNERPREDICTED is used. Handles the edge case when cornerPrediction may not ever finish stepping the path all the way.","mandatory":false}]}]},{"name":"PhysicsExplosionCylinder","description":"Created a physics explosion cylinder","example":"PhysicsExplosionCylinder( self.origin, 600, 240, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The origin of the cylinder","mandatory":true},{"name":"outer radius","description":"The outer radius of the cylinder","mandatory":true},{"name":"inner radius","description":"The inner radius of the cylinder","mandatory":true},{"name":"magnitude","description":"The magnitude of the explosion","mandatory":true}]}]},{"name":"PhysicsExplosionSphere","description":"Create a physics explosion sphere","example":"PhysicsExplosionSphere( origin, radius, radius, 5, max_damage, min_damage )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The origin of the sphere","mandatory":true},{"name":"outer radius","description":"The outer radius of the sphere","mandatory":true},{"name":"inner radius","description":"The inner radius of the sphere","mandatory":true},{"name":"magnitude","description":"The magnitude of the explosion","mandatory":true},{"name":"outer damage","description":"The optional outer damage","mandatory":false},{"name":"inner damage","description":"The optional inner damage","mandatory":false}]}]},{"name":"PhysicsJetThrust","description":"Creates a physics jet thrust","example":"PhysicsJetThrust( self.origin, (0,0,1), 400, 1, 60)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"origin of the thrust","mandatory":true},{"name":"weapon facing dir","description":"The weapon facing direction","mandatory":true},{"name":"radius","description":"The radius of the thrust","mandatory":true},{"name":"magnitude","description":"The magnitude of the thrust","mandatory":true},{"name":"angle limit","description":"The angle limit for the thrust","mandatory":true}]}]},{"name":"PhysicsJolt","description":"Create a physics radius jolt","example":"PhysicsJolt( self.origin, 600, 240, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The origin of the jolt","mandatory":true},{"name":"outer radius","description":"The outer radius of the jolt","mandatory":true},{"name":"inner radius","description":"The inner radius of the jolt","mandatory":true},{"name":"impulse","description":"The impulse created by the explosion","mandatory":true}]}]},{"name":"PhysicsLaunch","description":"Permanently turn this entity into a physics object with an intial force vector at the specified point.","example":"dummy PhysicsLaunch( contact_point, initial_force )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model","description":null},"parameters":[{"name":"contact_point","description":"The point to apply the initial force","mandatory":false},{"name":"initial_force","description":"The force vector to apply","mandatory":false}]}]},{"name":"PhysicsTrace","description":"Does a physics trace from start to end. Returns hit position","example":"trace = PhysicsTrace( start, end, ( 0, 0, 0 ), ( 0, 0, 0 ), self, PHYSICS_TRACE_MASK_VEHICLE_CLIP )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true},{"name":"mins","description":"minimum bounds","mandatory":false},{"name":"maxs","description":"maximum bounds","mandatory":false},{"name":"ignore entity","description":"the entity to not consider","mandatory":false},{"name":"mask type","description":"the trace modifier","mandatory":false}]}]},{"name":"PhysicsTraceEx","description":"Physics trace, ignoring characters. Returns the full trace structure.","example":"trace = PhysicsTraceEx( start, end, (-10,-10,0), (10,10,0) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The start point","mandatory":true},{"name":"end","description":"The end point","mandatory":true},{"name":"mins","description":"trace capsule min","mandatory":false},{"name":"maxs","description":"trace capsule max","mandatory":false},{"name":"entity","description":"entity to ignore","mandatory":false},{"name":"player clip","description":"collide with the player solid mask instead of ai solid mask","mandatory":false}]}]},{"name":"PlaceSpawnPoint","description":"Raises the spawn point up to make sure it's not in the ground, then drops it back down into the ground.","example":"spawnpoints[i] PlaceSpawnPoint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"spawn point","description":null},"parameters":[]}]},{"name":"PlayBattleChatterToTeam","description":"Play the sound alias as if coming from the entity, so that only one team can hear it","example":"self PlaySoundToTeam( \"frag_out\", \"axis\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname1","description":"The first sound alias to play","mandatory":true},{"name":"aliasname2","description":"The second sound alias to play","mandatory":true},{"name":"teamname","description":"The team that will be able to hear the sound. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true},{"name":"ignoreplayer","description":"If present, this player will not hear the sound.","mandatory":false}]}]},{"name":"PlayerBulletTrace","description":"Allows script to do a bullet point trace with CONTENTS_PLAYER, collides with player hitboxes. Returns hit position, hit entity, hit surface normal.","example":"trace = PlayerBulletTrace( magicBulletOrigin.origin, eyePos, undefined )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true}]}]},{"name":"PlayerCamLinkTo","description":"Sets the player's vision to look through another entity.","example":"level.player2 CameraLinkTo( cameraUpstairs, \"tag_player\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":"Entity to look through.","mandatory":true},{"name":"tagname","description":"Name of tag on host model to attach to.","mandatory":true}]}]},{"name":"PlayerCamUnlink","description":"Unlinks the player's vision from an entity.","example":"level.player2 CameraUnlink( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayerGrappleTrace","description":"Trace to see if grapple is valid","example":"hitp = PlayerGrappleTrace(player.origin, player.origin + (0,0,-500))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true},{"name":"ignore entity","description":"this entity should be ignored","mandatory":false}]}]},{"name":"PlayerLinkedOffsetDisable","description":"If disabled, the linked player's orientation will not use their link offset.","example":"ac130guy PlayerLinkedOffsetDisable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"linked_player","description":null},"parameters":[]}]},{"name":"PlayerLinkedOffsetEnable","description":"If enabled, the linked player's orientation will use their link offset. This is traditional (CoD4) LinkTo behavior for a player.","example":"ac130guy PlayerLinkedOffsetEnable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"linked_player","description":null},"parameters":[]}]},{"name":"PlayerLinkedSetUseBaseAngleForViewClamp","description":"Sets the whether the player's view clamp is based on the entity (true) or the tag selected (false). Must be called after linking using WeaponViewToDelta","example":"player PlayerLinkedSetUseBaseAngleForViewClamp( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"linked_player","description":null},"parameters":[{"name":"enable","description":"whether or not to enable using the base entity for the view angle clamp base.","mandatory":true}]}]},{"name":"PlayerLinkTo","description":"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":"level.player PlayerLinkTo( vehicle, \"tag_player\", 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"view fraction","description":"How much the change in the tag's rotation effects the players view. Defaults to 0.","mandatory":false},{"name":"right arc","description":"Angle to clamp view to the right. Defaults to 180.","mandatory":false},{"name":"left arc","description":"Angle to clamp view to the left. Defaults to 180.","mandatory":false},{"name":"top arc","description":"Angle to clamp view to the top. Defaults to 180.","mandatory":false},{"name":"bottom arc","description":"Angle to clamp view to the bottom. Defaults to 180.","mandatory":false},{"name":"use tag angles","description":"Determines how the player's view will be tilted. 'False' (default) means that the orientation of the tag when the player is linked will appear flat to the player. Any rotation from that orientation will tilt the player's view. 'True' means that only a tag angles of (0,0,0) will appear flat to the player. Any rotation from (0,0,0) will tilt the player's view.","mandatory":false},{"name":"auto recenter","description":"Players view will auto recenter to the tag he is linked to. use tag angles must be true.","mandatory":false}]}]},{"name":"PlayerLinkToAbsolute","description":"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":"player PlayerLinkToAbsolute( vehicle, \"tag_player\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lockto entity","description":"The entity to attach the player to","mandatory":true},{"name":"tag","description":"The tag to attach the player to","mandatory":false}]}]},{"name":"PlayerLinkToBlend","description":"Only works if the player is currently linked to another entity and angles aren't locked. Lerps the current view angle constraints to the provided ones over the specified time.","example":"player PlayerLinkToBlend( ice_pick, \"tag_origin","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"parent","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"pos time","description":"Lerp duration in seconds. Default is 1.","mandatory":false},{"name":"pos accel time","description":"Acceleration time. Default is 0.","mandatory":false},{"name":"pos decel time","description":"Decelaration time. Default is 0.","mandatory":false},{"name":"angle time","description":"angle Lerp duration in seconds. Default is .","mandatory":false},{"name":"angle accel time","description":"angle Acceleration time. Default is 0.","mandatory":false},{"name":"angle decel time","description":"angle Decelaration time. Default is 0.","mandatory":false}]}]},{"name":"PlayerLinkToDelta","description":"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":"level.player PlayerLinkToDelta( vehicle, \"tag_player\", 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"view fraction","description":"How much the change in the tag's rotation effects the players view. Defaults to 0.","mandatory":false},{"name":"right arc","description":"Angle to clamp view to the right. Defaults to 180.","mandatory":false},{"name":"left arc","description":"Angle to clamp view to the left. Defaults to 180.","mandatory":false},{"name":"top arc","description":"Angle to clamp view to the top. Defaults to 180.","mandatory":false},{"name":"bottom arc","description":"Angle to clamp view to the bottom. Defaults to 180.","mandatory":false},{"name":"use tag angles","description":"Determines how the player's view will be tilted. 'False' (default) means that the orientation of the tag when the player is linked will appear flat to the player. Any rotation from that orientation will tilt the player's view. 'True' means that only a tag angles of (0,0,0) will appear flat to the player. Any rotation from (0,0,0) will tilt the player's view.","mandatory":false},{"name":"auto recenter","description":"Players view will auto recenter to the tag he is linked to. use tag angles must be true.","mandatory":false}]}]},{"name":"PlayerLinkWeaponViewToDelta","description":"Similar to PlayerLinkToDelta(), but the player's body stays behind. The player's view attaches to the tag, and any weapon fire will also come from there.","example":"level.player PlayerLinkToDelta( vehicle, \"tag_player\", 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"linkto entity","description":"The entity to attach the player to.","mandatory":true},{"name":"tag","description":"The tag to attach the player to.","mandatory":false},{"name":"view fraction","description":"How much the change in the tag's rotation effects the players view. Defaults to 0.","mandatory":false},{"name":"right arc","description":"Angle to clamp view to the right. Defaults to 180.","mandatory":false},{"name":"left arc","description":"Angle to clamp view to the left. Defaults to 180.","mandatory":false},{"name":"top arc","description":"Angle to clamp view to the top. Defaults to 180.","mandatory":false},{"name":"bottom arc","description":"Angle to clamp view to the bottom. Defaults to 180.","mandatory":false},{"name":"use tag angles","description":"Determines how the player's view will be tilted. 'False' (default) means that the orientation of the tag when the player is linked will appear flat to the player. Any rotation from that orientation will tilt the player's view. 'True' means that only a tag angles of (0,0,0) will appear flat to the player. Any rotation from (0,0,0) will tilt the player's view.","mandatory":false}]}]},{"name":"PlayerPhysicsTrace","description":"Does a physics trace and returns the hit point.","example":"hitp = PlayerPhysicsTrace(player.origin + (0,0,72), player.origin + (0,0,-500))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true}]}]},{"name":"PlayerPhysicsTraceIgnoreEnt","description":"Does a physics trace and returns the hit point.","example":"hitp = PlayerPhysicsTraceIgnoreEnt(player.origin + (0,0,72), player.origin + (0,0,-500))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"starting position","mandatory":true},{"name":"end","description":"ending position","mandatory":true}]}]},{"name":"PlayerPositionValid","description":"Returns true if the passed in origin is valid for a spawn (ie not inside something).","example":"if(playerpositionvalid(spawnpoints[i].origin))...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of the potential spawn point","mandatory":true}]}]},{"name":"PlayerPositionValidIgnoreEnt","description":"Returns true if the passed in origin is valid for a spawn (ie not inside something).","example":"if(PlayerPositionValidIgnoreEnt(spawnpoints[i].origin))...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of the potential spawn point","mandatory":true}]}]},{"name":"PlayerSetGroundReferenceEnt","description":"The ground entity's rotation will be added onto the player's view. In particular, this will cause the player's yaw to rotate around the entity's z-axis instead of the world z-axis. You only need to call this function once. After that, any rotation that the reference entity undergoes will affect the player. Call this command again with undefined to turn it off.","example":"player PlayerSetGroundReferenceEnt( seaEnt )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"ground reference entity","description":"The entity used to rotate the player's view.","mandatory":true}]}]},{"name":"PlayerSightTrace","description":"Determines if you can see an item. Checks distance and view cone before the trace to increase efficency.","example":"if (0 == (self Playersighttrace(positionOfFlare, 200, lastHit))","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"place that check if you can see if being performed","mandatory":true},{"name":"maxDistance","description":"if the position is further than this -1 will be returned","mandatory":true},{"name":"hitNum","description":"if you run this more than once make sure to populate this with the return of the last as it will increase efficiency","mandatory":true}]}]},{"name":"PlayFX","description":"Plays the fx at the given location.","example":"PlayFX( level._effect[\"nuke_fx\"], nuke_pos.origin, forward, up )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"position","description":"Position to play the fx at","mandatory":true},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false},{"name":"ignore pause","description":"True if the fx should play even when the game is paused.","mandatory":false}]}]},{"name":"PlayFXOnCamera","description":"Plays the fx at the given offset from the camera.","example":"PlayFX( level._effect[\"bubbles\"], offset, forward, up )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"offset","description":"Offset from camera to play fx","mandatory":false},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false},{"name":"ignore pause","description":"True if the fx should play even when the game is paused.","mandatory":false}]}]},{"name":"PlayFXOnTag","description":"Play fx on a particular tag of an entity","example":"PlayFxOnTag( level._effect[\"character_fire_death_torso\"], self, \"J_Spine1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"entity","description":"The entity to play the fx on. Should have a model","mandatory":true},{"name":"tag","description":"The tag to play the fx on","mandatory":true},{"name":"ignore pause","description":"True if the fx should play even when the game is paused.","mandatory":false}]}]},{"name":"PlayLoopedFX","description":"Play an fx which is looped","example":"PlayLoopedFX( level._effect[self.v[\"trailfx\"]], self.v[\"trailfxdelay\"], self.v[\"origin\"], 0, self.v[\"forward\"], self.v[\"up\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"repeat","description":"Time to repeat after","mandatory":true},{"name":"position","description":"Position to play the fx at","mandatory":true},{"name":"cull distance","description":"The cull distance for the fx","mandatory":false},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false}]}]},{"name":"PlayLoopSound","description":"Play a looping sound with an optional fadetime in seconds.","example":"fire_sound_ent playloopsound (\"mpl_player_burn_loop\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"fadetime","description":"Time to fade the sound in. Range is between 1 and 31 inclusive.","mandatory":false}]}]},{"name":"PlayRumbleLoopOnEntity","description":"Plays a looping rumble on the given entity.","example":"self PlayRumbleLoopOnEntity( \"damage_heavy\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rumble name","description":"The name of the rumble to play","mandatory":true}]}]},{"name":"PlayRumbleLoopOnPosition","description":"Play a looping rumble on the given position","example":"PlayRumbleLoopOnPosition( \"grenade_rumble\", origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"rumblename","description":"The rumble name","mandatory":true},{"name":"position","description":"The rumble position","mandatory":true}]}]},{"name":"PlayRumbleOnEntity","description":"Plays a rumble on the given entity.","example":"self PlayRumbleOnEntity( \"damage_heavy\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rumble name","description":"The name of the rumble to play","mandatory":true}]}]},{"name":"PlayRumbleOnPosition","description":"Play a rumble on the given position","example":"PlayRumbleOnPosition( \"grenade_rumble\", origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"rumblename","description":"The rumble name","mandatory":true},{"name":"position","description":"The rumble position","mandatory":true}]}]},{"name":"PlaySound","description":"Play the sound at the entity","example":"bomb PlaySound( \"zmb_bomb_explode\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true}]}]},{"name":"PlaySoundAtPosition","description":"Play the sound alias from a position","example":"PlaySoundAtPosition(\"Dirt_skid\", ( 100, 100, 0 ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"position","description":"The point where the sound is played","mandatory":true}]}]},{"name":"PlaySoundOnTag","description":"Play the sound alias as if coming from the tag","example":"self PlaySoundOnTag( soundAlias, \"J_Head\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play, this can be the string name, or the integer hash","mandatory":true},{"name":"tag","description":"If present, the sound will play at the position of the given tag","mandatory":false},{"name":"team","description":"If present or not undefined the sound will only be heard by the specified team","mandatory":false},{"name":"ent","description":"If present the sound will also be heard on the specified entity","mandatory":false}]}]},{"name":"PlaySoundToAllButPlayer","description":"Play the sound alias as if coming from the entity, so that everyone but one player can hear it","example":"self PlaySoundToAllButPlayer( \"frag_out\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string)","mandatory":true},{"name":"player","description":"The player that will not be able to hear the sound. (entity)","mandatory":true}]}]},{"name":"PlaySoundToPlayer","description":"Play the sound alias as if coming from the entity, so that only one player can hear it","example":"self PlaySoundToPlayer( \"frag_out\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string) or the sound alias (int)","mandatory":true},{"name":"player","description":"The player that will be able to hear the sound. (entity)","mandatory":true}]}]},{"name":"PlaySoundToTeam","description":"Play the sound alias as if coming from the entity, so that only one team can hear it","example":"self PlaySoundToTeam( \"frag_out\", \"axis\", self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"teamname","description":"The team that will be able to hear the sound. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true},{"name":"ignoreplayer","description":"If present, this player will not hear the sound.","mandatory":false}]}]},{"name":"PlaySoundWithNotify","description":"Play the sound alias as if coming from the entity","example":"self PlaySoundWithNotify(\"Dirt_skid\",\"skidsound\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play","mandatory":true},{"name":"notification string","description":"If present, the sound will notify this string on this entity when done.stopsounds","mandatory":false},{"name":"tag","description":"If present, the sound will play at the position of the given tag","mandatory":false}]}]},{"name":"PositionQuery_Filter_Directness","description":"Directness filter compute the direction information for each of the positions, relative to and .","example":"PositionQuery_Filter_Directness( queryResult, self.origin, self.enemy.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function. each point contained here will have direction info computed.","mandatory":true},{"name":"origin","description":"usually the position of AI before move.","mandatory":true},{"name":"target","description":"the position AI is trying to approach.","mandatory":true},{"name":"resultVarName","description":"by default the result directness value will be stored in pointStruct.directness, but can be override by this string.","mandatory":false}]}]},{"name":"PositionQuery_Filter_DistanceToGoal","description":"Calculate the distance to .goalpos. If the point is in .goalradius, the distance will be 0. the result is in pointStruct.distToGoal","example":"PositionQuery_Filter_DistanceToGoal( queryResult, self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function.\"","mandatory":true},{"name":"entity","description":"the entity used to check goal.\"","mandatory":true}]}]},{"name":"PositionQuery_Filter_InClaimedLocation","description":"Check if the locations are inside other sentients claimed locations .inClaimedLocation.","example":"PositionQuery_Filter_InClaimedLocation( queryResult, self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function.\"","mandatory":true},{"name":"entity","description":"the entity used to check goal.\"","mandatory":true}]}]},{"name":"PositionQuery_Filter_Sight","description":"Sight filter do sight check on each of the positions to a target position, and store the result in pointStruct.visibility (boolean).","example":"PositionQuery_Filter_Sight( queryResult, self.enemy.origin, self GetEye() - self.origin, self, 30, self.enemy );","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"queryStruct","description":"result from PositionQuery_Source function. each point contained here will be used to check sight against . \"","mandatory":true},{"name":"targetPosition","description":"the position to check sight.\"","mandatory":true},{"name":"offset","description":"offset to add on each point before sight checking. this is usually something like: offset = ai GetEye() - ai.origin. default to (0,0,0). \"","mandatory":false},{"name":"visibleBy_Ent","description":"if defined, the corresponding sight check function on Actor or Vehicle will be called. Otherwise the checks just do simple bullet tracing.\"","mandatory":false},{"name":"numOfPassedToEarlyOut","description":"if defined and bigger than 0, the filter will early out after found this many passed sight checks. this is useful if the points are pre sorted by score and we don't care about lower scored ones.\"","mandatory":false},{"name":"ignoreEnt","description":"ignore entity during trace. if [visibleBy_Ent] is defined, it is already ignored internally. \"","mandatory":false},{"name":"resultVarName","description":"by default the results will be stored in pointStruct.visibility, but can be override by this string. \"","mandatory":false}]}]},{"name":"PositionQuery_Source_Navigation","description":"Generate points around , between and and within height difference. For ground AI, the points will be on Nav Mesh; for flying AI, the points will be in Nav Volume. Only the points in pathable area will be kept. If the itself is in pathable area, all the points are guaranteed to be reachable from . If the is outside pathable area, all the points will still be in pathable areas surrounding , but reach-abilities cannot be guaranteed.","example":"queryResult = PositionQuery_Source_Navigation( goalpos, self.radius, self.radius * 8, heightRadius, AI_GOAL_POINT_STEP, self, AI_GOAL_POINT_STEP * 0.2 )if ( queryResult.centerOnNav ){foreach( pointStruct in queryResult.data ){position = pointStruct.origindist = pointStruct.distToOrigin2D...}}","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Position to start the search around.","mandatory":true},{"name":"minSearchRadius","description":"the minimum radius away from origin.","mandatory":true},{"name":"maxSearchRadius","description":"the maximum radius away from origin. can equal to minSearchRadius.","mandatory":true},{"name":"halfHeight","description":"the max height difference (both positive and negative) away from origin.","mandatory":true},{"name":"innerSpacing","description":"the distance between points in.","mandatory":true},{"name":"reachableBy_Ent","description":"if defined, it will be used to make sure all the points are reachable by this entity from (not the entity's current position). Can pass in a float number radius to get points on NavMesh. Can also pass in string 'navvolume_small' or 'navvolume_big' to get points on navvolume. Note passing in entity radius only gives rough estimate, not correct result.","mandatory":false},{"name":"outerSpacing","description":"if defined, the distance between points will be Lerped from to [outerSpacing], to create a gradual distribution.","mandatory":false},{"name":"distributionBias","description":"(vec2) if defined, the density of the points will be changed gradually along the direction of this vector. the magnitude will be use as scalar, with 1 being the norm scale.","mandatory":false}]}]},{"name":"PositionWouldTelefrag","description":"Returns true if the passed in origin would telefrag a player if another player was spawned there.","example":"if ( PositionWouldTelefrag( spawnpoints[i].origin ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of the potential spawn point","mandatory":true}]}]},{"name":"PrecacheLeaderboards","description":"Precache a sp/mp leaderboard.","example":"PrecacheLeaderboards( \"LB_KILLS LB_WINS LB_TOTALXP LB_ACCURACY\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"leaderboard names","description":"The name of the leaderboards to precache","mandatory":true}]}]},{"name":"PredictGrenade","description":"Predict where the grenade (self) will explode.","example":"grenade PredictGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"grenade","description":null},"parameters":[]}]},{"name":"PredictPosition","description":"Predict position of the entity at the end of the frames","example":"prediction = PredictPosition( ent, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"ent","description":"The entity to predict position of","mandatory":true},{"name":"frames","description":"The frame count","mandatory":true}]}]},{"name":"PredictSpawnPoint","description":"Indicates to the Texture Streamer where we expect to spawn in.","example":"player predictSpawnPoint( origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"The origin to spawn at","mandatory":true},{"name":"angles","description":"The angle.","mandatory":true}]}]},{"name":"Print","description":"Development only - write to the console","example":"Print( \"Stuff and things!\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"text to be written","mandatory":true}]}]},{"name":"PrintLn","description":"Development only - write line to the console","example":"PrintLn( \"I could be doing better!\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"text","description":"text to be written","mandatory":true}]}]},{"name":"PropagateCurrentEvent","description":"Propagate the current event to other AI.","example":"point = self PropagateCurrentEvent()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai_or_player","description":null},"parameters":[]}]},{"name":"QSortScoredSpawnPointsAscending","description":"Sort the scored spawn points in an ascending order","example":"sorted_spawn_points = QSortScoredSpawnPointsAscending( scored_spawn_points )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"input_array","description":"The array of points","mandatory":true}]}]},{"name":"queuemeleeactionstate","description":"Sets the queued action state to melee for the player's default hand.","example":"player QueueMeleeActionState()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"RadiusDamage","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"RecordBreadcrumbDataForPlayer","description":"record a breadcrumb data point for player at time","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"RefreshShieldAttachment","description":"Re-attach the shield model to the player.","example":"player RefreshShieldAttachment()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"RegisterClientField","description":"Register a client field. Client fields are variable bit length fields communicated from server to client.","example":"RegisterClientField(\"world\", \"my_field\", 2, \"int\"); // registers a world int field with 2 bits of resolution, that can hold the values 0,1,2,3.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"Client field pool name","description":"Which pool the field is allocated from. Currently supported : \"world\", \"actor\", \"vehicle\", \"scriptmover\"","mandatory":true},{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"version","description":"Number indicating version this field was added in - see _version.gsh for defines.","mandatory":true},{"name":"num bits","description":"How many bits to use for the field. Valid values are in the range of 1-32. Only ask for as many as you need.","mandatory":true},{"name":"type","description":"Type of the field. Currently supported types \"int\" or \"float\"","mandatory":true}]}]},{"name":"RegisterSkipto","description":"Register a new skipto name","example":"struct.code_index = RegisterSkipto( msg )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"skipto_name","description":"The skipto name to register","mandatory":true}]}]},{"name":"ReleaseClaimedTrigger","description":"Release a currently claimed trigger","example":"self.trigger releaseClaimedTrigger()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"RemoveForceNoCull","description":"Removes the force-no-cull flag. Entity will now be culled by portals","example":"helicopter RemoveForceNoCull()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"RemoveInfluencer","description":"Removes the given influencer","example":"RemoveInfluencer( influencer_id )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer to remove","mandatory":true}]}]},{"name":"RemoveNoSunShadow","description":"Removes the no-sunshadow flag.","example":"helicopter RemoveNoSunShadow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ReportUser","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetAILimit","description":"Clears any previous restrictions on the max number of AI.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetDestructible","description":"Resets the destructible entity back to its start state","example":"vehicle ResetDestructible()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ResetDoubleJumpRechargeTime","description":"Resets the double jump recharge timer as if the player had just used it","example":"player ResetDoubleJumpRechargeTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetFOV","description":"Replace the current FOV by the default FOV","example":"player ResetFOV()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetGlass","description":"Server side glass struct loops through all glass and resets to inital state","example":"ResetGlass()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetMissileDetonationTime","description":"Resets the timer for a grenade or missile to its max fuse time.","example":"grenadeEnt ResetMissileDetonationTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"time","description":"Override the reset timer from the weapon and specify the time left.","mandatory":false}]}]},{"name":"ReviveObituary","description":"Create an revive obituary for a character","example":"Obituary( self )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"victim","description":"The victim entity","mandatory":true}]}]},{"name":"Rotate","description":"Causes a script entity to rotate, rotating around its origin","example":"self Rotate( rotationVir )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"rotation vector","description":"The direction of the bobbing","mandatory":true}]}]},{"name":"RotatePitch","description":"Rotate this entity to the given pitch","example":"treeorg RotatePitch( -5, 0.26, 0.15, 0.1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"pitch angle","description":"The new pitch angle in degrees","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateRoll","description":"Rotate this entity to the given roll angle","example":"self RotateRoll( (2 * 1500 + 3 * Randomfloat( 2500 )) * -1, 5, 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"model_origin_brushmodel","description":null},"parameters":[{"name":"roll angle","description":"The new roll angle in degrees","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateTo","description":"Rotate this entity to the given world rotation value","example":"shutter RotateTo( (shutter.angles[0], newYaw, shutter.angles[2]), newTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"angles","description":"The new world angle to rotate to","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateVelocity","description":"Rotate this entity at a particular velocity for a given time","example":"self RotateVelocity( (x,y,z), 12 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"rotate velocity","description":"The rotational velocity to rotate","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"RotateYaw","description":"Rotate this entity to the given yaw","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"yaw angle","description":"The new yaw angle in degrees","mandatory":true},{"name":"time","description":"The time to rotate in seconds","mandatory":true},{"name":"acceleration time","description":"The time spent accelerating in seconds","mandatory":false},{"name":"deceleration time","description":"The time spent decelerating in seconds","mandatory":false}]}]},{"name":"ScreenShake","description":"Create a screen shake event on the given point.","example":"ScreenShake( jolt.origin, 0.3, 0.3, 0.3, 3, 0.2, 3, 850, 0.5, 0.25, 0.25 ); // locationalScreenShake( (0,0,0), 0.3, 0.3, 0.3, 3, 0.2, 3, 0, 0.5, 0.25, 0.25, player ); // non locational for one player only","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sourcePoint","description":"The position of the earthquake.","mandatory":true},{"name":"scalepitch","description":"The scale of the shake in player's pitch. Max is 100; Accurate to 2 decimal places.","mandatory":true},{"name":"scaleyaw","description":"The scale of the shake in player's yaw. Max is 100; Accurate to 2 decimal places.","mandatory":true},{"name":"scaleroll","description":"The scale of the shake in player's roll. Max is 100; Accurate to 2 decimal places.","mandatory":true},{"name":"duration","description":"Duration in seconds.","mandatory":true},{"name":"durationfadeup","description":"Duration in seconds, included in base duration. Default is 0. Value of -1 means duration - durationfadeup.","mandatory":false},{"name":"durationfadedown","description":"Duration in seconds, included in base duration. Default is -1. Value of -1 means duration - durationfadedown.","mandatory":false},{"name":"radius","description":"The radius of shake, dampens as you move away from entity. Default is 0 = shake is global","mandatory":false},{"name":"frequencypitch","description":"The scaled speed of the shake's pitch. Default is 1. Max is 100; Accurate to 2 decimal places.","mandatory":false},{"name":"frequencyyaw","description":"The scaled speed of the shake's yaw. Default is 1. Max is 100; Accurate to 2 decimal places.","mandatory":false},{"name":"frequencyroll","description":"The scaled speed of the shake's roll. Default is 1. Max is 100; Accurate to 2 decimal places.","mandatory":false},{"name":"exponent","description":"The scale is multiplied by itself 'exponent' times to determine how the shake falls off. Default is 1 which is a linear falloff. Max is 100; Accurate to 2 decimal places","mandatory":false},{"name":"target","description":"Target is given if screen shake is to be shown to particular client only","mandatory":false}]}]},{"name":"SendFaceEvent","description":"Broadcast to the client a face event","example":"self SendFaceEvent( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"index","description":"Face event index (string)","mandatory":true}]}]},{"name":"SendKillstreakDamageEvent","description":"Send a killstreak damage event to the client","example":"killstreakOwner SendKillstreakDamageEvent( 25 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"damage","description":"How much damage was done","mandatory":false}]}]},{"name":"ServerFieldGetValue","description":"Get the value of a serverfield from a given player","example":"ServerFieldGetValue(self, \"my_field\"); ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"player to get value from","mandatory":true},{"name":"name","description":"name of field to retrieve","mandatory":true}]}]},{"name":"serverfieldregister","description":"Register a server field. Server fields are variable bit length fields communicated from client to server","example":"RegisterServerField(\"my_field\", 2, \"int\"); // registers an int field with 2 bits of resolution, that can hold the values 0,1,2,3.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"Unique name to identify the field.","mandatory":true},{"name":"num bits","description":"How many bits to use for the field. Valid values are in the range of 1-32. Only ask for as many as you need.","mandatory":true},{"name":"type","description":"Type of the field. Currently supported types \"int\" or \"float\"","mandatory":true},{"name":"callback","description":"Function that gets called when the value changes (each client can toggle this bit independently of the others)","mandatory":true}]}]},{"name":"ServiceEvent","description":"Set the specified event to serviced.","example":"point = self ServiceEvent( 100 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"eventId","description":"The identifier of the event (integer)","mandatory":true}]}]},{"name":"ServiceEventsInRadius","description":"Set the events within a radius to serviced.","example":"self ServiceEventsInRadius( self.origin, 500 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ai","description":null},"parameters":[{"name":"origin","description":"Source position","mandatory":true},{"name":"radius","description":"Radius of events to service (-1 for all)","mandatory":true}]}]},{"name":"SessionModeAbbreviation","description":"Returns abbreviation of the current session mode, or \"default\" if none","example":"spawnpointname = SessionModeAbbreviation() + \"_frontend_camera","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsCampaignGame","description":"Returns true/false if the current session mode is a campaign game","example":"if ( SessionModeIsCampaignGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsCampaignZombiesGame","description":"Returns true/false if the current session mode is a campaign game and the campaign mode is set to zombies.","example":"if ( SessionModeIsCampaignZombiesGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsMultiplayerGame","description":"Returns true/false if the current session mode is a multiplayer game","example":"if ( SessionModeIsMultiplayerGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsOnlineGame","description":"Returns true/false if the current session mode is onlinegame","example":"if ( SessionModeIsOnlineGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsPrivate","description":"Returns true/false if the current session mode is a private game","example":"if ( SessionModeIsPrivate() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsPrivateOnlineGame","description":"Returns true/false if the current session mode is a private onlinegame","example":"if ( SessionModeIsPrivateOnlineGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsSystemlink","description":"Returns true/false if the current session mode is a systemlink game","example":"if ( SessionModeIsSystemlink() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SessionModeIsZombiesGame","description":"Returns true/false if the current session mode is a zombies game","example":"if ( SessionModeIsZombiesGame() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetActorWeapon","description":"Sets the actor weapon.","example":"self SetActorWeapon( \"weapon_name\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weaponname","description":"The weapon name. (string)","mandatory":true},{"name":"weapon options","description":"options value computed using calcweaponoptions","mandatory":false}]}]},{"name":"SetAILimit","description":"Allows you to specify a max number of active AI - which over-rides the MAX_AI functionality in the engine, when it comes time to spawn in new AI. Setting the value higher will not give you more AI than the system supports.","example":"SetAILimit( 10 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetAISpread","description":"Sets the spread of this turret when used by an AI","example":"roof_turret SetAISpread( 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"spread","description":"The spread of the turret in degrees","mandatory":true}]}]},{"name":"SetAnim","description":"Restart\": These functions cause the animation to restart. If they had been previously playing, without this they would continue from their current time.","example":"self SetAnim( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimForceNew","description":"Debug only functionality that adds a new instance of an animation to an animtree setting its time to a specific point.","example":"self SetAnimForceNew( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to set this animation to after adding it. Defaults to 0.","mandatory":false},{"name":"goalTime","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnob","description":"See \"SetAnim.","example":"self SetAnimKnob( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAll","description":"See \"SetAnim.","example":"self SetAnimKnobAll( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAllLimited","description":"See \"SetAnim.","example":"self SetAnimKnobAllLimited( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAllLimitedRestart","description":"See \"SetAnim.","example":"self SetAnimKnobAllLimitedRestart( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobAllRestart","description":"See \"SetAnim.","example":"self SetAnimKnobAllRestart( %precombatrun1, %body, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"root","description":"An ancestor of the animation.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobLimited","description":"See \"SetAnim.","example":"self SetAnimKnobLimited( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobLimitedRestart","description":"See \"SetAnim.","example":"self SetAnimKnobLimitedRestart( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimKnobRestart","description":"See \"SetAnim.","example":"self SetAnimKnobRestart( %precombatrun1, 1, 0.1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"The animation or animtree node to change.","mandatory":true},{"name":"weight","description":"Goal weight of this animation. Defaults to 1.0.","mandatory":false},{"name":"time","description":"Time to transition to this weight in seconds. Defaults to 0.2.","mandatory":false},{"name":"rate","description":"Playback rate of the animation. Defaults to 1.0.","mandatory":false}]}]},{"name":"SetAnimTime","description":"Get the animation time for the given animation.","example":"if ( (self GetAnimTime( %walk_and_run_loops ) ) < 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"animation to manipulate","mandatory":true}]}]},{"name":"SetAnimTimeByName","description":"Set the animation normalized time for the given animation.","example":"self SetAnimTimeByName( \"ai_anim_walk\", 0.5)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"animation","description":"animation to manipulate","mandatory":true},{"name":"time","description":"0->1","mandatory":true}]}]},{"name":"SetArchive","description":"deprecated function, does nothing","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetAssassinationEnabled","description":"Enable or disable assassinations on the AI. Also turns on/off the can assassinate indicator.","example":"quadtank SetAssassinationEnabled( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"Whether to use infrared material or not (boolean)","mandatory":true}]}]},{"name":"SetAttachmentCosmeticVariantIndex","description":"Set the attachment cosmetic variant index for the weapon","example":"level.weapon_clientscript_cac_model[type] SetAttachmentCosmeticVariantIndex( weaponFullName, level.attachment_names[i], 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"weapon","description":null},"parameters":[{"name":"weapon","description":"The weapon full name","mandatory":true},{"name":"attachment name","description":"The attachment name of the weapon","mandatory":true},{"name":"acvi","description":"The attachment cosmetic variant index","mandatory":true}]}]},{"name":"SetAttachmentCosmeticVariantIndexes","description":"Sets the previously calculated SetAttachmentCosmeticVariantIndexes of the entity. The entity should not be a player","example":"killcamEnt SetAttachmentCosmeticVariantIndexes( acvi )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"acvi","description":"The AttachmentCosmeticVariantIndexes to set","mandatory":true}]}]},{"name":"SetAttachmentCosmeticVariants","description":"Set the AttachmentCosmeticVariantIndexes data to be passed in to the weapon","example":"SetAttachmentCosmeticVariants( \"mp7_mp\", \"acog\", 2, \"grip\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponname","description":"the name of the base weapon to return","mandatory":true},{"name":"attachmentname_1","description":"the name of the first attachment","mandatory":false},{"name":"variantindex_1","description":"the index of the cosmetic variant to use for the first attachment","mandatory":false},{"name":"attachmentname_2","description":"the name of the second attachment","mandatory":false},{"name":"variantindex_2","description":"the index of the cosmetic variant to use for the second attachment","mandatory":false},{"name":"attachmentname_3","description":"the name of the third attachment","mandatory":false},{"name":"variantindex_3","description":"the index of the cosmetic variant to use for the third attachment","mandatory":false},{"name":"attachmentname_4","description":"the name of the fourth attachment","mandatory":false},{"name":"variantindex_4","description":"the index of the cosmetic variant to use for the fourth attachment","mandatory":false},{"name":"attachmentname_5","description":"the name of the fifth attachment","mandatory":false},{"name":"variantindex_5","description":"the index of the cosmetic variant to use for the fifth attachment","mandatory":false},{"name":"attachmentname_6","description":"the name of the sixth attachment","mandatory":false},{"name":"variantindex_6","description":"the index of the cosmetic variant to use for the sixth attachment","mandatory":false},{"name":"attachmentname_7","description":"the name of the seventh attachment","mandatory":false},{"name":"variantindex_7","description":"the index of the cosmetic variant to use for the seventh attachment","mandatory":false},{"name":"attachmentname_8","description":"the name of the eighth attachment","mandatory":false},{"name":"variantindex_8","description":"the index of the cosmetic variant to use for the eighth attachment","mandatory":false}]}]},{"name":"SetAvoidanceMask","description":"Set the avoidance mask of this Havok character.","example":"randEnemy SetAvoidanceMask(\"avoid none\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"Mask","description":"(const string) Mask must be 'avoid all', 'avoid none', 'avoid actor', 'avoid ai'(actors+vehicles), 'avoid player', or 'avoid vehicle'","mandatory":true}]}]},{"name":"SetAvoidanceProperty","description":"Set the avoidance properties of this Havok character.","example":"randAlly SetAvoidanceProperty(\"collision penalty\", 0.1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"Property","description":"(const string) Property must be 'collision penalty' or 'dodge penalty'","mandatory":true},{"name":"Value","description":"(float) The value to set the property to","mandatory":true}]}]},{"name":"SetBallPassAllowed","description":"Enables or disables ball passing for the given player.","example":"player SetBallPassAllowed( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetBlur","description":"Blur the screen over a period of time.","example":"setblur( 10.3, 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"target_blur","description":"The final blur. The value is pixels for Gaussian blur at 640x480. Must be a floating point value greater than 0.","mandatory":true},{"name":"time","description":"Time in seconds","mandatory":true}]}]},{"name":"SetBodyRenderOptions","description":"Sets the entity body, helmet and head render options.","example":"heroModel SetBodyRenderOptions( bodyRenderOptions, helmetRenderOptions, headRenderOptions )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"bodyRenderOptions","description":"The packed body render options - calculated with GetHeroBodyRenderOptions","mandatory":true},{"name":"helmetRenderOptions","description":"The packed helmet render options - calculated with GetHeroHelmetRenderOptions","mandatory":true},{"name":"headRenderOptions","description":"The packed head render options - calculated with GetHeroHeadRenderOptions","mandatory":true}]}]},{"name":"SetBombTimer","description":"Bomb timer set in the match state","example":"SetBombTimer( \"A\", 50000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag bit","description":"The flag bit to change","mandatory":true},{"name":"value","description":"The new value of the bit","mandatory":true}]}]},{"name":"SetBurn","description":"Set the entity burning for the given time","example":"self SetBurn( 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"time","description":"Time to burn for ( greater than 0 )","mandatory":true}]}]},{"name":"SetCameraSpikeActive","description":"Sets the state of a player's camera spike.","example":"player SetCameraSpikeActive( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"toggle","description":"0 for off, 1 for on","mandatory":true}]}]},{"name":"SetCanDamage","description":"Set the candamage flag for this entity - this means that it can respond to notifies from bullets and grenade hits","example":"self SetCanDamage( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"script_model, script_origin or script_brushmodel","description":null},"parameters":[{"name":"can damage","description":"The can damage flag","mandatory":true}]}]},{"name":"SetClearanceCeiling","description":"Sets a new clearance ceiling. If the value is larger than the current ceiling, cut faces will be invalidated.","example":"SetClearanceCeiling( 15.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetClientNameMode","description":"alters the way that the player name is updated, to prevent cheating by spectators altering their name to communicate with active players.","example":"SetClientNameMode( \"auto_change\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name mode","description":"either 'auto_change' or 'manual_change'","mandatory":true}]}]},{"name":"SetClone","description":"Sets the contents for the clone.","example":"clone SetClone()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetContents","description":"Sets contents of the entity to the given content","example":"reconModel SetContents( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"content","description":"The content to set for the entity","mandatory":true}]}]},{"name":"SetCullDist","description":"Set the cull distance for a level","example":"SetCullDist( 7200 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cull distance","description":"The cull distance","mandatory":true}]}]},{"name":"SetCursorHint","description":"Attach a cursor hint to the entity.","example":"self setCursorHint( cursor_hint, cursor_hint_weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetDangerous","description":"Set this node to be a dangerous node for a particular team. works only on pathnodes. ","example":"self SetDangerous( self.team, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"pathnode","description":null},"parameters":[{"name":"team","description":"Name of the team.","mandatory":true},{"name":"flag","description":"True if dangerous. False otherwise","mandatory":true}]}]},{"name":"SetDedicatedShadow","description":"Enabled or Disables dedicated shadow for a model","example":"thing SetDedicatedShadow( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True or False, enabled or disabled","mandatory":false}]}]},{"name":"SetDefaultDropPitch","description":"Set the default drop pitch that the turret attempts to return to when it is not in use.","example":"turret SetDefaultDropPitch( -90 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"pitch","description":"yaw of the turret (side to side) in degrees.","mandatory":true}]}]},{"name":"SetDemoIntermissionPoint","description":"Sets the intermission point for the demos.","example":"setDemoIntermissionPoint( spawnpoint.origin, spawnpoint.angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"SetDepthOfField","description":"Set the Depth of Field.","example":"self SetDepthOfField( 0, 0, 512, 4000, 4, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"nearStart","description":"Near start (should be greater than 0)","mandatory":true},{"name":"nearEnd","description":"Near end (should be greater than 0)","mandatory":true},{"name":"farStart","description":"Far start (should be greater than 0)","mandatory":true},{"name":"farEnd","description":"Far end (should be greater than 0)","mandatory":true},{"name":"nearBlur","description":"Near blur","mandatory":true},{"name":"farBlur","description":"Far blur","mandatory":true}]}]},{"name":"SetDoubleJumpEnergy","description":"Sets a double jump energy amount on the player","example":"player SetDoubleJumpEnergy( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"energy","description":"% energy to set on the player","mandatory":true}]}]},{"name":"SetDrawInfrared","description":"Draw this entity using infrared material when using infrared scope.","example":"helicopter SetDrawInfrared( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"Whether to use infrared material or not (boolean)","mandatory":true}]}]},{"name":"SetDvar","description":"Sets the value of a dvar.","example":"SetDvar( \"r_eyesAdjust\", \"1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string.","mandatory":true},{"name":"value","description":"The dvar value.","mandatory":true}]}]},{"name":"SetElectrified","description":"Electrify the entity for the given time","example":"self SetElectrified( 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"time","description":"Time to get electrified for ( greater than 0 )","mandatory":true}]}]},{"name":"SetEMPJammed","description":"Sets whether a player/client is affected by EMP","example":"player SetEMPJammed( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"isJammed","description":"Whether the player should be jammed or not. ( boolean )","mandatory":true}]}]},{"name":"SetEnableNode","description":"Disables or enabled this node.","example":"SetEnableNode( node, false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"the node to enable/disable","mandatory":true},{"name":"truefalse","description":"whether it should be enabled","mandatory":false}]}]},{"name":"SetEnemyModel","description":"Sets the model of the actor that actors enemies will see to the given model name","example":"dog SetEnemyModel( \"german_shepard_black\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"model name","description":"The name of the model to set this actor to","mandatory":true}]}]},{"name":"SetEntGravityTrajectory","description":"Sets the gravity trajectory type for the entity.","example":"player SetEntGravityTrajectory( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"trajectory","description":"0 = TR_GRAVITY, 1 = TR_MOON_GRAVITY","mandatory":true}]}]},{"name":"SetEntityAnimRate","description":"set the entity animation rate - ZOMBIES ONLY","example":"self SetEntityAnimRate( 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rate","description":"animation rate","mandatory":true}]}]},{"name":"SetEntityPaused","description":"Sets whether a given entity will advance normally.","example":"ent SetEntityPaused( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"ignore","description":"Whether or not to advance normally.","mandatory":true}]}]},{"name":"SetEntityWeapon","description":"Set weapon ent field from script.","example":"ent SetEntityWeapon( \"kniferang_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"SetExcludeTeamForTrigger","description":"Set the team that this trigger will not react to. Reacts to all other teams.","example":"self SetExcludeTeamForTrigger( game[\"attackers\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"team name","description":"The name of the team that the trigger will not respond to. Must be either 'axis', 'allies', 'team3', 'team4', 'team5', 'team6' or 'none'","mandatory":true}]}]},{"name":"SetExpFog","description":"Creates an exponential fog.","example":"SetExpFog(.0001144, 131/255, 116/255, 71/255, 0)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"startDist","description":"The distance, in world units, at which the fog begins.","mandatory":true},{"name":"halfwayDist","description":"The distance, beyond the startDist, at which the scene will be 50% fogged.","mandatory":true},{"name":"red","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"green","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"blue","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"transition time","description":"transition time in seconds","mandatory":true}]}]},{"name":"SetFakeFire","description":"Simulates gun fire. Sound and radar blip.","example":"entity SetFakeFire( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetForceNoCull","description":"Sets the force-no-cull flag. Entity will not be culled by portals","example":"helicopter SetForceNoCull()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetFOVForKillcam","description":"Sets the fov for use with this killcam entity. Setting it to zero makes it use the default fov.","example":"killCamEnt SetFOVForKillcam( 25 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"fov","description":"The fov you want to use for the killcam","mandatory":true}]}]},{"name":"SetGameEndTime","description":"Sets the time the current match will end","example":"setGameEndTime( getTime() + int(timeLeft) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"time","description":"The time to set","mandatory":true}]}]},{"name":"SetGametypeSetting","description":"Sets the value of a gametype setting.","example":"SetGametypeSetting( \"timeLimit\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"setting","description":"The setting name as a string.","mandatory":true},{"name":"value","description":"The new value for the setting.","mandatory":true}]}]},{"name":"SetGrapplableType","description":"Set how an entity is grappled.","example":"platform SetGrapplableType( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetGravity","description":"sets the gravity in inches per second per second.","example":"SetGravity( 800 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"gravity","description":"The gravity to set","mandatory":true}]}]},{"name":"SetHideonClientWhenScriptedAnimCompleted","description":"hides the entity on the client side onces its scripted animation ends","example":"SetHideonClientWhenScriptedAnimCompleted( ent )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"An entity","mandatory":true}]}]},{"name":"SetHighDetail","description":"Enabled or Disables High Detail rendering for a model","example":"thing SetHighDetail( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True or False, enabled or disabled","mandatory":false}]}]},{"name":"SetHintLowPriority","description":"Sets this as a low priority hint which is lower priority then everything other then turrets and dropped weapons","example":"m_e_hack_trigger SetHintLowPriority( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"bool","description":"True\\False if its on or off","mandatory":true}]}]},{"name":"SetHintString","description":"Set the hint string for the entity","example":"t_door SetHintString( \"Press and Hold ^3[{+activate}]^7 to transmit unlock code\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"hint string","description":"The hint string that will be displayed to the player","mandatory":true},{"name":"...","description":"Additional arguments may be appended to the hint string","mandatory":false}]}]},{"name":"SetHintStringForPerk","description":"Shows this hint string to the player if the player has the specified perk","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"perk","description":"The perk that the player needs to have to see this hint string","mandatory":true},{"name":"hint string","description":"The hint string that will be displayed to the player that has the perk","mandatory":true}]}]},{"name":"SetHintStringForPlayer","description":"Sets the trigger hint string for one specific player","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player that will see the hint string","mandatory":true},{"name":"hint string","description":"The hint string that will be displayed to the player","mandatory":true},{"name":"...","description":"Additional arguments may be appended to the hint string in the same way as SetHintString.","mandatory":false}]}]},{"name":"SetIgnoreEntForTrigger","description":"Ignores this entity when doing trigger sight traces. Currently only works for trigger_radius_use","example":"self SetIgnoreEntForTrigger( camera_spike_ent )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"entity to ignore","description":"The entity that will be ignored during sight trace checks","mandatory":true}]}]},{"name":"SetIgnorePauseWorld","description":"Sets whether a given entity will advance normally when the world is paused.","example":"ent SetIgnorePauseWorld( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"ignore","description":"Whether or not to advance normally when the world is paused.","mandatory":true}]}]},{"name":"SetIncludeMeshes","description":"Sets a streamer hint entity to include mesh data","example":"self setIncludeMeshes( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"SetInfluenceAt","description":"Sets the influence value on the influence map, returns true/false if the value was set.","example":"SetInfluenceAt(influenceMapIndex, origin, influence)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influenceMapIndex","description":"Index of the influence map","mandatory":true},{"name":"origin","description":"The location to set the influence value","mandatory":true},{"name":"influence","description":"The influence value to set","mandatory":true}]}]},{"name":"SetInfluencerTeamMask","description":"Sets the team mask for the given influencer","example":"SetInfluencerTeamMask( influencer_id, team_mask )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer id","mandatory":true},{"name":"team mask","description":"The team mask to apply","mandatory":true}]}]},{"name":"SetInfluencerTimeout","description":"Sets the timeout for the influencer in seconds from current time","example":"SetInfluencerTimeout( influencer_id, 2.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"influencer id","description":"The influencer id","mandatory":true},{"name":"time","description":"The timeout for the influencer","mandatory":true}]}]},{"name":"SetInfraredVision","description":"Switches using the infrared vision (infrared visionset and thermal characters)","example":"player SetInfraredVision( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"is infrared vision","description":"Whether using infrared vision","mandatory":true}]}]},{"name":"SetInitialPlayersConnected","description":"Set initialPlayersConnected bool in match state to true","example":"SetInitialPlayersConnected()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetInvisibleToAll","description":"Set entity invisible to all players","example":"use_trigger SetInvisibleToAll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetInvisibleToPlayer","description":"Make the entity invisible to the player","example":"hackable._trigger SetInvisibleToPlayer( player, false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to set the entity invisible to.","mandatory":true},{"name":"setInvisible","description":"True if entity has to be invisible to player. False otherwise","mandatory":false}]}]},{"name":"SetJumpHeight","description":"Set the global jump height of all players. Minimum value of 0, maximum value of 1023.","example":"SetJumpHeight( 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"height_in_inches","description":"The height to jump in inches","mandatory":true}]}]},{"name":"SetLightColor","description":"Sets the current color of the light, as an RGB vector.","example":"self SetLightColor( (0.5, 0.75, 1.0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"color","description":"An RGB vector with components in the range 0 to 1. The given values get rounded before they are stored. (vector3)","mandatory":true}]}]},{"name":"SetLightExponent","description":"Sets the current exponent of the light.","example":"self SetLightExponent( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"exponent","description":"A new value for the exponent of the light. This should be an integer in the range of 0 to 100. (integer)","mandatory":true}]}]},{"name":"SetLightFovRange","description":"Sets the current fov range of the light.","example":"self SetLightFovRange( 200, 50 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"fov_outer","description":"A new value for the outer FOV of the light, in degrees. This cannot be larger than the fov when the map was compiled, or less than 1. (float)","mandatory":true},{"name":"fov_inner","description":"A new value for the inner FOV of the light, in degrees. This cannot be larger than fov_outer, or less than 0. If not specified, the map value is used. (float)","mandatory":false}]}]},{"name":"SetLightingOnly","description":"Sets a streamer hint entity to only hint lighting data","example":"self SetLightingOnly( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"SetLightingState","description":"Changes lighting state for the map","example":"SetLightingState( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"new light state","description":"new state to change to. Lighting state defaults to 1 at start of game","mandatory":true}]}]},{"name":"SetLightIntensity","description":"Sets the current intensity of the light.","example":"self SetLightIntensity( 1.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"intensity","description":"A new value for the intensity of the light. 1 is fullbright, but values can be larger than 1. (float)","mandatory":true}]}]},{"name":"SetLightRadius","description":"Sets the current radius of the light.","example":"self SetLightRadius( 200 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"light","description":null},"parameters":[{"name":"radius","description":"A new value for the radius of the light. This cannot be larger than the radius when the map was compiled. (float)","mandatory":true}]}]},{"name":"SetMapCenter","description":"Set the center of the map (used by the network code to optimize position data)","example":"SetMapCenter( level.mapCenter )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mapCenter","description":"The map center","mandatory":true}]}]},{"name":"SetMatchFlag","description":"Flags a bit in the match state","example":"SetMatchFlag( \"bomb_timer\", \"1\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flag bit","description":"The flag bit to change","mandatory":true},{"name":"value","description":"The new value of the bit","mandatory":true}]}]},{"name":"SetMatchTalkFlag","description":"Flags a bit in the match talk state","example":"SetMatchTalkFlag( \"DeadChatWithDead\", \"1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag bit","description":"The flag bit to change","mandatory":true},{"name":"value","description":"The new value of the bit","mandatory":true}]}]},{"name":"SetmaxHealth","description":"Sets the max health of this entity","example":"self SetMaxHealth( required_amount )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"health","description":"The new max health","mandatory":true}]}]},{"name":"SetMiniMap","description":"Sets the minimap bounds and material","example":"setMiniMap(material, northwest[0], northwest[1], southeast[0], southeast[1])","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"material","description":"Sets the material","mandatory":true},{"name":"upperLeftX","description":"Upper left X value","mandatory":true},{"name":"upperLeftY","description":"Upper left Y value","mandatory":true},{"name":"lowerRightX","description":"Lower right X value","mandatory":true},{"name":"lowerRightY","description":"Lower right Y value","mandatory":true}]}]},{"name":"SetMissileBrake","description":"Tells a remote missile to disable brake","example":"missile DisableMissileBrake( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{"name":"flag","description":"True to enable or disable missile brake.","mandatory":true}]}]},{"name":"SetMissileCoasting","description":"Tells a remote missile to start coasting at a reduced speed.","example":"missile SetMissileCoasting( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{"name":"flag","description":"True to start coasting at reduced speed.","mandatory":true}]}]},{"name":"SetMissileOwner","description":"Sets the missile entity owner.","example":"grenade SetMissileOwner( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"missile","description":null},"parameters":[{}]}]},{"name":"SetMode","description":"Set the mode of a turret.","example":"turret SetMode( \"auto_ai\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"mode","description":"The turret mode. Possible modes are \"auto_ai\", \"manual\", \"manual_ai\" and \"auto_nonai","mandatory":true}]}]},{"name":"SetModel","description":"Set the model for the entity","example":"raps_meteor SetModel( \"veh_t7_drone_raps\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"model alias","description":"Name of the model","mandatory":true}]}]},{"name":"SetMoveSpeedScale","description":"Sets the speed scale multiplier for the entity","example":"self SetMoveSpeedScale( HOLDING_CRATE_MOVEMENT_SPEED )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"speed scale multiplier","description":"The speed scale multiplier (float)","mandatory":true}]}]},{"name":"SetMovingPlatformEnabled","description":"Enbles the moving platfrom.","example":"platform SetMovingPlatformEnabled( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SetNemesisXUID","description":"Sets the Nemesis XUID","example":"player setNemesisXuid( player.pers[\"nemesis_xuid\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"nemesisXuidString","description":"The Nemesis XUID string","mandatory":true}]}]},{"name":"SetNodePriority","description":"Enable or disable the priority for this node.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"(node) A priority allowed node.","mandatory":true},{"name":"enable","description":"(boolean) True if this node is enabled.","mandatory":true}]}]},{"name":"SetNormalHealth","description":"Set health of entity. Input health is normalized.","example":"self SetNormalHealth( 0.8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"normal health","description":"Health in normalized form. Range 0 - 1","mandatory":true}]}]},{"name":"SetNoSunShadow","description":"Sets the no-sunshadow flag.","example":"helicopter SetNoSunShadow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetObjectivePointStatus","description":"Objective status set in the match state","example":"SetObjectivePointStatus( 1, \"allies\", 80 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"objective_index","description":"The objective index in the matchstate","mandatory":true},{"name":"team","description":"The team of the objective","mandatory":true},{"name":"percent","description":"Percentage completed","mandatory":true}]}]},{"name":"SetOnTargetAngle","description":"Set the angle range at which the turret_on_target notify will occur.","example":"boat SetOnTargetAngle( 0, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"angle","description":"In degrees (float)","mandatory":true},{"name":"gunnerIndex","description":"Which gun, 0-3.","mandatory":false}]}]},{"name":"SetOwner","description":"Sets the entity owner.","example":"grenade SetOwner( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"SetPauseWorld","description":"pauses playback of animations and effects, but doesn't affect the server tick the way slomo does","example":"SetPauseWorld( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"pause","description":"Whether or not to pause the world","mandatory":true}]}]},{"name":"SetPerkForTrigger","description":"Set the perk that the player must have for this trigger will react to","example":"self SetPerkForTrigger( \"specialty_fastinteract\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"perk name","description":"The name of the perk that the trigger will respond to.","mandatory":true}]}]},{"name":"SetPlayerCollision","description":"Use to turn on off the collision with the player.","example":"self SetPlayerCollision( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"on_off","description":"True for on and false for off","mandatory":true}]}]},{"name":"SetPlayerCurrentObjective","description":"Sets the current objective information on the player","example":"SetPlayerCurrentObjective( \"flag_a\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"objective_index","description":"The objective index in the matchstate","mandatory":true},{"name":"objective_type","description":"Type of the objective","mandatory":true}]}]},{"name":"SetPlayerCurrentStreak","description":"Sets the current kill streak count on the player","example":"SetPlayerCurrentStreak( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"current streak","description":"The current kill streak count","mandatory":true}]}]},{"name":"SetPlayerGravity","description":"Sets the gravity override value for the player.","example":"player SetPlayerGravity( 600 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"gravity","description":"The gravity to set","mandatory":true}]}]},{"name":"SetPlayerIgnoreRadiusDamage","description":"Set the player to take or ignore radius damage","example":"SetPlayerIgnoreRadiusDamage( true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"flag","description":"true to ignore radius damage, false otherwise","mandatory":true}]}]},{"name":"SetPlayerSpread","description":"Sets the spread of this turret when used by the player","example":"roof_turret SetPlayerSpread( 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"spread","description":"The spread of the turret in degrees","mandatory":true}]}]},{"name":"SetPlayerStateLoadoutBonusCards","description":"Set the player state to have bonus card info, for codcaster to view it","example":"self SetPlayerStateLoadoutBonusCards( class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"SetPlayerStateLoadoutWeapons","description":"Set the player state to have primary and secondary weapon info, for codcaster to view it","example":"self SetPlayerStateLoadoutWeapons( class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom Class","description":"Class Num","mandatory":true}]}]},{"name":"SetReviveHintString","description":"Set the revive hint string to show to all or to a team.","example":"self.revivetrigger setReviveHintString( &\"GAME_BUTTON_TO_REVIVE_PLAYER\", self.team )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"hint string","description":"The hint string that will be displayed to the player that has the perk","mandatory":true},{"name":"team","description":"The team to show the hint to","mandatory":false}]}]},{"name":"SetRoundsPlayed","description":"Set rounds played in match state","example":"SetRoundsPlayed( game[\"roundsplayed\"] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"The number of rounds played","mandatory":true}]}]},{"name":"SetScale","description":"Set the model scale on a script mover.","example":"entity SetScale(2.0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"scale","description":"The scale factor. (float)","mandatory":true}]}]},{"name":"SetScanningPitch","description":"Set the pitch that the turret attempts to use while scanning for enemies.","example":"turret SetScanningPitch( -45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"pitch","description":"of the turret (up and down) in degrees.","mandatory":true}]}]},{"name":"SetScoreboardColumns","description":"Set the scoreboard columns.","example":"SetScoreboardColumns( \"score\", \"kills\", \"deaths\", \"kdratio\", \"assists\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"column1","description":"to ","mandatory":true},{"name":"...","description":"More columns if needed.","mandatory":false}]}]},{"name":"SetScriptMoverFlag","description":"Sets flag 0-7 on the script mover ent.","example":"some_script_model SetScriptMoverFlag( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"non_player_entity","description":null},"parameters":[{}]}]},{"name":"SetSessStat","description":"Sets the indicated stat","example":"self SetSessStat( \"byteStat\", 0, 12 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"stat path","description":"The path to the stat to set the value for.","mandatory":true}]}]},{"name":"SetSharedViewPort","description":"Sets the view mode to either shared or independent, shared combines all views into a single shared viewport, modifies the way input is handled, and places the camera into scripted camera mode (i.e. control it with script).","example":"SetSharedViewPort(true)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mode","description":"true if shared viewport, false for independent (default splitscreen behavior)","mandatory":true}]}]},{"name":"SetSkipTos","description":"Set skip tos","example":"SetSkiptos( ToLower( skipto ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"skipto","description":"The skipto name","mandatory":true}]}]},{"name":"SetSlowMotion","description":"sets the current slow motion timescale interpolation.","example":"SetSlowMotion( 1.0, 0.25, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"startTimescale","description":"The initial timescale.","mandatory":true},{"name":"endTimescale","description":"The final timescale. Default to 1.","mandatory":false},{"name":"deltaTime","description":"The time to go from start to end timescale. Default to 1. (in seconds)","mandatory":false}]}]},{"name":"SetSpawnClientFlag","description":"Set a flag on a client's spawn client data in the spawning system.","example":"player SetSpawnClientFlag( \"SCDFL_DISABLE_LOGGING\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flag","description":"Flag to set","mandatory":true}]}]},{"name":"SetSpawnPointRandomVariation","description":"Random value will be added into the spawn point weighting calculation.","example":"SetSpawnPointRandomVariation( 10 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variation","description":"random range will be [0, variation]","mandatory":true}]}]},{"name":"SetSpawnPointsBaseWeight","description":"If the spawn point is facing the objective position then it will have an additional score applied","example":"SetSpawnPointsBaseWeight( team_mask, point, 30, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team mask","description":"teams that this command will affect","mandatory":true},{"name":"objective position","description":"Position of the objective that will be used in the facing calculations","mandatory":true},{"name":"angle","description":"max angle that will be accepted","mandatory":true},{"name":"score","description":"additional score that will be applied","mandatory":true}]}]},{"name":"SetStableMissile","description":"Set the stable missile flag of the entity","example":"self SetStableMissile( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"Set to true if the stable flag should be set. False otherwise","mandatory":true}]}]},{"name":"SetStance","description":"Sets the stance of the player. It only works for the player.","example":"player SetStance( \"stand\" );\\","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"stance","description":"The stance. Possible values are 'crouch', 'prone' and 'stand'","mandatory":true}]}]},{"name":"SetStowedWeapon","description":"Sets the stowed weapon for the player","example":"self SetStowedWeapon( \"mp40_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weaponName","description":"The weapon name to attach (string).","mandatory":true}]}]},{"name":"SetTargetEntity","description":"Sets the target of this turret","example":"roof_turret SetTargetEntity( target )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"target","description":"the turret target","mandatory":true}]}]},{"name":"SetTargetOrigin","description":"Sets the target origin of this turret or vehicle weapon","example":"roof_turret SetTargetOrigin( origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret_or_vehicle","description":null},"parameters":[{"name":"origin","description":"the turret target origin","mandatory":true}]}]},{"name":"SetTeam","description":"Sets the entity team.","example":"panzer SetTeam( team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"SetTeamForTrigger","description":"Set the team that this trigger will react to","example":"self SetTeamForTrigger( game[\"attackers\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"team name","description":"The name of the team that the trigger will respond to. Must be either 'axis', 'allies', 'team3' or 'none'","mandatory":true}]}]},{"name":"SetTeamSatellite","description":"Sets whether a team has Spyplane or not","example":"SetTeamSatellite( \"allies\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true},{"name":"availability","description":"Whether the team has Satellite; defaults to false","mandatory":true}]}]},{"name":"SetTeamScore","description":"Set a team's score","example":"SetTeamScore( \"allies\", 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either 'axis' or 'allies' or 'team3'.","mandatory":true},{"name":"score","description":"The new team score","mandatory":true}]}]},{"name":"SetTeamSpyplane","description":"Sets whether a team has Spyplane or not","example":"SetTeamSpyplane( \"allies\", true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The name of a team. Must be either Must be 'axis', 'allies', 'team3' or 'none'.","mandatory":true},{"name":"availability","description":"Whether the team has Spyplane; defaults to false","mandatory":true}]}]},{"name":"SetTmodeProvider","description":"Enables (or disables) the actor to provide tmode traces to the player.","example":"entity SetTmodeProvider( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"value","description":"(int) 1-enable 0-disable","mandatory":true}]}]},{"name":"SetTopDownCameraYaw","description":"Set the top down camera yaw that is used in DOA to get the player controls to work correctly in bgpmove.","example":"SetTopDownCameraYaw( 180 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"yaw_angle","description":"The yaw angle to set","mandatory":true}]}]},{"name":"SetTopScorer","description":"Sets the top scorer for the end game screen.","example":"SetTopScorer( 0, player, weapon, renderoptions, acvi)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"index","description":"position [0..2] of the player","mandatory":true},{"name":"player","description":"player who is the top scorer","mandatory":true},{"name":"taunt","description":"players selected taunt index","mandatory":true},{"name":"gesture0","description":"players selected gesture type 0 index","mandatory":true},{"name":"gesture1","description":"players selected gesture type 1 index","mandatory":true},{"name":"gesture2","description":"players selected gesture type 2 index","mandatory":true},{"name":"weapon","description":"players weapon","mandatory":true},{"name":"weapon render options","description":"players weapon renderoptions","mandatory":false},{"name":"acvi","description":"players attachment cosmetic variant indexes","mandatory":false}]}]},{"name":"SetTurretAccuracy","description":"Currently does nothing.","example":"roof_turret SetTargetAccuracy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"SetTurretCarried","description":"Sets whether a turret is being carried.","example":"turret SetTurretCarried( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"flag","description":"True if the turret is being carried","mandatory":true}]}]},{"name":"SetTurretMinimapVisible","description":"Sets whether a turret is visible on the minimap.","example":"sentry SetTurretMinimapVisible( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"flag","description":"True if the turret is visible on the minimap","mandatory":true}]}]},{"name":"SetTurretNode","description":"Set this turretnode to use this turret.","example":"SetTurretNode( node, turret )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The turret node to connect to the turret","mandatory":true},{"name":"turret","description":"The turret to connect to the node","mandatory":true}]}]},{"name":"SetTurretOwner","description":"Sets the turret entity owner.","example":"turret SetTurretOwner( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{}]}]},{"name":"SetTurretSpinning","description":"Set the minigun spin for the turret on this entity. Works for vehicles also.","example":"roof_turret SetTurretSpinning( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{"name":"onoff","description":"Turn it on or off (boolean)","mandatory":true}]}]},{"name":"SetTurretType","description":"Sets the turret Type, Sentry or TOW.","example":"turret SetTurretType( \"sentry\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[{}]}]},{"name":"SetupFieldOpsKitLoadouts","description":"Sets up all the field ops custom classes (using slots 6 through 9)","example":"SetupFieldOpsKitLoadouts( mapname )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mapname","description":"The map to load the field ops kits for","mandatory":true}]}]},{"name":"SetViewAngleResistance","description":"Sets the zones in the player's view cone in which resistance will be applied in the direction of the view limit","example":"level.player SetViewAngleResistance( 40, 40, 20, 0, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"right arc","description":"Angle to resist against the right plane of the view cone.","mandatory":true},{"name":"left arc","description":"Angle to resist against the left plane of the view cone.","mandatory":true},{"name":"top arc","description":"Angle to resist against the top plane of the view cone.","mandatory":true},{"name":"bottom arc","description":"Angle to resist against the bottom plane of the view cone.","mandatory":true},{"name":"snap to","description":"false when the resistance will be blended to over time. True by default.","mandatory":false}]}]},{"name":"SetViewModelDepthOfField","description":"Set the view model depth of field of the player","example":"self SetViewModelDepthOfField(0,1000)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"start","description":"Start DOF ( >= 0 )","mandatory":true},{"name":"end","description":"End DOF ( >= 0 )","mandatory":true}]}]},{"name":"SetVisibleToAll","description":"Make the entity visible to all players","example":"trigger SetVisibleToAll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"SetVisibleToAllExceptTeam","description":"Set self visible to all teams except the selected teams","example":"plane SetVisibleToAllExceptTeam( self.team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"Which to teams not to show this entity too","mandatory":true}]}]},{"name":"SetVisibleToPlayer","description":"Make the entity visible to the player","example":"trigger SetVisibleToPlayer( self )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"player","description":"The player to set the entity visible to.","mandatory":true}]}]},{"name":"SetVisibleToTeam","description":"Set self visible only to selected team","example":"plane SetVisibleToSquad( self.team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"Which to show this entity to","mandatory":true}]}]},{"name":"SetVisionSetForPlayer","description":"Specify the server override visionset and the transition time into it.","example":"player SetVisionSetForPlayer( \"mortar_thermal\", 1.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"visionset name","description":"Vision set to transition into (string)","mandatory":true},{"name":"transition time","description":"How long, in seconds, to take transitioning to the new vision set if a transition is possible. Default is one second. (float)","mandatory":false}]}]},{"name":"SetVolFog","description":"Creates an exponential fog.","example":"SetVolFog(0.0001144, 0.01, 131/255, 116/255, 71/255, 0)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"startDist","description":"The distance, in world units, at which the fog begins.","mandatory":true},{"name":"halfwayDist","description":"The distance at which the scene will be 50% fogged.","mandatory":true},{"name":"halfwayHeight","description":"The height at which the scene will be 50% fogged.","mandatory":true},{"name":"baseHeight","description":"The ground-level Z position at which the fog will start from.","mandatory":true},{"name":"red","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"green","description":"The green component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"blue","description":"The blue component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"transition time","description":"transition time in seconds","mandatory":true},{"name":"startDist","description":"The distance, in world units, at which the fog begins.","mandatory":true},{"name":"halfwayDist","description":"The distance at which the scene will be 50% fogged.","mandatory":true},{"name":"halfwayHeight","description":"The height at which the scene will be 50% fogged.","mandatory":true},{"name":"baseHeight","description":"The ground-level Z position at which the fog will start from.","mandatory":true},{"name":"red","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"green","description":"The green component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"blue","description":"The blue component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"fogColorScale","description":"The scaler for the colors as a value between 1 and 10000.0","mandatory":true},{"name":"sunFogRed","description":"The red component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"sunFogGreen","description":"The green component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"sunFogBlue","description":"The blue component of the fog as a value between 0.0 and 1.0","mandatory":true},{"name":"sunFogDirX","description":"The X component of the fog direction as a value between -1.0 and 1.0","mandatory":true},{"name":"sunFogDirY","description":"The Y component of the fog direction as a value between -1.0 and 1.0","mandatory":true},{"name":"sunFogDirZ","description":"The Z component of the fog direction as a value between -1.0 and 1.0","mandatory":true},{"name":"sunFogStartAng","description":"The starting angle of the sun fog as a value between 0 and 180","mandatory":true},{"name":"sunFogEndAng","description":"The ending angle of the sun fog as a value between 0 and 180","mandatory":true},{"name":"fog max opacity","description":"The maximum opacity of the fog as a value between 0 and 1","mandatory":true},{"name":"transition time","description":"transition time in seconds","mandatory":true}]}]},{"name":"SetVoteNoCount","description":"Sets the number of No votes","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"no count","description":"Number of 'no' votes","mandatory":true}]}]},{"name":"SetVoteString","description":"Sets the string for a vote","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The vote string","mandatory":true}]}]},{"name":"SetVoteTime","description":"Sets the start time for a vote","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"time","description":"The vote time in ms","mandatory":true}]}]},{"name":"SetVoteYesCount","description":"Sets the number of Yes votes","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"no count","description":"Number of 'yes' votes","mandatory":true}]}]},{"name":"SetWaterDrops","description":"Sets water drops equal to the count","example":"self SetWaterDrops( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"count","description":"Number of water drops (should be >= 0)","mandatory":true}]}]},{"name":"SetWaveWaterGeneratorAmplitude","description":"Sets the wave water amplitude of the generator.","example":"SetWaveWaterGeneratorAmplitude( \"exampleGenerator\", 1.1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"generator name","description":"The generator name","mandatory":true},{"name":"amplitude","description":"The amplitude for the generator","mandatory":true}]}]},{"name":"SetWeapon","description":"Sets the weapon of the entity. The entity should not be a player","example":"killcamEnt SetWeapon( self.weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weapon","description":"The weapon to set","mandatory":true}]}]},{"name":"SetWeaponOptions","description":"Sets the previously calculated weapon options of the entity. The entity should not be a player","example":"killcamEnt SetWeaponOptions( weapon_options )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"weaponOptions","description":"The weapon options to set","mandatory":true}]}]},{"name":"SetWeaponRenderOptions","description":"Sets the weapon render options in the entity.","example":"level.weapon_clientscript_model SetWeaponRenderOptions( level.camo_index, level.reticle_index, level.show_player_tag, level.show_emblem, level.show_paintshop )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{},{},{},{},{}]}]},{"name":"SetWinningPlayer","description":"Sets a player to be the winner","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player to set as the winning player","mandatory":true}]}]},{"name":"SetWinningTeam","description":"Sets a team to be the winner","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The team name of the winning team. Must be 'axis', 'allies' or 'none'","mandatory":true}]}]},{"name":"SetWorldFogActiveBank","description":"Sets world fog volumes active bank mask.","example":"self setworldfogactivebank(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"bankMask","description":"Active bank","mandatory":true}]}]},{"name":"SetZBarrierColModel","description":"Sets the collision model for a zbarrier.","example":"ent SetZBarrierColModel(\"p6_anim_zm_barricade_board_collision\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"model","description":"The model.","mandatory":true}]}]},{"name":"SetZBarrierPieceState","description":"Set's the state of the piece indexed in the zbarrier ent. States are open, opening, closed and closing.","example":"ent SetZBarrierPieceState(1, \"open\", 0.8)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true},{"name":"state","description":"State to set - valid states are open, opening, closed and closing.","mandatory":true},{"name":"animation scalar","description":"Valid range 0.1 - 2.0, changes the playback speed of the animation in the set state - numbers less than 1.0 are faster.","mandatory":false}]}]},{"name":"SetZombieName","description":"Set this actors name","example":"guy SetZombieName( \"zombie11\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShellShock","description":"Start a shell shock sequence for the entity for given duration.","example":"self shellShock( \"frag_grenade_mp\", 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{"name":"duration","description":"duration in seconds. The duration must be between 0 and 60 seconds.","mandatory":true},{"name":"allowReduceShellShockPerk","description":"true if shell shock perk should be reduced","mandatory":false}]}]},{"name":"ShootTurret","description":"Shoots a turret","example":"roof_turret ShootTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"ShootUp","description":"Gives an entity vertical movement","example":"betty ShootUp( 350 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"float","description":"upwards velocity","mandatory":true}]}]},{"name":"ShouldDoInitialWeaponRaise","description":"Set weaponstate to force or prevent first raise animation the next time the player switches to it. Only works if the player currently has it","example":"old_state = self ShouldDoInitialWeaponRaise( \"ak47\", false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to set the first raise anim state for","mandatory":true},{"name":"bool shouldDoRaise","description":"Whether the weapon should do the initial raise","mandatory":true}]}]},{"name":"Show","description":"Show the entity","example":"self Show()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ShowAllParts","description":"Show all parts of an entity.","example":"self ShowAllParts()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ShowInfoVolume","description":"Enables an info volume to be drawn with the specified color","example":"InfoVolumeDebug_ShowVolume( info_volume GetEntityNumber(), ( 0.2, 0.2, 0.5 ), 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entnum","description":"The entity number of the info volume","mandatory":true},{"name":"rgb color","description":"The rgb color that the info volume will be drawn with","mandatory":false},{"name":"alpha","description":"The alpha that the info volume will be drawn with","mandatory":false}]}]},{"name":"ShowMiscModels","description":"Show all misc models with this targetname","example":"ShowMiscModels( \"crash_destruct\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"targetname of misc model(s).","mandatory":true}]}]},{"name":"ShowPart","description":"Show part of an entity.","example":"self ShowPart( \"tag_weapon\", \"weapon_saw\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"tagname","description":"The tag to show. All surfaces with a vertex weighted to the tag will be shown. (string)","mandatory":true},{"name":"modelname","description":"The optional model name to help specify the part location. (string)","mandatory":false},{"name":"bApplyToChildren","description":"Optional flag to specify if we should apply the operation to children bones as well. (boolean)","mandatory":false}]}]},{"name":"ShowToPlayer","description":"Show the entity to a given client","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"player","description":"The player to show the entity to.","mandatory":true}]}]},{"name":"ShowToTeam","description":"Show the entity to a particular team","example":"self ShowToTeam( team )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"team","description":"The team to show the entity to.","mandatory":true}]}]},{"name":"ShowZBarrierPiece","description":"Allows the indexed piece to be drawn.","example":"ent ShowZBarrierPiece(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"SightConeTrace","description":"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":"tankVisibilityFraction = tank SightConeTrace( player.origin, player, player.angles, 65)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"sight position","description":"The point the sight starts at","mandatory":true},{"name":"ignore entity","description":"An entity to ignore when doing the traces","mandatory":false},{"name":"cone forward","description":"The forward direction of the cone, whose base is at the . Must be normalized.","mandatory":false},{"name":"cone angle","description":"Angle in degrees from the line of sight to the edge of the cone. Defaults to 65.","mandatory":false}]}]},{"name":"SightTracePassed","description":"Does a sight trace from start to end. Returns true if doesnt hit anything","example":"passed = SightTracePassed( player.origin + ( 0, 0, 64 ), self.origin + ( 0, 0, 64 ), false, undefined )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The bullet start point","mandatory":true},{"name":"end","description":"The bullet end point","mandatory":true},{"name":"hit characters","description":"An entity to ignore","mandatory":true},{"name":"ignore entity","description":"An entity to ignore","mandatory":true}]}]},{"name":"SnapshotAcknowledged","description":"Returns 1 if all clients have acknowledged the snapshot or the timeout has expired. Otherwise returns undefined.","example":"acked = SnapshotAcknowledged( snapindices )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"The array returned by GetSnapshotIndexArray.","mandatory":true}]}]},{"name":"Solid","description":"Set the solid flag, so that this object is collidable.","example":"self Solid()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"ent","description":null},"parameters":[]}]},{"name":"SoundExists","description":"Returns true if the given sound exists","example":"if( SoundExists( soundAlias )) { //do something }","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"soundName","description":"The sound alias","mandatory":true}]}]},{"name":"SoundGetAlias","description":"The the string alias of a sound from the hashed sound id. Will return undefined if no sound is found","example":"soundAlias = SoundGetAlias( soundId )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"soundId","description":"the hashed sound id of the alias","mandatory":true}]}]},{"name":"SoundGetPlaybackTime","description":"Get the playback time for the sound","example":"playbackTime = SoundGetPlaybackTime( \"evt_infection_record_oneshot\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"soundName","description":"The sound alias","mandatory":true}]}]},{"name":"Spawn","description":"Spawn an entity.","example":"Spawn( \"trigger_radius\", trigger_origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"classname","description":"The classname of the entity to spawn","mandatory":true},{"name":"origin","description":"The position to spawn at","mandatory":true},{"name":"spawnflags","description":"Optional spawn flags (up to 5)","mandatory":false}]}]},{"name":"SpawnActor","description":"Spawns an actor from an actor spawner, if possible (the spawner won't spawn if the player is looking at the spawn point, or if spawning would cause a telefrag)","example":"spawned = SpawnActor( \"spawner_bo3_soldier_ally_sniper_tool\", origin, angles, \"george\", false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"AIType","description":"AI type (constant string)","mandatory":true},{"name":"origin","description":"The position of the vehicle (vector)","mandatory":true},{"name":"angles","description":"The angle to spawn the vehicle at (vector)","mandatory":true},{"name":"targetname","description":"sets the targetname of the spawned entity","mandatory":false},{"name":"forcespawn","description":"forces a guy to spawn even if the spawn may be visible to the player","mandatory":false},{"name":"fullyaware","description":"gives the AI full awareness of all enemies","mandatory":false},{"name":"spawnerEnt","description":"if passed in, then the fields of the spawnerEnt will be duplicated to the newly spawned actor","mandatory":false}]}]},{"name":"SpawnCollision","description":"Spawns a script mover thats used only for collision","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"modelname","description":"The name of the model to spawn (constant string)","mandatory":true},{"name":"targetname","description":"target name (constant string)","mandatory":true},{"name":"origin","description":"The position of the collision (vector)","mandatory":true},{"name":"angles","description":"The angle to spawn the collision at (vector)","mandatory":true}]}]},{"name":"SpawnFromSpawner","description":"Spawns an actor or vehicle from a spawner, if possible (the spawner won't spawn if the player is looking at the spawn point, or if spawning would cause a telefrag) Unsupplied optional fields will use flag values from the entity","example":"spawned = spawnerent SpawnFromSpawner( \"george\", false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor_or_vehicle_spawner","description":null},"parameters":[{"name":"targetname","description":"sets the targetname of the spawned entity","mandatory":false},{"name":"forcespawn","description":"forces a guy to spawn even if the spawn may be visible to the player","mandatory":false},{"name":"makeroom","description":"will remove an undeletable entity if necessary to spawn a new one","mandatory":false},{"name":"infinitespawn","description":"don't increment the spawn count","mandatory":false},{"name":"classnameOverride","description":"override the spawner's classname","mandatory":false}]}]},{"name":"SpawnFX","description":"Spawn an FX","example":"fx = SpawnFx( level._effect[player.light_playFX], monkey.origin + (0,0,-12),(1,0,0),(0,0,1) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"fx name","description":"Name of the fx. Fx has to be cached","mandatory":true},{"name":"position","description":"Position to play the fx at","mandatory":true},{"name":"forward","description":"The forward vector of the fx","mandatory":false},{"name":"up","description":"The up vector of the fx","mandatory":false}]}]},{"name":"SpawnHelicopter","description":"Spawns a helicopter","example":"heliGuard = spawnHelicopter( self, startPos, startAng, \"heli_guard_mp\" , \"veh_t6_drone_overwatch_light\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"owner","description":"the owner entity","mandatory":true},{"name":"origin","description":"the location","mandatory":true},{"name":"angles","description":"the angles","mandatory":true},{"name":"vehicle name","description":"the vehicle name","mandatory":true},{"name":"model name","description":"the model name","mandatory":true}]}]},{"name":"SpawnNapalmGroundFlame","description":"Spawn a napalm ground flame at the origin with the direction.","example":"self SpawnNapalmGroundFlame( bot_pos , weapon, forward)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"origin","description":"The origin of the flame","mandatory":true},{"name":"weapon","description":"The weapon","mandatory":true},{"name":"direction","description":"The direction of the flame","mandatory":true},{"name":"time","description":"The time to live","mandatory":false}]}]},{"name":"SpawnPathNode","description":"Spawn a dynamically created path node or cover node","example":"node = SpawnPathNode( cover_left, origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"classname","description":"The class name","mandatory":true},{"name":"origin","description":"The origin","mandatory":true},{"name":"angles","description":"The view angles","mandatory":true},{"name":"key1","description":"Key 1","mandatory":false},{"name":"value1","description":"Value for key 1","mandatory":false},{"name":"key2","description":"Key 2","mandatory":false},{"name":"value2","description":"Value for key 2","mandatory":false}]}]},{"name":"SpawnPlane","description":"Spawns a plane at the origin","example":"plane = spawnplane( owner, \"script_model\", origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"the owner","mandatory":true},{"name":"classname","description":"class of entity","mandatory":true},{"name":"origin","description":"location to spawn at","mandatory":true},{"name":"spawnflags","description":"optional spawn flags","mandatory":false}]}]},{"name":"SpawnStruct","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SpawnTimedFX","description":"Spawns a broadcast entity that plays an oriented timed FX using the weapon's property projExplosionEffect","example":"ent = SpawnTimedFX( smokeGrenade, position, directionUp, duration )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon to spawn fx on","mandatory":true},{"name":"origin","description":"the position to spawn fx at","mandatory":true},{"name":"direction","description":"default (0,0,1)","mandatory":false},{"name":"time","description":"default 10 seconds","mandatory":false},{"name":"team","description":"defaults to TEAM_FREE","mandatory":false}]}]},{"name":"SpawnTurret","description":"Unsupported function. Do not use.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SpawnVehicle","description":"Spawns a new vehicle and returns a reference to it","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vehicletype","description":"vehicle type (constant string)","mandatory":true},{"name":"origin","description":"The position of the vehicle (vector)","mandatory":true},{"name":"angles","description":"The angle to spawn the vehicle at (vector)","mandatory":true},{"name":"targetname","description":"vehicle target name (constant string)","mandatory":false},{"name":"destructibledef","description":"The destructibledef to use to make this vehicle a destructible","mandatory":false}]}]},{"name":"StartBinocs","description":"Start Binoculars on player","example":"player StartBinocs()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StartFadingBlur","description":"Blurs the screen, then fades out the blur to 0, over a period of time.","example":"player StartFadingBlur( 3, 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"blur_amount","description":"The initial blur amount. The value is pixels for Gaussian blur at 640x480. Must be a floating point value greater than 0.","mandatory":true},{"name":"time","description":"Time in seconds, how long the fade out will take","mandatory":true}]}]},{"name":"StartFiring","description":"Starts a turret firing","example":"turret StartFiring()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"StartMission","description":"Start the (server side) mission script for the specified mission - all loading (on all clients) should be completed before calling - use client side LoadMission to load missions","example":"StartMission()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"mission_index","description":"index of the mission name to start - mission names can be retrieved by calling GetMissions to return the available mission array","mandatory":true}]}]},{"name":"StartPoisoning","description":"Start poisoning player","example":"player StartPoisoning()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StartRagdoll","description":"Begin ragdoll physics for this entity. Does nothing if the entity is already a ragdoll.","example":"self StartRagdoll()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player_or_playercorpse","description":null},"parameters":[{"name":"immediate","description":"Start the ragdoll immediately and don't do the velocity capture on the client.","mandatory":false}]}]},{"name":"StartResurrectViewAngleTransition","description":"Finishes the flashback","example":"self StartResurrectViewAngleTransition()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopAllRumbles","description":"Stop all the rumbles playing right now","example":"StopAllRumbles()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopAnimScripted","description":"Halts animscript on this entity.","example":"self StopAnimScripted()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"blend","description":"The blend out time for the animation","mandatory":false},{"name":"ImmediateStop","description":"Stop the animation immediatly on the client side (no client/server time sync)","mandatory":false}]}]},{"name":"StopBinocs","description":"Stop Binoculars on player","example":"player StopBinocs()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StopDemoRecording","description":"Stops demo recording","example":"Demo_End()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopFiring","description":"Stops a turret firing","example":"turret StopFiring()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"StopJukeMove","description":"Stops the player juke movement in progress","example":"player StopJukeMove()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StopLoopSound","description":"Stops the looping sound with an optional fadetime.","example":"m_chasm stoploopsound( 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"fadetime","description":"Time to fade the sound in. Range is between 1 and 31 inclusive.","mandatory":false}]}]},{"name":"StopMission","description":"fire Mission_Stop event to terminate the current mission","example":"StopMission()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopMoveSlide","description":"Stops the movement caused by MoveSlide().","example":"self StopMoveSlide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"model_origin_brushmodel","description":null},"parameters":[]}]},{"name":"StopPoisoning","description":"Stop poisoning player","example":"player StopPoisoning()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"StopRumble","description":"Plays a looping rumble on the given entity.","example":"self StopRumble( \"damage_heavy\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"rumble name","description":"The name of the rumble to play","mandatory":true}]}]},{"name":"StopShellShock","description":"Stops the shell shock sequence for the player","example":"player StopShellShock()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StopShootTurret","description":"Stops a turrent from firing.","example":"roof_turret StopShootTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"turret","description":null},"parameters":[]}]},{"name":"StopSound","description":"Stop a particular sound on an entity *WARNING*, You must have a wait between StopSounds() and delete() or the sound will not stop.","example":"beatBox StopSound(\"alias\");","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"StopSounds","description":"Stop all sounds on an entity. *WARNING*, You must have a wait between StopSounds() and delete() or the sound will not stop.","example":"beatBox StopSounds()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"StreamerModelHint","description":"Force a model to be loaded for a set period of time.","example":"streamerModelHint( \"c_hro_hendricks_base_fb\", 10 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"modelname","description":"The name of the model.","mandatory":true},{"name":"duration","description":"Length of time (in seconds) to keep it loaded.","mandatory":true}]}]},{"name":"StreamerRequest","description":"Streamer request","example":"streamerRequest( \"set\", \"ramses_igc1\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"command","description":"\"set\", \"clear\" or \"play\"","mandatory":true},{"name":"name","description":"Name of the streamer hint asset","mandatory":true}]}]},{"name":"StreamerSkiptoDebug","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"SwitchMap_Load","description":"Start loading a map/level.","example":"SwitchMap_Load( \"cp_sh_cairo\", \"coop\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"the name of the map to preload","mandatory":true}]}]},{"name":"SwitchMap_Preload","description":"Start preloading a map/level. A 'switchmap_preload_finished' notify is sent to the level when its finished.","example":"SwitchMap_Preload( \"cp_sh_cairo\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"map name","description":"the name of the map to preload","mandatory":true}]}]},{"name":"SwitchMap_SetLoadingMovie","description":"Set the loading movie to play","example":"SwitchMap_SetLoadingMovie( str_intro_movie )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"movie_name","description":"The name of the movie","mandatory":true}]}]},{"name":"SwitchMap_Switch","description":"Switch to the loaded map/level","example":"SwitchMap_Switch()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Target_BoundingIsUnderReticle","description":"Returns true if the player's cursor is roughly inside of the target's bounding box.","example":"player Target_BoundingIsUnderReticle( player, enemy_chopper, 1000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player entity","mandatory":true},{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"maxDistance","description":"The maximum distance to check for target intersection","mandatory":true}]}]},{"name":"Target_ClearReticleLockOn","description":"Cancels any lock-on sequence on the hud.","example":"Target_ClearReticleLockOn()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Target_GetArray","description":"Gets an array of entities that are set as targets","example":"mytargets = Target_GetArray()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"Target_GetOffset","description":"Gets the target offset","example":"offset = Target_GetOffset( entity )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity that is the target","mandatory":true}]}]},{"name":"Target_IsInCircle","description":"Returns whether a target is within a given radius from the center of the player's screen","example":"player Target_IsInCircle( enemy_chopper, player, 65, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"radius","description":"radius of the circle, centered at the center of the screen","mandatory":true},{"name":"zoffset","description":"if entity is not in target array, use optional zoffset for target pos","mandatory":false}]}]},{"name":"Target_IsInRect","description":"Returns whether a target is within a given rectangle, centered in the center of the player's screen","example":"player Target_IsInRect( enemy_chopper, player, 65, 100, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"halfwidth","description":"half the width of the rectangle","mandatory":true},{"name":"halfheight","description":"half the height of the rectangle","mandatory":true}]}]},{"name":"Target_IsTarget","description":"Returns whether an entity has been marked as a target","example":"if ( Target_IsTarget( foundEnt ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity to check","mandatory":true}]}]},{"name":"Target_OriginIsInCircle","description":"Returns whether a target is within a given radius from the center of the player's screen","example":"player Target_IsInCircle( enemy_chopper, player, 65, 100 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The origin to test","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"radius","description":"radius of the circle, centered at the center of the screen","mandatory":true}]}]},{"name":"Target_Remove","description":"Removes a target","example":"Target_Remove( enemy_chopper )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true}]}]},{"name":"Target_ScaleMinMaxRadius","description":"Returns the ratio from 0-1 of where the target is in relation to the radius min and radius max","example":"scale = Target_ScaleMinMaxRadius( target, self, level.hackerToolLockOnFOV, radiusInner, radiusOuter )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"player","description":"The player entity","mandatory":true},{"name":"fov","description":"The player's field of view","mandatory":true},{"name":"radius_min","description":"radius of the circle, centered at the center of the screen","mandatory":true},{"name":"radius_max","description":"radius of the circle, centered at the center of the screen","mandatory":true}]}]},{"name":"Target_Set","description":"Adds a new target to draw on the hud","example":"Target_Set( enemy_chopper )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"target offset","description":"The offset of the target position from the entity's origin","mandatory":false}]}]},{"name":"Target_SetAllowHighSteering","description":"Target will allow incoming missiles to steer more making the target easier to hit","example":"Target_SetAllowHighSteering( enemy_tank, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"bool","description":"true/false\"","mandatory":true}]}]},{"name":"Target_SetAttackMode","description":"Sets how missiles and rockets should approach the target.","example":"Target_SetAttackMode( enemy_tank, \"top\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"mode name","description":"\"top\" or \"direct\"","mandatory":true}]}]},{"name":"Target_SetJavelinOnly","description":"Target will only draw on player's hud when they are looking through the Javelin-weapon's site.","example":"Target_SetJavelinOnly( enemy_tank, true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"mode name","description":"\"top\" or \"direct\"","mandatory":true}]}]},{"name":"Target_SetOffscreenShader","description":"Sets the material that is used when a target clamps to the edge of the screen. The target must have already been created with target_set()","example":"Target_SetOffscreenShader( enemy_chopper, \"arrow\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"materialname","description":"The shader for the quad drawn over the target","mandatory":true}]}]},{"name":"Target_SetOffset","description":"Sets the offset for a particular target","example":"Target_SetOffset( enemy_chopper, ( 0, 0, -100 ) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"target offset","description":"The offset of the target position from the entity's origin","mandatory":false}]}]},{"name":"Target_SetShader","description":"Changes the material of a target. The target must have already been created with target_set()","example":"Target_SetShader( enemy_chopper, \"locked_on_shader\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"materialname","description":"The shader for the quad drawn over the target","mandatory":true}]}]},{"name":"Target_SetTurretAquire","description":"Sets if the target can be attacked by SAM turrets","example":"Target_SetTurretAquire( chopper, false )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity to set the flag","mandatory":true},{"name":"bool","description":"false if you want the SAM turret to ignore the targe. default is true.","mandatory":false}]}]},{"name":"Target_StartReticleLockOn","description":"Begins the lock-on sequence for the target on the hud. This affects the animation of the vehicle reticle.","example":"Target_StartReticleLockOn( enemy_chopper, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"target entity","description":"The entity that is the target","mandatory":true},{"name":"duration","description":"The amount of time between now and fully locked-on, in seconds.","mandatory":true}]}]},{"name":"TestSpawnPoint","description":"Returns true if the player would not be in a solid when spawned at the given point.","example":"TestSpawnPoint( self.origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point","description":"the point to test","mandatory":true}]}]},{"name":"TmodeSetServerUser","description":"informs the server if the entity is using tmode","example":"entity TmodeSetServerUser( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"value","description":"(int) 1-using 0-not usuing","mandatory":true}]}]},{"name":"ToggleNoVehicleFaceTraversability","description":"Set whether the entity can use NoVehicleFaces. This should only be used in MP map for now.","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"TracePassedOnNavMesh","description":"Run a trace on NavMesh to see if a character can go straight from start to end.","example":"posOnNavMesh = TracePassedOnNavMesh( (10,20,30), 25, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"start of the trace","mandatory":true},{"name":"end","description":"end of the trace","mandatory":true},{"name":"characterRadius","description":"the radius of the capsule used in trace. default to 0.","mandatory":false},{"name":"materialFlags","description":"the flags marking whether a face type can be used","mandatory":false}]}]},{"name":"TriggerEnable","description":"Enables or disables the trigger","example":"trig TriggerEnable( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[{"name":"flag","description":"True if trigger should be enabled, false otherwise","mandatory":true}]}]},{"name":"TriggerFX","description":"Trigger the fx after some time delay","example":"triggerFx( domFlag.enemyBaseEffect, 0.001 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The fx entity","mandatory":true},{"name":"time delay","description":"The time delay for the fx to play","mandatory":false}]}]},{"name":"TriggerIgnoreTeam","description":"Trigger ignores team","example":"trig TriggerIgnoreTeam()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"Unlink","description":"Unlinks a linked entity from another entity","example":"guy Unlink()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"UnlinkNodes","description":"Disconnects node1 from node2. Call it again with arguments flipped if you want to completely disconnect the two nodes.","example":"UnlinkNodes( node_moving_elev_left, node_moving_elev_right )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node1","description":"first node to unlink","mandatory":true},{"name":"node2","description":"second node to unlink","mandatory":true}]}]},{"name":"UnlinkTraversal","description":"Destroys a user edge connecting two path nodes","example":"UnlinkTraversal( beginNode )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"Negotiation begin node","mandatory":true}]}]},{"name":"UnlockSongByAlias","description":"Unlock the the sound alias","example":"self UnlockSongByAlias( \"frag_out\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"aliasname","description":"The sound alias to play (string)","mandatory":true}]}]},{"name":"UnSetTurretNode","description":"Unset the turret from this node.","example":"UnSetTurretNode( node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"node","description":"The turret node to disconnect","mandatory":true}]}]},{"name":"UpdateClientNames","description":"Update all of the client names: only works in 'manual_change' mode","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"UpdateNavTriggers","description":"Optimized code that performs the update_nav_triggers() script functionality","example":"UpateNavTriggers()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"UpdateUnlockedAttachmentBits","description":"Updates client->unlockedAttachments","example":"self UpdateUnlockedAttachmentBits()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"UseAnimTree","description":"Sets the anim tree for the entity","example":"self UseAnimTree( #animtree )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"anim tree","description":"The anim tree to set","mandatory":true}]}]},{"name":"UseBuildKitWeaponModel","description":"Use a build kit weapon model","example":"wall_weapon_model UseBuildKitWeaponModel( player, magicbox.weapon )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"player","description":"The player whose build kit data will be used","mandatory":true},{"name":"weapon","description":"The weapon to base the build kit on","mandatory":true},{"name":"camoIndex","description":"The index of the camo to override the build kit's camo with","mandatory":false},{"name":"upgraded","description":"bool whether this should be the upgraded version. If so extclip and fmj will be added","mandatory":false}]}]},{"name":"UseBy","description":"Uses the entity with the passed in entity as the activator","example":"self UseBy( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{}]}]},{"name":"UseServerVisionset","description":"Switches using the server supplied (via SetVisionSetForPlayer()) visionset.","example":"player UseServerVisionset( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"use it","description":"Whether using the server override visionset","mandatory":true}]}]},{"name":"UseTriggerIgnoreUseHoldTime","description":"Set the require look at flag for the trigger","example":"e_trig_mobile_armory UseTriggerIgnoreUseHoldTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"UseTriggerRequireLookAt","description":"Set the require look at flag for the trigger","example":"e_trig_plaza_igc UseTriggerRequireLookAt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"UseTriggerRequireLookToward","description":"Set the require look along flag for the trigger","example":"e_trig_plaza_igc UseTriggerRequireLookToward()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"trigger","description":null},"parameters":[]}]},{"name":"UseWeaponHideTags","description":"Hides tags on this entity based on the hidetags value of the provided weaponname","example":"wall_weapon_model UseWeaponHideTags()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the weapon to base the tags to hide on","mandatory":true}]}]},{"name":"UseWeaponModel","description":"Use a weapon model","example":"wall_weapon_model UseWeaponModel(\"m16_zm\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weaponName","description":"The name of the weapon to base the tags to hide on","mandatory":true},{"name":"model","description":"The name of a model to use. If none is specified the world model for the weapon will be used","mandatory":false},{"name":"weapon options","description":"The weapon options","mandatory":false}]}]},{"name":"Vibrate","description":"Causes a script entity to vibrate, rotating around its origin, along a given vector dir","example":"self Vibrate( directionVir, 0.3, 0.4, 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"direction vector","description":"The direction of the vibration","mandatory":true},{"name":"amplitude","description":"The amount of the vibration in degrees","mandatory":true},{"name":"period","description":"The period of the vibration in seconds","mandatory":true},{"name":"time","description":"The length of time of the vibration in seconds","mandatory":true}]}]},{"name":"VideoPause","description":"Pause video playback","example":"VideoPause( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to pause. do not add a file suffix (like .mp4)","mandatory":true}]}]},{"name":"VideoPrime","description":"Preload the first second of a movie. Call this several seconds before the movie needs to play to prevent any delay","example":"VideoPrime( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to play. do not add a file suffix (like .mp4)","mandatory":true},{"name":"loop","description":"Set this to true if the movie should automatically restart when it reaches the end.","mandatory":false}]}]},{"name":"VideoStart","description":"Start a video for playback on an in-game surface","example":"VideoStart( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to play. do not add a file suffix (like .mp4)","mandatory":true},{"name":"loop","description":"Set this to true if the movie should automatically restart when it reaches the end.","mandatory":false}]}]},{"name":"VideoStop","description":"Stop a video being played on an in-game surface","example":"VideoStop( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to stop. do not add a file suffix (like .mp4)","mandatory":true}]}]},{"name":"VideoUnpause","description":"Unpause video playback","example":"VideoUnpause( \"MyAwesomeMovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"name of movie to pause. do not add a file suffix (like .mp4)","mandatory":true}]}]},{"name":"ViewKick","description":"Give the player a view kick","example":"entity ViewKick( 25, self.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"damage","description":"The damage to inflict","mandatory":true},{"name":"origin","description":"The origin of the kick","mandatory":true}]}]},{"name":"VisionSetLastStand","description":"Sets players' laststand vision. Optionally give a transition time from the current vision.","example":"VisionSetLastStand( \"armada\", 1.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vision name","description":"Vision to transition to.","mandatory":true},{"name":"transition time","description":"How long, in seconds, to take transitioning to the new vision set if a transition is possible. Default is one second.","mandatory":false}]}]},{"name":"VisionSetLerpRatio","description":"Determines if you can see an item. Checks distance and view cone before the trace to increase efficency.","example":"self VisionSetLerpRatio ( currentDistance / maxDistance )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"float","description":"ratio between 0 and 1","mandatory":true}]}]},{"name":"VisionSetNaked","description":"Set the vision and its duration","example":"VisionSetNaked( \"cp_igc_chinatown_intro\", 0.05 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"The vision set name","mandatory":true},{"name":"duration","description":"The duration of the vision","mandatory":false}]}]},{"name":"WalkUnderwater","description":"Sets if a player should walk while underwater","example":"depth = get_players()[0] WalkUnderwater( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"boolean","description":"true if player should walk underwater. False if player should swim","mandatory":true}]}]},{"name":"WeaponCyclingEnabled","description":"Determine if weapon cycling is enabled for the player","example":"enabled = player WeaponCyclingEnabled()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponHasAttachment","description":"Does the weapon have all the attachments specified?","example":"WeaponHasAttachment( weapon, \"extbarrel\", \"damage, \"fmj\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"WeaponHasAttachmentAndUnlocked","description":"Does the weapon have all the attachments specified? And are they all unlocked for challenge stat purposes?","example":"player WeaponHasAttachmentAndUnlocked( weapon, \"extbarrel\", \"damage, \"fmj\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon","description":"weapon","mandatory":true},{"name":"string","description":"string id for attachment","mandatory":true}]}]},{"name":"WorldEntNumber","description":"Returns the entity number for the world","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"WorldToLocalCoords","description":"Transform the given world point into the local space of the entity","example":"local_point = self WorldToLocalCoords( world_point )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"world coords","description":"The point in world coordinates (vector3)","mandatory":true}]}]},{"name":"WorldTrace","description":"Trace from start to end","example":"trace = WorldTrace( start_pos, end_pos )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start","description":"The trace start point","mandatory":true},{"name":"end","description":"The trace end point","mandatory":true}]}]},{"name":"ZBarrierPieceUseAlternateModel","description":"Sets the indexed piece to use the alternate model.","example":"ent ZBarrierPieceUseAlternateModel(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseAttachWeapon","description":"Sets the indexed piece to attach the zbarrier's weapon to tag_weapon (and tag_weapon_left if it's dual wield).","example":"ent ZBarrierPieceUseAttachWeapon( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseBoxRiseLogic","description":"Sets the indexed piece to use the box rise logic.","example":"ent ZBarrierPieceUseBoxRiseLogic(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseDefaultModel","description":"Sets the indexed piece to use the default model.","example":"ent ZBarrierPieceUseDefaultModel(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierPieceUseUpgradedModel","description":"Sets the indexed piece to use the upgraded model.","example":"ent ZBarrierPieceUseUpgradedModel(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"piece number","description":"The piece index.","mandatory":true}]}]},{"name":"ZBarrierSupportsZombieReachThroughAttacks","description":"Returns true if this zbarrier supports zombie reach through attacks.","example":"useAttack = ent ZBarrierSupportsZombieReachThroughAttacks()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ZBarrierSupportsZombieTaunts","description":"Returns true if this zbarrier supports zombie taunt anims.","example":"useTaunt = ent ZBarrierSupportsZombieTaunts()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"ZeroGravityVolumeOff","description":"Disables Zero Gravity Volume.","example":"ZeroGravityVolumeOff( \"area_four\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"volume name","description":"The volume name.","mandatory":true}]}]},{"name":"ZeroGravityVolumeOn","description":"Enables Zero Gravity Volume.","example":"ZeroGravityVolumeOn( \"area_four\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"volume name","description":"The volume name.","mandatory":true}]}]},{"name":"AddSentientEventListener","description":"Registers entity to listen to a specific event. Call waittill() to get the notification in script.","example":"self AddSentientEventListener(\"bulletwhizby\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"event","description":"The event name","mandatory":true}]}]},{"name":"aithrowgrenade","description":"Throw a grenade. CheckGrenadeThrowPos() or CheckGrenadeThrow() must be called first.","example":"self GrenadeThrow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"AllowPitchAngle","description":"Allows AI to pitch on stairs","example":"guy AllowPitchAngle ( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"on_off","description":"1 to allow and 0 to disallow","mandatory":true}]}]},{"name":"AnimMode","description":"Set the way that animation deltas are interpreted by the game engine","example":"self AnimMode( \"gravity\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"mode","description":"which animmode to use. Must be 'gravity', 'nogravity', 'angle deltas', 'pos deltas', 'normal', 'normal_nogravity', 'zonly_physics', 'nophysics', 'none'","mandatory":true},{"name":"clear path","description":"The clear path flag","mandatory":false}]}]},{"name":"AtDangerousNode","description":"Determine whether this actor is near a dangerous node.","example":"if ( ai atDangerousNode() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"AttackedRecently","description":"Returns true if given sentient has attacked the entity within last \"time\" sec.","example":"self AttackedRecently(self.enemy)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"entity","description":"The enemy entity","mandatory":true},{"name":"time","description":"Time interval in seconds.","mandatory":true}]}]},{"name":"CalcApproximatePathToPosition","description":"Returns an array of world positions representing the approximate path an actor will take. Calculating an approximate path will cause the AI to clear their current path.","example":"self CalcApproximatePathToPosition( position )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"The goal position for the path","mandatory":true},{"name":"clear path","description":"True to clear path, false otherwise. Defaults to True","mandatory":false}]}]},{"name":"CalcLookaheadPos","description":"Calculate a lookahead point based on a given starting location and number of iterations. Returns an array with these keys: \"position\", \"node\" and \"next_node\", which contain vectors for the actual lookahead position and the next two nodes on the path, respectively.","example":"self CalcLookaheadPos( self.origin, 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"startPos","description":"Starting position of the lookahead traces","mandatory":true},{"name":"numIter","description":"Number of times to iterate (more gives better results, but is more expensive). Set to 0 to get current lookahead.","mandatory":true}]}]},{"name":"CanAttackEnemyNode","description":"Checks if this actor can attack its enemies node.","example":"self CanAttackEnemyNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"CanSee","description":"Check to see if the AI can see the given entity.","example":"if( self CanSee( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(entity) The entity to check.","mandatory":true},{"name":"cacheLength","description":"(integer) The cache length","mandatory":false}]}]},{"name":"CanShoot","description":"Check to see if the actor can shoot the given position.","example":"canShoot = self CanShoot( eye, offset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"shoot at position","description":"(vector) The position to shoot at.","mandatory":true},{"name":"offset from gun","description":"(vector) The offset from the gun muzzle from which to calculate collision.","mandatory":false}]}]},{"name":"CanShootEnemy","description":"Check to see if the actor can shoot his current enemy.","example":"canShootEnemy = self CanShootEnemy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"cache duration","description":"(int) When set, uses a custom time value for the cache.","mandatory":false}]}]},{"name":"CanThrowGrenade","description":"Checks whether the actor can throw a grenade at a given position. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CanThrowGrenade( armOffset, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"random range","description":"(float) random range from target position to throw at","mandatory":true}]}]},{"name":"CanThrowGrenadePos","description":"Checks whether the actor can throw a grenade at a given position. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CanThrowGrenadePos( armOffset, targetPos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"targetpos","description":"(vector) The target position, should be at ground level of potential target","mandatory":true}]}]},{"name":"CheckGrenadeThrow","description":"Checks whether the actor can throw a grenade at his target. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CheckGrenadeThrow( armOffset, \"min energy\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"method","description":"(string) The grenade toss method. Can be 'min energy', 'min time', and 'max tune'","mandatory":true},{"name":"random range","description":"(float) random range from target position to throw at","mandatory":true}]}]},{"name":"CheckGrenadeThrowPos","description":"Checks whether the actor can throw a grenade at a given position. If he can't then result will be undefined, otherwise the result is the resultant velocity vector","example":"throwvel = self CheckGrenadeThrowPos( armOffset, \"min energy\", targetPos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"hand offset","description":"(vector) the estimated offset of the hand for the throw","mandatory":true},{"name":"method","description":"(vector) The grenade toss method. Can be 'min energy', 'min time', and 'max tune'","mandatory":true},{"name":"targetpos","description":"(vector) The target position, should be at ground level of potential target","mandatory":true}]}]},{"name":"CheckProne","description":"Returns true when a character can go prone at the specified position. Specifically setup for use by AI characters.","example":"canFitProne = self CheckProne( origin, yaw, alreadyProne )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(vector) The position of the prone character.","mandatory":true},{"name":"yaw","description":"(float) The world yaw in degrees.","mandatory":true},{"name":"is prone","description":"(bool) Flag if the character is already prone.","mandatory":true}]}]},{"name":"ChooseBetterCoverNode","description":"Chooses a better cover node for an ai","example":"newNode = behaviorTreeEntity ChooseBetterCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearEnemy","description":"Clear the actor's current enemy entity.","example":"self ClearEnemy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearEntityOwner","description":"Clears an AI's entity owner.","example":"self ClearEntityOwner()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearEntityTarget","description":"Clears an AI's entity target.","example":"self ClearEntityTarget( vehicle_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearFixedNodeSafeVolume","description":"Clears this actor's fixed node safe volume.","example":"self ClearFixedNodeSafeVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearForcedGoal","description":"Clears the forcedGoal for this AI's goal.","example":"self ClearForcedGoal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"ClearGoalVolume","description":"Clears this actor's goal volume.","example":"self ClearGoalVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"ClearPath","description":"Clears the AI's current path.","example":"self ClearPath()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearPitchOrient","description":"Clear pitch orientation","example":"self clearPitchOrient()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ClearPotentialThreat","description":"Clear the potential threat direction. See SetPotentialThreat for more info on potential threats","example":"self ClearPotentialThreat( 90 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"dir","description":"direction of the threat. This is the angle from which the NPC should expect danger","mandatory":true}]}]},{"name":"ClearUsePosition","description":"Clear the override for the goal pos.","example":"self ClearUsePosition()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"CollideWithActors","description":"Toggles collision with other actors. Actor will go through each other, when its toggled off.","example":"entity CollideWithActors( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{}]}]},{"name":"CreateThreatBiasGroup","description":"Create a new threat bias group. If it already exists, do nothing","example":"CreateThreatBiasGroup( \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"threat bias group name.","mandatory":true}]}]},{"name":"DamageMode","description":"Set the damage mode of this actor.","example":"randAlly DamageMode(\"next_shot_kills\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"damage mode","description":"(const string) DamageMode must be 'normal' or 'next_shot_kills'","mandatory":true}]}]},{"name":"DropWeapon","description":"Drop the actor's weapon","example":"self DropWeapon(self.weapon, self.anim_gunHand, throwVel)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"weapon name","description":"(string) The name of the weapon.","mandatory":true},{"name":"hand","description":"(string) The tag to throw the weapon from.","mandatory":true},{"name":"velocity","description":"(vector) The initial velocity of the weapon.","mandatory":false},{"name":"angular velocity","description":"(vector) The initial angular velocity of the weapon.","mandatory":false},{"name":"scavenger","description":"(bool) If the weapon requires the player to have scavenger perk to pick up the weapon.","mandatory":false}]}]},{"name":"FindBestCoverNode","description":"Find the best cover node for a given NPC given his state.","example":"self FindBestCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"FindBestCoverNodes","description":"Find the best cover nodes for a given NPC given his state. Sorted by best","example":"nodes = self FindBestCoverNodes(radius,origin)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"radius","description":"search radius","mandatory":true},{"name":"origin","description":"search origin","mandatory":true}]}]},{"name":"FindCoverNodeAtLocation","description":"Finds a near by cover node for the character.","example":"guy FindCoverNodeAtLocation(512,loc)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"radius","description":"search radius","mandatory":true},{"name":"origin","description":"search origin","mandatory":true}]}]},{"name":"FindReacquireDirectPath","description":"Finds a path directly to the enemy. Call ReacquireMove to use the path.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"ignore suppression","description":"Whether to ignore suppression when looking for a path. True makes a success more likely but may result in a more dangerous path.","mandatory":false}]}]},{"name":"FindReacquireNode","description":"Finds a reacquire node when exposed.","example":"guy FindReacquireNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"FindReacquireProximatePath","description":"Finds a path to a point that can see the enemy without leaving goal. Call ReacquireMove to use the path.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"ignore suppression","description":"Whether to ignore suppression when looking for a path. True makes a success more likely but may result in a more dangerous path.","mandatory":false}]}]},{"name":"FinishActorDamage","description":"Does damage to an actor - usually as part of the damage callback","example":"self FinishActorDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, vDir, sHitLoc, vDamageOrigin, psOffsetTime, iBoneIndex, iSurfaceType, vSurfaceNormal )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"Hit Loc","description":"The location of the hit","mandatory":true},{"name":"Damage Origin","description":"Position of the originator of the damage","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true},{"name":"Bone Index","description":"Index of nearest bone","mandatory":true},{"name":"Surface Type","description":"The surface type of the hit location","mandatory":false},{"name":"Surface Normal","description":"The surface normal at hit location","mandatory":false}]}]},{"name":"ForceTeleport","description":"Force Teleport the actor to a new position with the given origin and angles, regardless of wether it will be visible to the player or not.","example":"self ForceTeleport( org, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(point) The actor's new position.","mandatory":true},{"name":"angles","description":"(vector) The actor's new angles.","mandatory":false},{"name":"updategoalpos","description":"(bool) Update the script goal position to the teleport location. True by default.","mandatory":false},{"name":"resetEntity","description":"(bool) Reset the entity behaviors.","mandatory":false}]}]},{"name":"GenerateRadioEvent","description":"Searches animation selector table and returns an animation alias based on current state of the blackboard.","example":"self GenerateRadioEvent(\"radio_event_low\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"type of event","description":"The type of radio event","mandatory":true}]}]},{"name":"GetAimLimitsFromEntry","description":"Searches animation selector table and returns an animation alias based on current state of the blackboard.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetBehaviorTreeStatus","description":"Returns current status/BHTN_STATUS of the behavior tree for an actor.","example":"isBehaviorTreeInRunningState = behaviorTreeEntity GetBehaviortreeStatus() == BHTN_RUNNING","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetClosestEnemySqDist","description":"Get the distance to the nearest enemy","example":"dist = self GetClosestEnemySqDist()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"GetDropToFloorPosition","description":"Gets the floor position for dropping an AI or player to the ground. Returns undefined if the AI is in solid.","example":"position = ai GetDropToFloorPosition( ai.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"position","description":"test position. Defaults to entity's current origin","mandatory":false}]}]},{"name":"GetFinalPathPos","description":"Get the last position in the path","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetFireMode","description":"returns the firemode","example":"soldier GetFireMode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetFixedNodeSafeVolume","description":"Get this actor's fixed node safe volume.","example":"volume = self GetFixedNodeSafeVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetFlashBangedStrength","description":"Retrieves how strongly the actor was initially hit by a flashbang. 1.0 is full strength, 0.0 is none at all.","example":"flashedPercent = self GetFlashBangedStrength()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetGoalVolume","description":"Get this actor's goal volume.","example":"goalVolume = self GetGoalVolume()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"GetGroundEntType","description":"Get the entity type of the 'ground' that the actor is on.","example":"self GetGroundEntType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetHitEntType","description":"Get the type of entity that the actor has hit. Can be 'hit', 'obstacle' or 'world'.","example":"self GetHitEntType()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetHitYaw","description":"Get the direction in degrees that the player has hit an obstacle at. Returns an error if nothing was hit.","example":"self GetHitYaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetIgnoreEnt","description":"Returns if a specific sentient entity is ignored by this sentient entity or not","example":"if ( aiGuy GetIgnoreEnt( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Another sentient entity","mandatory":true}]}]},{"name":"GetNextFindBestCoverTime","description":"Generates a new next find cover time","example":"behaviorTreeEntity.nextFindBestCoverTime = GetActorNextFindBestCoverTime( behaviorTreeEntity.engageMinDist, behaviorTreeEntity.engagemaxdist, behaviorTreeEntity.coversearchinterval )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"minEngageDist","description":"Min engage enemy dist.","mandatory":true},{"name":"maxEngageDist","description":"Max engage enemy dist.","mandatory":true},{"name":"noEnemyInterval","description":"How often cover should be searched when without an enemy","mandatory":true}]}]},{"name":"GetNodeOffsetAngles","description":"Returns the angles the actor thinks the node is facing, this can contain additional rotation from the node's actual angles.","example":"self GetNodeOffsetAngles( self.node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetNodeOffsetPosition","description":"Returns the position the actor thinks the node's origin is at, this can be offset from where the actual node's position in the world is.","example":"self GetNodeOffsetPosition( self.node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetOrientMode","description":"Set the orient mode of this actor.","example":"orientMode = randAlly GetOrientMode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetPathLength","description":"Gets the length of the path being used by this actor","example":"self GetPathLength()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetPathMode","description":"Get the path mode of this actor.","example":"pathMode = randAlly GetPathMode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetPerfectInfo","description":"Forces the AI to become aware of this entity regardless of whether it can be seen or not.","example":"self GetPerfectInfo( get_players()[0] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An entity to become aware of. Must be a sentient (i.e. AI or player)","mandatory":true},{"name":"update sight","description":"If true then it will update the last seen position also.","mandatory":false}]}]},{"name":"GetPersonalThreatBias","description":"return the personal threat bias for this sentient versus the other sentient","example":"value = self GetPersonalThreatBias( self.enemy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Self","mandatory":true},{"name":"enemy","description":"The enemy to get threat bias for","mandatory":true}]}]},{"name":"GetReacquireNode","description":"Gets the reacquire node of this actor.","example":"guy GetReacquireNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GetStealthSightValue","description":"Get the current stealth sight value for this sentient seeing another sentient (floating point from 0.0 to 1.0)","example":"aiGuy GetStealthSightValue( forOtherGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"otherSentient","description":"other sentient you want to get the value on this sentient for","mandatory":true}]}]},{"name":"GetThreatBias","description":"Get threat bias of first group against second group","example":"GetThreatBias( \"axis\", \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"of group","description":"(string) threat bias group for.","mandatory":true},{"name":"against group","description":"(string) threat bias group against.","mandatory":true}]}]},{"name":"GetThreatBiasGroup","description":"Get the threat bias group of an AI or player","example":"GetThreatBiasGroup()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetTurnExitYaw","description":"Predicts exit yaw vector using havok pathfinding.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"GrenadeThrow","description":"Throw a grenade. CheckGrenadeThrowPos() or CheckGrenadeThrow() must be called first.","example":"self GrenadeThrow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"HasPath","description":"returns true/false if AI has a path","example":"self HasPAth()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"HasValidInterrupt","description":"Return true if there is a valid interrupt with the given name alive on the current server frame.","example":"if ( entity HasValidInterrupt(\"pain\") )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"interrupt name","description":"The name of the interrupt","mandatory":true}]}]},{"name":"IsActorShooting","description":"Checks whether this entity is an ai is shooting","example":"if ( meanGuy IsActorShooting() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An actor","mandatory":true}]}]},{"name":"IsApproachingGoal","description":"returns true/false if actor at the goal or approaching the goal.","example":"self IsApproachingGoal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsAtCoverNode","description":"returns true/false if actor is at cover node. (exposed node is considered as covernode)","example":"self IsAtCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsAtCoverNodeStrict","description":"returns true/false if actor is at cover node. (exposed node is not considered as covernode)","example":"self IsAtCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsAtGoal","description":"returns true/false if actor has at/reached its current goal, similar to waiting for \"goal\" notify.","example":"self IsAtGoal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsBadGuy","description":"Returns true if the sentient is on the bad guy team (not 'allies', not 'neutral').","example":"if ( ai IsBadGuy() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"IsCoverValid","description":"Return true if the passed in node is a valid cover node.","example":"if( self IsCoverValid( pathnode ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"pathnode","description":"The pathnode to check for validity","mandatory":true}]}]},{"name":"IsCurrentBTActionLooping","description":"Return true if there is an action running and its looping.","example":"if( behaviorTreeEntity IsCurrentBTActionLooping() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsDeflected","description":"Check if the actor has been deflected.","example":"self IsDeflected()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsFlankedAtCoverNode","description":"returns true/false if actor is at is flanked at cover node","example":"self IsFlankedAtCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsGrenadePosSafe","description":"Checks a grenade throw target position is safe.","example":"if ( self IsGrenadeThrowSafe( throwPos, 200 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"throw pos","description":"(vector) position to throw at","mandatory":true},{"name":"radius","description":"(float) safety radius","mandatory":false}]}]},{"name":"IsInAnyBadPlace","description":"Returns whether the AI is in a bad place.","example":"self IsInAnyBadPlace()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsInGoal","description":"Determine whether a given point is in the actor's current goal area","example":"if ( ai IsInGoal( point ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"point","description":"which point to check.","mandatory":true}]}]},{"name":"IsInScriptedState","description":"Checks if actor is in a scripted state (animscripted, custom, negotiation)","example":"self isInScripteState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsKnownEnemyInRadius","description":"Checks if there is a known enemy in a radius for an AI.","example":"if ( self IsKnownEnemyInRadius( pos, radius ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"center of radius to check.","mandatory":true},{"name":"radius","description":".","mandatory":true}]}]},{"name":"IsKnownEnemyInVolume","description":"Checks if there is a known enemy in a volume for an AI.","example":"if ( self isKnownEnemyInVolume( volume ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"volume","description":"volume entity to check in.","mandatory":true}]}]},{"name":"IsMoveSuppressed","description":"Checks whether this actor is in a suppressed state ( blocked by friendly fire ).","example":"while ( self IsMoveSuppressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsNoTarget","description":"returns if the sentient is marked no target","example":"if ( self IsNoTarget() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"IsPathDirect","description":"Check whether the actor's current path is direct","example":"self IsPathDirect()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsPosAtGoal","description":"returns true/false if position is inside the current goal","example":"self IsPosAtGoal(position)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsPosInClaimedLocation","description":"returns true/false if position is claimed by another sentient","example":"self IsPosInClaimedLocation( position )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[]}]},{"name":"IsSafeFromGrenade","description":"returns true/false if actor is within a blast radius of a grenade.","example":"self IsSafeFromGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsStanceAllowed","description":"Checks whether this actor can go to the given stance.","example":"if ( self IsStanceAllowed( \"stand\" ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"stance","description":"(string) A stance, can be 'prone', 'crouch', 'stand'.","mandatory":true}]}]},{"name":"IsSuppressed","description":"Checks whether this actor is in a suppressed state ( under fire ).","example":"while ( self IsSuppressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsSuppressionWaiting","description":"Checks whether this actor is still doing suppression wait.","example":"while ( self IsSuppressionWaiting() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"IsThreateningMyProtectEntity","description":"Returns true if the enemy is currently threatening my protect entity.","example":"if ( self IsThreateningMyProtectEntity( self.enemy ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(sentient) The sentient to check.","mandatory":true}]}]},{"name":"Knockback","description":"Turn knockback on and off for an actor","example":"self Knockback( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"true/false","description":"if true, actor affected by knockback","mandatory":true}]}]},{"name":"LastKnownPos","description":"Return the last known pos of an AI.","example":"if ( self lastKnownPos( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(sentient) The sentient to check.","mandatory":true}]}]},{"name":"LastKnownTime","description":"Return the last time an AI was aware of target. Includes visibility and ai events like footstep, gunshot etc.","example":"if( self lastKnownTime( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(sentient) The sentient to check.","mandatory":true}]}]},{"name":"LerpPosition","description":"Interpolate an actor's position, and angles.","example":"self LerpPosition( entry['origin'], entry['angles'] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"origin","description":"(vector) the position to interpolate to.","mandatory":true},{"name":"angles","description":"(vector) the angles to interpolate to.","mandatory":true}]}]},{"name":"MayMoveFromPointToPoint","description":"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":"if ( !self MayMoveFromPointToPoint( startPoint endPoint ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"start","description":"(point) start position.","mandatory":true},{"name":"end","description":"(point) end position.","mandatory":true},{"name":"check drop","description":"checks if the point would cause the AI to drop. Defaults to true.","mandatory":false},{"name":"check direct","description":"checks if there are no obstructions between actor origin and .","mandatory":false}]}]},{"name":"MayMoveToPoint","description":"Check whether the actor can move to a given point.","example":"if ( !self MayMoveToPoint( endPoint ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(point) The position that the actor may be able to move to.","mandatory":true},{"name":"check drop","description":"checks if the point would cause the AI to drop. Defaults to true.","mandatory":false},{"name":"check direct","description":"checks if there are no obstructions between actor origin and .","mandatory":false}]}]},{"name":"Melee","description":"Makes this actor melee attack. Returns the entity hit, if any.","example":"guy Melee()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"direction","description":"direction to attack, if not specified, uses direction to current enemy.","mandatory":false}]}]},{"name":"MeleeWithOffset","description":"Makes this actor melee attack. Returns the entity hit, if any.","example":"guy MeleeWithOffset( (0,0,32) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"offset","description":"A vector offset added to the actor's eye position from which to start the melee trace.","mandatory":true}]}]},{"name":"NearClaimNode","description":"Determine whether this actor is near its claim node.","example":"if ( ai NearClaimNode() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"NearClaimNodeAndAngle","description":"Determine whether this actor is near its claim node and nearly matches the angle.","example":"if ( ai NearClaimNodeAndAngle() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"NearNode","description":"Determine whether this actor is near to a given path node.","example":"if ( ai NearNode( node ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"node","description":"The path node to check.","mandatory":true}]}]},{"name":"OrientMode","description":"Set the orient mode of this actor.","example":"randAlly OrientMode(\"face direction\", player.origin-randAlly.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"orient mode","description":"(const string) OrientMode must be 'face angle', 'face current', 'face direction', 'face enemy', 'face enemy or motion', 'face goal', 'face motion', 'face point', or 'face default'","mandatory":true},{"name":"face angle","description":"(float) The yaw angle to face if orient mode is 'face angle'","mandatory":false},{"name":"direction vector","description":"(vector) The direction vector to face if orient mode is 'face direction'","mandatory":false},{"name":"face position","description":"(vector) The point to face if orient mode is 'face point'","mandatory":false}]}]},{"name":"PathMode","description":"Set the path mode of this actor.","example":"randAlly PathMode(\"dont move\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"path mode","description":"(const string) PathMode must be 'dont move', 'move allowed', or 'move delayed'","mandatory":true},{"name":"clear path","description":"(integer) 1 to clear path","mandatory":false},{"name":"path delay","description":"(float) Amount of time (seconds) to wait if path mode is 'move delayed'","mandatory":false}]}]},{"name":"PickUpGrenade","description":"Pick up a grenade","example":"self PickUpGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PredictArrival","description":"Predicts the arrival direction vector using havok corner predictor.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PredictExit","description":"Predicts the exit direction vector using havok corner predictor.","example":"predictedLookAheadInfo = self PredictExit()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PredictPath","description":"Predicts the path to look for upcoming corner using havok corner predictor.","example":"predictedLookAheadInfo = self PredictPath()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"PushPlayer","description":"Set whether this character can push the player. Don't call this unless you know what you are doing.","example":"level.elder PushPlayer( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"can push player","description":"(bool) True if this character can push the player.","mandatory":true}]}]},{"name":"ReacquireMove","description":"Start the reaquire move","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ReacquireStep","description":"Do side step move to safe place left or right while facing enemy.","example":"reacquirePos = entity ReacquireStep( step_size )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"dist","description":"(floating point number) amount to side step left or right","mandatory":true}]}]},{"name":"RemoveSentientEventListener","description":"De-Registers entity to listen to a specific event. if event is undefined, entity will stop listening to all the evnets.","example":"self RemoveSentientEventListener(\"bulletwhizby\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"event","description":"The event name","mandatory":false}]}]},{"name":"ResetVisibilityCacheWithinRadius","description":"Reset the viscache for sentients within the specified radius","example":"ResetVisibilityCacheWithinRadius(origin, 500)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"Center of reset bounds","mandatory":true},{"name":"radius","description":"Distance around the origin to scan for sentients","mandatory":true}]}]},{"name":"SeeRecently","description":"Check to see if the AI saw the given sentient in the past . If called on a non-sentient, just does a cansee check","example":"if( self SeeRecently( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"target","description":"(entity) The entity to check.","mandatory":true},{"name":"time","description":"(int) seconds.","mandatory":true}]}]},{"name":"SetEntityOwner","description":"Set an entity as the AI's owner. The owner will never be targeted.","example":"self SetEntityOwner( vehicle_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An entity for owner.","mandatory":true}]}]},{"name":"SetEntityTarget","description":"Set an entity as the AI's target. This is for special cases only. Do not set AI or player targets with this.","example":"self SetEntityTarget( vehicle_entity, 0.7, \"tag_head\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"entity","description":"An entity to target (cannot be server only entity).","mandatory":true},{"name":"threat","description":"A fraction of maximum possible threat an AI can have. Must be in 0 to 1 range. Defaults to 1.","mandatory":false},{"name":"tag name","description":"Tag to aim/shoot at on this entity. Defaults to tag_eye for actors/players\".","mandatory":false}]}]},{"name":"SetFixedNodeSafeVolume","description":"Set this actor's fixed node safe volume.","example":"self SetFixedNodeSafeVolume( volume )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"volume entity","description":"(entity) The safe volume entity.","mandatory":true}]}]},{"name":"SetFlashBanged","description":"Sets whether an actor is under a flashbang effect.","example":"self SetFlashBanged( true, 0.8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"flashed","description":"Whether or not the actor is under the affect of a flashbang.","mandatory":true},{"name":"strength","description":"If actor is flashed, how severely they were initially affected. Between 0.0 and 1.0 (full strength).","mandatory":false}]}]},{"name":"SetFlashbangImmunity","description":"Sets whether an actor is succeptable to flashbangs.","example":"level.suicideguy SetFlashbangImmunity( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"immune","description":"If the actor can be affected by flashbangs.","mandatory":true}]}]},{"name":"SetFreeCameraLockOnAllowed","description":"Sets whether the ai is allowed to be locked onto in the demo free camera","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"allowed","description":"boolean of whether it is allowed","mandatory":true}]}]},{"name":"SetGoal","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalentity","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalnode","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalpos","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalvolume","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"setgoalvolumeauto","description":"Set this AI 's goal. Any of the above function name will work. They all call into SetGoal function internally.","example":"self SetGoal( node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"pos","description":"///","mandatory":true},{"name":"forced","description":"(bool) should go directly to this pos/node/entity. Forced means AI will get within approx 4 units of the entity.","mandatory":false},{"name":"goalradius","description":"radius of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false},{"name":"goalheight","description":"height of the goal. Applicable for entity and position/node and not the volume or forcedGoal.","mandatory":false}]}]},{"name":"SetIgnoreEnt","description":"Set a sentient entity to ignore another specific sentient entity or not","example":"aiGuy SetIgnoreEnt( player, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Another sentient entity","mandatory":true},{"name":"ignored","description":"true/false","mandatory":true}]}]},{"name":"SetIgnoreMeGroup","description":"Make first group ignored by second group","example":"SetIgnoreMeGroup( \"flanking_team\", \"axis\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"ignored group","description":"(string) ignored group.","mandatory":true},{"name":"ignoring group","description":"(string) ignoring group.","mandatory":true}]}]},{"name":"SetPersonalIgnore","description":"self will not pick enemy as target for the duration","example":"self SetPersonalIgnore( self.enemy, 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Self","mandatory":true},{"name":"enemy","description":"The enemy to set threat bias for","mandatory":true},{"name":"duration","description":"How long this threat bias lasts in seconds","mandatory":false}]}]},{"name":"SetPersonalThreatBias","description":"Sets a personal threat bias for this sentient versus the other sentient. It lasts for the given duration.","example":"self SetPersonalThreatBias( self.enemy, -1000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"sentient","description":"Self","mandatory":true},{"name":"enemy","description":"The enemy to set threat bias for","mandatory":true},{"name":"threatBias","description":"The threat bias amount","mandatory":true},{"name":"duration","description":"How long this threat bias lasts in seconds","mandatory":false}]}]},{"name":"SetPhysParams","description":"Sets the collision bounds for an actor.","example":"self setPhysParams( 15, 0, 72 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"radius","description":"size of the actor.","mandatory":true},{"name":"minsz","description":"min height of the actor.","mandatory":true},{"name":"maxsz","description":"max height of the actor.","mandatory":true}]}]},{"name":"SetPitchOrient","description":"Set pitch orientation","example":"self setPitchOrient()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"SetPotentialThreat","description":"In non-combat situations. This is mostly useful for friendlies.","example":"self SetPotentialThreat( 90 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"dir","description":"direction of the threat. This is the angle from which the NPC should expect danger","mandatory":true}]}]},{"name":"SetRepairPaths","description":"True allows havok to repath automatically if the AI moves off their predefined path.","example":"self SetRepairPaths( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"on_off","description":"true to enable repair paths, false otherwise","mandatory":true}]}]},{"name":"SetStairsExitTransform","description":"Sets the base transform for the exit stairs animation using the current position in the looping anim","example":"self SetStairsExitTransform()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"SetStealthSight","description":"Set the parameters for given awarenesslevel of stealth sight when active on an sentient","example":"SetStealthSight( \"high_alert\", 2, 1, 10, 200, 1000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"awareness","description":"\"unaware\", \"low_alert\", \"high_alert\", or \"combat\"","mandatory":true},{"name":"timeDecay","description":"float value of seconds stealth sight takes to fall off completely (0 for never/infinite)","mandatory":true},{"name":"timeDistMin","description":"float value of seconds stealth sight takes to grow completely at min range (0 for never/infinite)","mandatory":true},{"name":"timeDistMax","description":"float value of seconds stealth sight takes to grow completely at max range (0 for never/infinite)","mandatory":true},{"name":"distMin","description":"float value of the min distance","mandatory":true},{"name":"distMax","description":"float value of the max distance","mandatory":true},{"name":"extendSight","description":"indicates of sight continues beyond max range at the max rate","mandatory":false}]}]},{"name":"SetStealthSightAwareness","description":"Set the current stealth sight awareness state for this sentient","example":"aiGuy SetStealthSightAwareness( \"unaware\", true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"awareness","description":"\"unaware\", \"low_alert\", \"high_alert\", \"combat\", or undefined to disable it (default disabled)","mandatory":false},{"name":"decayEnabled","description":"if true stealth sight will decay when other sentient is not in sight (default true)","mandatory":false}]}]},{"name":"SetStealthSightValue","description":"Set the current stealth sight value for this sentient seeing another sentient (floating point from 0.0 to 1.0)","example":"aiGuy SetStealthSightValue( forOtherGuy, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"sentient","description":null},"parameters":[{"name":"otherSentient","description":"other sentient you want to set the value on this sentient for","mandatory":true},{"name":"newValue","description":"The new stealth sight value","mandatory":true}]}]},{"name":"SetSteeringMode","description":"Sets the steering mode for the actor. Valid modes are \"normal steering\", \"slow steering\", \"vignette steering\".","example":"self SetSteeringMode( \"slow steering\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"steering mode","description":"Mode to set.","mandatory":true}]}]},{"name":"SetThreatBias","description":"Set threat bias of second group against first group","example":"SetThreatBias( \"axis\", \"flanking_team\", 120 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"against group","description":"(string) threat bias group against.","mandatory":true},{"name":"for group","description":"(string) threat bias group for.","mandatory":true},{"name":"threat bias","description":"(int) threat bias value.","mandatory":true}]}]},{"name":"SetThreatBiasAgainstAll","description":"Set the threatbias a group has against all others","example":"SetThreatBiasAgainstAll( \"flanking_team\", 120 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"group","description":"(string) threat bias group name.","mandatory":true},{"name":"value","description":"(int) threat bias value.","mandatory":true}]}]},{"name":"SetThreatBiasGroup","description":"Set or clear threat bias group of an AI or player","example":"SetThreatBiasGroup( \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"threat_bias_group","description":"(string) threat bias group name. If none, remove actor from current threat bias group","mandatory":false}]}]},{"name":"Shoot","description":"Makes this actor shoot.","example":"guy shoot()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"accuracy modifier","description":"(floating point number)","mandatory":false},{}]}]},{"name":"ShouldFaceMotion","description":"Determines if the AI should face the motion direction. Use self.faceMotion instead of this except when the AI is just beginning to move.","example":"self ShouldFaceMotion()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldHoldGroundAgainstEnemy","description":"Return true if enemy is within pathEnemyFightDist.","example":"if( behaviorTreeEntity ShouldHoldGroundAgainstEnemy() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldStartArrival","description":"returns true/false if actor should start arriving at given node","example":"self ShouldStartArrival()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldStartTraversal","description":"returns true/false if actor should start traversal","example":"self ShouldStartTraversal()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"ShouldUseCoverNode","description":"returns true/false if actor is at is safe at cover node and use it as a cover","example":"self ShouldUseCoverNode()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"StartCoverArrival","description":"Runs cover arrival animscript on an actor.","example":"soldier StartCoverArrival( pos, 45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"start pos","description":"the offset to start the arrival animation from","mandatory":true},{"name":"yaw angles","description":"the arrival angle","mandatory":true}]}]},{"name":"Teleport","description":"Teleport the actor to a new position with the given origin and angles.","example":"self Teleport( org, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"(point) The actor's new position.","mandatory":true},{"name":"angles","description":"(vector) The actor's new angles.","mandatory":false}]}]},{"name":"ThreatBiasGroupExists","description":"Check if a threat bias group exists","example":"ThreatBiasGroupExists( \"flanking_team\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"threat bias group name.","mandatory":true}]}]},{"name":"TraverseMode","description":"Set the traverse mode of this actor.","example":"self TraverseMode( \"nogravity\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"traverse mode","description":"(const string) Possible traverse modes are 'gravity', 'nogravity', or 'noclip'","mandatory":true}]}]},{"name":"TrimPathtoAttack","description":"Trims the path to attack.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[]}]},{"name":"UseCoverNode","description":"Tells this actor to use the given cover node. This is invalid if the actor's keepclaimednode flag is set. Returns true or false depending on whether the actor can claim the node.","example":"guy UseCoverNode( covernode )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"path node","description":"The path node to use as cover","mandatory":true}]}]},{"name":"UsePosition","description":"Override where the actor should run to. This overrides the goal pos and the claimed node.","example":"self UsePosition( pos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"position","description":"The position for the actor to run to.","mandatory":true},{"name":"arrivalfinalposition","description":"The arrivalfinalposition if this is an arrival.","mandatory":false}]}]},{"name":"UseReacquireNode","description":"Use the given reacquire node.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"node","description":"(path node) the node to use.","mandatory":true}]}]},{"name":"Abs","description":"Returns the absolute value of a float","example":"x = Abs( x )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A float or integer value.","mandatory":true}]}]},{"name":"AbsAngleClamp180","description":"Returns abs angle value clamped between [0,180].","example":"deltaAngle = AbsAngleClamp180( currentAngle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"Angle to be clamped","mandatory":true}]}]},{"name":"AbsAngleClamp360","description":"Returns as a value in the range of 0 and 360 degrees.","example":"new_angle = AbsAngleClamp360( boatAngles[2] )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle.","mandatory":true}]}]},{"name":"ACos","description":"Returns an angle corresponding to a particular cosine value","example":"upAngle = ACos( distanceratio )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"cos value","description":"A cosine value","mandatory":true}]}]},{"name":"AngleClamp180","description":"Returns angle value clamped between [-180,180].","example":"deltaAngle = AngleClamp180( currentAngle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"Angle to be clamped","mandatory":true}]}]},{"name":"AngleLerp","description":"Returns lerped angle value.","example":"180 = AngleLerp( 0, 360, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"An angle.","mandatory":true},{"name":"to","description":"An angle.","mandatory":true},{"name":"fraction","description":"A float from 0-1.","mandatory":true}]}]},{"name":"AnglesToForward","description":"Returns the forward vector corresponding to a set of angles.","example":"forward = AnglesToForward( forward )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"A set of angles","mandatory":true}]}]},{"name":"AnglesToRight","description":"Returns the right vector corresponding to a set of angles.","example":"right = AnglesToRight(angles)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"A set of angles","mandatory":true}]}]},{"name":"AnglesToUp","description":"Returns the up vector corresponding to a set of angles.","example":"up = AnglesToUp(angles)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles","description":"A set of angles","mandatory":true}]}]},{"name":"ASin","description":"Returns an angle corresponding to a particular sin value","example":"upAngle = ASin( upAmount )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"sin value","description":"A sin value","mandatory":true}]}]},{"name":"ATan","description":"Returns an angle corresponding to a particular tangential value","example":"upAngle = ATan( height/distance )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"tan value","description":"A tangential value","mandatory":true}]}]},{"name":"Ceil","description":"Returns the ceiling of floating point value . This effectively rounds up Ceil(2.7) == 3, Ceil(3.9) == 4.","example":"rounded_down = Floor( val )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true}]}]},{"name":"Closer","description":"Tests which of two points is the closest. Returns true if point a is closer to the reference than point b","example":"if( Closer( center, models[j].origin , models[i].origin ))...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"reference","description":"The base position","mandatory":true},{"name":"point a","description":"The first point","mandatory":true},{"name":"point b","description":"The second point","mandatory":true}]}]},{"name":"CombineAngles","description":"Returns angles b reoriented by angles a.","example":"crateAnglesInWorld = CombineAngles( boatAngles, crateAnglesInBoat )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angles a","description":"Angles representing the orientation in which to place ","mandatory":true},{"name":"angles b","description":"Angles which will be reoriented","mandatory":true}]}]},{"name":"Cos","description":"Returns the cos of an angle","example":"frac = Cos( degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle in degrees","mandatory":true}]}]},{"name":"DiffTrack","description":"Returns a lagged value between and based on and ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"to","description":"Float, start of the range","mandatory":true},{"name":"from","description":"Float, end of the range","mandatory":true},{"name":"rate","description":"Floating point","mandatory":true},{"name":"deltaTime","description":"Time elapsed","mandatory":true}]}]},{"name":"DiffTrackAngle","description":"Returns a lagged angle between and based on and . Properly accounts for wrapping 2pi","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"to","description":"Float, start of the range","mandatory":true},{"name":"from","description":"Float, end of the range","mandatory":true},{"name":"rate","description":"Floating point","mandatory":true},{"name":"deltaTime","description":"Time elapsed","mandatory":true}]}]},{"name":"Distance","description":"Returns the distance between two points","example":"dist = Distance( org, ai[i].origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"Distance2D","description":"Returns the distance between two points, ignores height difference.","example":"dist = Distance2D( org, ai[i].origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"Distance2DSquared","description":"Returns the squared distance between two points, ignores height difference.","example":"distsq = Distance2DSquared( org, ai[i].origin )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"DistanceSquared","description":"Returns the squared distance between two points - this is cheaper than the actual distance as it doesn't involve a square root","example":"dist2 = DistanceSquared(models[j].origin, center)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point1","description":"The first point","mandatory":true},{"name":"point2","description":"The second point","mandatory":true}]}]},{"name":"Float","description":"Casts a string or an integer to a float","example":"x = Float( floatValString )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A string or integer number to cast to a float","mandatory":true}]}]},{"name":"Floor","description":"Returns the floor of floating point value . This effectively rounds down Floor(2.7) == 2, Floor(3.9) == 3.","example":"rounded_down = Floor( val )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true}]}]},{"name":"ForwardRotateAroundUpByAngle","description":"returns a vector that is the result of angles1 forward vector rotated around its up by degrees","example":"v=ForwardRotateByAngles( player_angles, frustum_edge_angle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{}]}]},{"name":"GetMinBitCountForNum","description":"Returns the minimum number of bits needed to express the provided integer","example":"GetMinBitCountForNum( 15 ) returns 4","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"uint","description":"The integer a minimum bit count is needed for","mandatory":true}]}]},{"name":"Int","description":"Casts a floating point number or a string to an integer","example":"x = Int( self.HUDHealthHeight )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A string or floating point number to cast to an integer","mandatory":true}]}]},{"name":"Length","description":"Returns the length of the given vector","example":"dist = Length(models[j].origin - center)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"A vector","mandatory":true}]}]},{"name":"LengthSquared","description":"Returns the squared vector length for the given vector - this is cheaper than the actual vector length as it doesn't involve a square root","example":"dist2 = LengthSquared(models[j].origin - center)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"A vector","mandatory":true}]}]},{"name":"LerpFloat","description":"Returns a lerped value between and based on ","example":"val = LerpFloat( 0, 10, 0.5);\t// would return 5.0","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"Floating point value, start of the range","mandatory":true},{"name":"to","description":"Floating point value, end of the range","mandatory":true},{"name":"time","description":"Floating point value in the range of 0 - 1","mandatory":true}]}]},{"name":"LerpVector","description":"Returns a lerped vector value between and based on ","example":"val = LerpVector( (0,0,0), (5,5,5), 0.5);\t// would return (2.5, 2.5, 2.5)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"Vector, start of the range","mandatory":true},{"name":"to","description":"Vector, end of the range","mandatory":true},{"name":"time","description":"Floating point value in the range of 0 - 1","mandatory":true}]}]},{"name":"Log","description":"Returns the logarithm of a number to base 10","example":"y = Log( x )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"MapFloat","description":"Returns a lerped value between and based on . is a value between and .","example":"val = MapFloat( 1, 2, 0, 10, 1.5); // would return 5.0","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"timeMin","description":"Floating point value, min time value","mandatory":true},{"name":"timeMax","description":"Floating point value, max time value","mandatory":true},{"name":"from","description":"Floating point value, start of the result range","mandatory":true},{"name":"to","description":"Floating point value, end of the result range","mandatory":true},{"name":"time","description":"Floating point value in the range from to ","mandatory":true}]}]},{"name":"Max","description":"Returns whichever of or is larger.","example":"largest = Max( val1, val2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true},{"name":"b","description":"A float or integer value.","mandatory":true}]}]},{"name":"Min","description":"Returns whichever of or is smallest.","example":"smallest = Min( val1, val2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true},{"name":"b","description":"A float or integer value.","mandatory":true}]}]},{"name":"PackRgba","description":"Packs rgba into a single int.","example":"Byte4PackRgba( 1.0, 1.0, 1.0, 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"red","description":"as a float 0.0-1.0","mandatory":true},{"name":"green","description":"as a float 0.0-1.0","mandatory":true},{"name":"blue","description":"as a float 0.0-1.0","mandatory":true},{"name":"alpha","description":"as a float 0.0-1.0","mandatory":true}]}]},{"name":"PointOnSegmentNearestToPoint","description":"Given a line segment and a point P, this returns the point on the segment that is closest to P.","example":"nearestPoint = PointOnSegmentNearestToPoint( A, B, P )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"SegmentA","description":"One endpoint of the line segment","mandatory":true},{"name":"SegmentB","description":"Other endpoint of the line segment","mandatory":true},{"name":"P","description":"The point","mandatory":true}]}]},{"name":"Pow","description":"Return the value of base raised to exp power.","example":"c = pow( 2, 4 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"exp","description":"A float or integer value, .\"","mandatory":true}]}]},{"name":"RandomFloat","description":"Returns a random floating point number r, where 0 <= r < max","example":"if ( RandomFloat( 100 ) > 50 ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"max","description":"The maximum floating point size","mandatory":true}]}]},{"name":"RandomFloatRange","description":"Returns a random floating point number r, where min <= r < max","example":"rand = RandomFloatRange( 3.0, 5.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"min","description":"The minimum result","mandatory":true},{"name":"max","description":"The maximum result","mandatory":true}]}]},{"name":"RandomInt","description":"Returns a random integer between `0` and `max - 1` inclusive.","example":"if ( RandomInt( 100 ) > 50 ) ...","flags":["verified"],"verifiedInRevision":3,"overloads":[{"calledOn":null,"parameters":[{"name":"max","description":"The maximum integer size.","type":{"dataType":"int"},"mandatory":true}],"returns":{"name":"result","type":{"dataType":"int"},"description":"A random integer between `0` and `max - 1` inclusive."}}]},{"name":"RandomIntRange","description":"Returns a random integer `result`, where `min ≤ result < max`.","example":"rand = RandomIntRange( 3, 5 )","flags":["verified"],"overloads":[{"calledOn":null,"parameters":[{"name":"min","description":"The minimum result.","type":{"dataType":"int"},"mandatory":true},{"name":"max","description":"The maximum result + 1.","type":{"dataType":"int"},"mandatory":true}],"returns":{"name":"result","type":{"dataType":"int"},"description":"A random integer `result`, where `min ≤ result < max`."}}]},{"name":"RotatePoint","description":"Returns lerped angle value.","example":"rotatedPoint = RotatePoint(point, angle )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"point","description":"A point.","mandatory":true},{"name":"angles","description":"An angle.","mandatory":true}]}]},{"name":"RotatePointAroundAxis","description":"returns a vector that is the result of point rotated around the axis vector by num degrees","example":"v = RotatePointAroundAxis( point, up, degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{},{},{}]}]},{"name":"Sin","description":"Returns the sin of an angle","example":"frac = Sin( degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle in degrees","mandatory":true}]}]},{"name":"Sqrt","description":"Returns the square-root of floating point value .","example":"c = sqrt( (a*a) + (b*b) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"a","description":"A float or integer value.","mandatory":true}]}]},{"name":"Tan","description":"Returns the tan of an angle","example":"frac = Tan( degrees )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"angle","description":"An angle in degrees","mandatory":true}]}]},{"name":"VectorCross","description":"Returns the cross product of two vectors","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector a","description":"The first vector","mandatory":true},{"name":"vector b","description":"The second vector","mandatory":true}]}]},{"name":"VectorDot","description":"Returns the dot product of two vectors","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector a","description":"The first vector","mandatory":true},{"name":"vector b","description":"The second vector","mandatory":true}]}]},{"name":"VectorFromLineToPoint","description":"Given a line and a point P, this returns a vector perpendicular to the line and pointing from the line to P.","example":"myvector = VectorFromLineToPoint( A, B, P )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"SegmentA","description":"One point on the line","mandatory":true},{"name":"SegmentB","description":"Another point on the line","mandatory":true},{"name":"P","description":"The point","mandatory":true}]}]},{"name":"VectorLerp","description":"Linear interpolates between two vectors.","example":"color = VectorLerp(oldColor, newColor, timeElapsed / timeTotal)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"from","description":"The vector whose value is used when fraction is 0","mandatory":true},{"name":"to","description":"The vector whose value is used when fraction is 1","mandatory":true},{"name":"fraction","description":"The fraction of the way between vectors. Values less than 0 or greater than 1 do linear extrapolation.","mandatory":true}]}]},{"name":"VectorNormalize","description":"Returns a normalized copy of this vector","example":"difference = VectorNormalize(end - start)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"The vector to normalize","mandatory":true}]}]},{"name":"VectorProjection","description":"Returns the vector projection of vector a onto vector b","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector a","description":"The first vector","mandatory":true},{"name":"vector b","description":"The second vector","mandatory":true}]}]},{"name":"VectortoAngles","description":"Returns a set of angles corresponding to the given vector.","example":"angles = VectortoAngles(end - start)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"vector","description":"The vector to convert to angles","mandatory":true}]}]},{"name":"ActionButtonPressed","description":"Check if the player is pressing the 'action' button. Use this for when the player might be in a scripted sequence but might still press the jump button.","example":"while( self ActionButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotFourButtonPressed","description":"Check if the player is pressing the action slot 4 button","example":"if ( self ActionSlotFourButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotOneButtonPressed","description":"Check if the player is pressing the action slot 1 button","example":"if ( self ActionSlotOneButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotThreeButtonPressed","description":"Check if the player is pressing the action slot 3 button","example":"if ( self ActionSlotThreeButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ActionSlotTwoButtonPressed","description":"Check if the player is pressing the action slot 2 button","example":"if ( self ActionSlotTwoButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"AddToDamageIndicator","description":"Add damage to damage indicator","example":"self AddToDamageIndicator( int( armor_damage ), vDir)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"dmg","description":"The damage","mandatory":true},{"name":"direction","description":"The direction of hit","mandatory":false}]}]},{"name":"AdsButtonPressed","description":"Check if the player is pressing the 'ads' button.","example":"while( self AdsButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"AllowAds","description":"Sets whether the player can switch to ADS","example":"player AllowAds( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player ads","description":": A boolean. true if the player can switch to ADS, and false otherwise.","mandatory":true}]}]},{"name":"AllowCrouch","description":"Sets whether the player can crouch","example":"player AllowCrouch( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player crouch","description":": A boolean. true if the player can crouch, and false otherwise","mandatory":true}]}]},{"name":"AllowDoubleJump","description":"Sets whether the player can double jump","example":"player AllowDoubleJump( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"on off","description":": A boolean. true if the player can double jump, and false otherwise","mandatory":true}]}]},{"name":"AllowJump","description":"Sets whether the player can jump","example":"player AllowJump(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player jump","description":": A boolean. True if the player can jump, and false otherwise","mandatory":true}]}]},{"name":"AllowLean","description":"Sets whether the player can lean","example":"player AllowLean( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player lean","description":": A boolean. true if the player can lean, and false otherwise","mandatory":true}]}]},{"name":"AllowMelee","description":"Sets whether the player can melee","example":"player AllowMelee(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"melee","description":": A boolean. True if the player can melee, and false otherwise","mandatory":true}]}]},{"name":"AllowMeleePowerLeft","description":"Sets whether the player can melee power left","example":"player AllowMeleePowerLeft(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"melee","description":": A boolean. True if the player can melee power left, and false otherwise","mandatory":true}]}]},{"name":"AllowProne","description":"Sets whether the player can go prone","example":"player AllowProne( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player prone","description":": A boolean. true if the player can go prone, and false otherwise","mandatory":true}]}]},{"name":"AllowSlide","description":"Sets whether the player can slide","example":"player AllowSlide( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"on off","description":": A boolean. true if the player can slide, and false otherwise","mandatory":true}]}]},{"name":"AllowSpectateTeam","description":"Set whether the player can spectate the given team.","example":"self AllowSpectateTeam( \"axis\", true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"team","description":"A string description of the team. Valid teams are 'axis', 'allies', 'none' or 'freelook'","mandatory":true},{"name":"spectate","description":"A boolean value describing whether this player can spectate on this team.","mandatory":true}]}]},{"name":"AllowSprint","description":"Sets whether the player can sprint","example":"player AllowSprint(false)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player sprint","description":": A boolean. True if the player can sprint, and false otherwise","mandatory":true}]}]},{"name":"AllowStand","description":"Sets whether the player can stand up","example":"player AllowStand( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player stand","description":": A boolean. true if the player can stand, and false otherwise","mandatory":true}]}]},{"name":"AllowWallRun","description":"Sets whether the player can wall run","example":"player AllowWallRun( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"on off","description":": A boolean. true if the player can wallrun, and false otherwise","mandatory":true}]}]},{"name":"AnyAmmoForWeaponModes","description":"Returns true if the weapon has any ammo left","example":"if ( !(self AnyAmmoForWeaponModes( weapon )) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to check","mandatory":true}]}]},{"name":"ApplyKnockBack","description":"Applies a knockback on a player.","example":"player ApplyKnockBack( 10, dir )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"amount","description":"the amount of knockback to apply","mandatory":true},{"name":"dir","description":"the direction of knockback to apply","mandatory":false}]}]},{"name":"AreControlsFrozen","description":"Returns true if the controls are frozen","example":"if( player AreControlsFrozen() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"AttackButtonPressed","description":"Check if the player is pressing the fire button","example":"if ( self AttackButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"BeginLocationAirstrikeSelection","description":"Begin a location air strike selection","example":"self BeginLocationAirstrikeSelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationArtillerySelection","description":"Begin a location artillery selection","example":"self BeginLocationArtillerySelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationComlinkSelection","description":"Begin a location com link selection","example":"self BeginLocationComlinkSelection( LOCATION_SELECTOR, 1000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationMortarSelection","description":"Begin a location mortar selection","example":"self BeginLocationMortarSelection( LOCATION_SELECTOR, 1500 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationNapalmSelection","description":"Begin a location napalm selection","example":"self BeginLocationNapalmSelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BeginLocationSelection","description":"Begin a location selection","example":"self BeginLocationSelection( LOCATION_SELECTOR )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"selection name","description":"The selection name","mandatory":true},{"name":"radius","description":"The radius of the selection","mandatory":false}]}]},{"name":"BoostButtonPressed","description":"Check if the player is pressing the change seat (Y) button","example":"if ( self BoostButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"BotSetRandomCharacterCustomization","description":"Equips this class number with the default class","example":"self BotSetRandomCharacterCustomization()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"bot","description":null},"parameters":[]}]},{"name":"ButtonBitState","description":"Return true if the button_bit(s) indicated are pressed (note: there is no way to know exactly which buttons are pressed on the client, since everything is remapped into these bit values)","example":"if ( self ButtonBitState( \"BUTTON_BIT_ATTACK\") ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"button","description":": name of button to check \"BUTTON_BIT_ATTACK\" for example, optionally can include as many button names as desired. Returns true if all buttons indicated are true.","mandatory":true}]}]},{"name":"ButtonPressed","description":"Check if the host is pressing the button/key, \"BUTTON_A\", \"BUTTON_B\", \"K\", etc...","example":"while( self ButtonPressed( \"BUTTON_A\" ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CalcPlayerOptions","description":"Calculate player options","example":"playerRenderOptions = self CalcPlayerOptions( class_num )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom class slot","description":"The custom class slot","mandatory":true}]}]},{"name":"CalcWeaponOptions","description":"Calculates weapon options","example":"primaryWeaponOptions = self CalcWeaponOptions( class_num, 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"custom class slot","description":"The custom class slot","mandatory":true},{"name":"weapon slot","description":"primary weapon=0 or secondary weapon=1 or knife weapon=2","mandatory":true}]}]},{"name":"CameraActivate","description":"Turns the script camera on or off.","example":"get_players()[0] CameraActivate( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"active","description":"True to activate the camera, false to turn it off and return to 1st person view","mandatory":true}]}]},{"name":"CameraSetAngles","description":"Sets the focus point of the script camera.","example":"get_players()[0] CameraSetAngles( ( 1100, -23, 644 ) )get_players()[0] CameraSetAngles( my_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"position","description":"Either an entity to focus the camera on or a vector defining the camera's focus point","mandatory":false}]}]},{"name":"CameraSetLookAt","description":"Sets the focus point of the script camera.","example":"get_players()[0] CameraSetLookAt( ( 1100, -23, 644 ) )get_players()[0] CameraSetLookAt( my_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"position","description":"Either an entity to focus the camera on or a vector defining the camera's focus point","mandatory":false}]}]},{"name":"CameraSetPosition","description":"Sets the position of the script camera.","example":"get_players()[0] CameraSetPosition( ( 1100, -23, 644 ) )get_players()[0] CameraSetPosition( my_entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"position","description":"Either an entity to link the camera to or a vector defining the world position","mandatory":true},{"name":"angles","description":"The angles to set for the camera","mandatory":false}]}]},{"name":"CanPlaceRiotshield","description":"Try to place riotshield where the player is standing. return an array containing placement \"result\", \"origin\", and \"angles","example":"placement = level.player CanPlaceRiotshield()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CanPlayerPlaceTurret","description":"Try to place a Turret where the player is looking. It'll return an array containing the placement \"result\", \"origin\", and \"angles\".","example":"placement = level.player CanPlayerPlaceTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"CanPlayerPlaceVehicle","description":"Try to place a vehicle in front of the player. It'll return an array containing the placement \"result\", \"origin\", and \"angles\".","example":"placement = level.player CanPlayerPlaceVehicle( 25, 45, 50, 40, 80, 0.7 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"radius","description":"Radius of the bounds check","mandatory":true},{"name":"height","description":"Height of the bounds check","mandatory":true},{"name":"forward Distance","description":"Distance away from player origin.","mandatory":true},{"name":"up Distance","description":"Distance up from player origin.","mandatory":true},{"name":"sweep Distance","description":"Distance to sweep downwards.","mandatory":true},{"name":"min normal","description":"Minimum hit normal needed to be pass.","mandatory":true}]}]},{"name":"CantSeeEntities","description":"Returns the set of entities that a player cannot see within a given angle, given a set of entities","example":"if( isplayer( self.enemy ) && self.enemy CantSeeEntities( entArray, 67 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entArray","description":"The entities to check against","mandatory":true},{"name":"dotRange","description":"The cosine of the angle representing your fov","mandatory":true},{"name":"trace","description":"Perform a trace for entities","mandatory":true}]}]},{"name":"CarryTurret","description":"Links the auto turret to the player to carry around.","example":"player CarryTurret( turret, offset, angleOffset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"The turret entity","mandatory":true},{"name":"offset","description":"the offset from the player to place the turret","mandatory":true},{"name":"angleOffset","description":"the angle offset of the turret","mandatory":true}]}]},{"name":"ChangeSeatButtonPressed","description":"Check if the player is pressing the change seat (Y) button","example":"if ( self ChangeSeatButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ClearDamageIndicator","description":"Clear damage indicator","example":"self ClearDamageIndicator()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"ClearPerks","description":"removes all perks for a player","example":"player ClearPerks()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ClonePlayer","description":"clone the player's model for death animations.","example":"body = self ClonePlayer(deathAnimDuration)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"deathAnimationDuration","description":"the duration of the death animation","mandatory":true},{"name":"killing weapon","description":"weapon that killed the player","mandatory":true},{"name":"attacker","description":"attacker that killed the player","mandatory":false}]}]},{"name":"CloseInGameMenu","description":"close the in game menu for this client.","example":"player CloseInGameMenu()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"CloseLUIMenu","description":"Closes the given lui menu and returns true if it finds the menu and succeeds in closing it, false otherwise.","example":"player CloseLUIMenu( menu )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu handle","description":"handle to the lui menu.","mandatory":true}]}]},{"name":"CloseMenu","description":"close the specified menu for this client.","example":"player CloseMenu( game[ \"menu_changeclass\" ] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"menu index","description":"The precached menu index of type \"menu\"","mandatory":true}]}]},{"name":"CreateFlashbackClone","description":"clone the player's model for temporary flashback model","example":"body = self CreateFlashbackClone()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"DamageRiotShield","description":"Apply damage to a player riot shield or other weapon that supports damage states.","example":"newhealth = player DamageRiotShield( 100 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DeathStreakActive","description":"Returns true if player's death streak is active","example":"if( player DeathStreakActive() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableDeathStreak","description":"Disable player's death streak","example":"player DisableDeathStreak()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableInvulnerability","description":"Makes player vulnerable to damage. This is default behavior","example":"player DisableInvulnerability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableOffhandWeapons","description":"Disable the player's offhand weapons","example":"player DisableOffhandWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableRoundStartDelay","description":"Enable players weapon after round start delay","example":"player DisableRoundStartDelay()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableUsability","description":"Disables usability for the player","example":"player DisableUsability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableWeaponCycling","description":"Disable the player's weapon cycling","example":"player DisableWeaponCycling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableWeaponFire","description":"Disable the player's weapon fire","example":"player DisableWeaponFire(()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"DisableWeapons","description":"Disable the weapons of the player","example":"self DisableWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"quick","description":"Set the Disable weapons quick flag","mandatory":false}]}]},{"name":"DropItem","description":"Drop an item with the given item name","example":"self DropItem( current )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"item name","description":"the name of the item to drop","mandatory":true},{"name":"dropTag","description":"If specified drop and snap the weapon to this tag","mandatory":false}]}]},{"name":"DropScavengerItem","description":"Drop an item with the given item name. This item will be only available to those with the scavenger perk","example":"self DropScavengerItem( \"scavenger_item_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"item name","description":"the name of the item to drop","mandatory":true}]}]},{"name":"EnableDeathStreak","description":"Enable player's death streak","example":"player EnableDeathStreak()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableInvulnerability","description":"Makes player invulnerable to damage","example":"player EnableInvulnerability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableOffhandWeapons","description":"Enable the player's offhand weapons","example":"player EnableOffhandWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableRoundStartDelay","description":"Disable the players weapon during round start","example":"player EnableRoundStartDelay()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableUsability","description":"Enables usability for the player","example":"player EnableUsability()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableWeaponCycling","description":"Enable the player's weapon cycling","example":"player EnableWeaponCycling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableWeaponFire","description":"Enable the player's weapon fire","example":"player EnableWeaponFire()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EnableWeapons","description":"Enables the weapons of the player","example":"self EnableWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"EndLocationSelection","description":"Ends location selection","example":"self endLocationSelection()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"FakeDamageFrom","description":"Make the player take damage from the given direction","example":"self FakeDamageFrom(vDir)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"dir","description":"The direction to take damage from","mandatory":true}]}]},{"name":"finishMeleeHit","description":"Notifies the clients of the melee hit or miss","example":"self finishMeleeHit( eAttacker, sWeapon, vPoint, vDir, iBoneIndex, bHit )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Origin","description":"(vector) The origin of the damage","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"bone index","description":"Which bone was the closest to the hit","mandatory":true},{"name":"shieldHit","description":"Was the hit delivered against a shield","mandatory":true},{"name":"hit","description":"Was the hit successful or a swipe","mandatory":true},{"name":"fromBehind","description":"Was the hit from behind the victim","mandatory":true}]}]},{"name":"FinishPlayerDamage","description":"Does damage to a player - usually as part of the damage callback","example":"self FinishPlayerDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, vDir, sHitLoc, iBone, vDamageOrigin, psOffsetTime, vSurfaceNormal )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Point","description":"Damage point","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"Hit Loc","description":"The location of the hit","mandatory":true},{"name":"Damage Origin","description":"Where the damage originated from.","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true},{"name":"bone index","description":"Which bone was the closest to the hit","mandatory":true},{"name":"Surface Normal","description":"The normal of the surface impacted.","mandatory":true}]}]},{"name":"ForceGrenadeThrow","description":"Forces the player to throw a held grenade","example":"player ForceGrenadeThrow()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ForceOffHandEnd","description":"Force the player to not use offhand weapon","example":"self forceoffhandend()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ForceSlick","description":"Sets whether the player is forced to be on a slick surface","example":"player ForceSlick(true)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slick","description":": A boolean. True if the player is on a slick surface, and false otherwise","mandatory":true}]}]},{"name":"FragButtonPressed","description":"Check if the player is pressing the frag button","example":"if ( self FragButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"FreezeControls","description":"Blocks or unblocks control input from this player","example":"player FreezeControls( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"freeze state","description":": true if the player's controls are frozen, false otherwise.","mandatory":true}]}]},{"name":"FreezeControlsAllowLook","description":"Blocks or unblocks control input from this player, but allows the player to look around","example":"level.player FreezeControlsAllowLook( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"freeze state","description":": true if the player's controls are frozen, false otherwise.","mandatory":true}]}]},{"name":"GamepadUsedLast","description":"Check if the player is playing with a gamepad.","example":"if( player GamepadUsedLast() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterBodyModel","description":"Gets the body model for this player as selected in character customization","example":"self GetCharacterBodyModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"modelType","description":"The index of the model type, defaults to CCBODY_MODEL_THIRDPERSON","mandatory":false}]}]},{"name":"GetCharacterBodyRenderOptions","description":"Gets the body render options for this player","example":"self GetCharacterBodyRenderOptions()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterBodyType","description":"Gets the character body type for the player.","example":"bodyIndex = self GetCharacterBodyType( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterHeadModel","description":"Gets the head model for this player","example":"self GetCharacterHelmetModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCharacterHelmetModel","description":"Gets the helmet model for this player as selected in character customization","example":"self GetCharacterHelmetModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"modelType","description":"The index of the model type, defaults to CCBODY_MODEL_THIRDPERSON","mandatory":false}]}]},{"name":"GetControllerUIModelValue","description":"Gets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.","example":"player GetControllerUIModelValue( \"hudItems.regenDelayProgress\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"ui model data path from controller","description":"precached name string for the data which we're trying to get.","mandatory":true}]}]},{"name":"GetCurrentOffHand","description":"Get the current offhand weapon","example":"weapon = self GetCurrentOffhand()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCurrentWeapon","description":"Gets the current player weapon","example":"currentweapon = player GetCurrentWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCurrentWeaponAltWeapon","description":"Gets the alt weapon for the players current weapon. Returns \"none","example":"currentweapon = player GetCurrentWeaponAltWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetCurrentWeaponSpinLerp","description":"Gets the current weapon spin ","example":"weapon_spin_lerp = self GetCurrentWeaponSpinLerp()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetEnemyDogTagModel","description":"Get the enemy of the dog tag model currently associated character body","example":"friendly_model = player GetEnemyDogTagModel( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetFractionMaxAmmo","description":"Get fraction of the max ammo","example":"frac = players[i] GetFractionMaxAmmo( lethal_grenade )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give max ammo to","mandatory":true}]}]},{"name":"GetFractionStartAmmo","description":"Give fraction of start ammo to the player for the weapon","example":"start = player GetFractionStartAmmo( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give ammo to","mandatory":true}]}]},{"name":"GetFriendlies","description":"Returns an array of friendly players. The player called on is not included in the array.","example":"friends = self GetFriendlies()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":"true, return only players that are alive, false return all players","mandatory":false}]}]},{"name":"GetFriendlyDogTagModel","description":"Get the friendly of the dog tag model currently associated character body","example":"friendly_model = player GetFriendlyDogTagModel( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetGunAngles","description":"Get the player's gun angles","example":"angles = player GetGunAngles()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetHeroAbilityName","description":"Returns the name of the weapon assigned to the currently selected body","example":"weaponName = self GetHeroAbilityName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetHeroWeaponName","description":"Returns the name of the weapon assigned to the currently selected body","example":"weaponName = self GetHeroWeaponName()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetInventoryHeldWeapon","description":"Gets the player's inventory held weapon","example":"inventoryWeapon = player GetInventoryHeldWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetInventoryWeapon","description":"Get the inventory weapon","example":"inventoryWeapon = self GetInventoryWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetIpAddress","description":"Gets the IP address of the player.","example":"ipAddress = self GetIpAddress()","flags":["malicious"],"overloads":[{"calledOn":{"name":"target","description":"The player to get the IP of.","type":{"dataType":"struct","instanceType":"player","isArray":false}},"parameters":[],"returns":{"name":"ip","description":"The IP address of the player.","type":{"dataType":"string","isArray":false}}}],"verifiedInRevision":3},{"name":"GetLeagueTeamID","description":"Get the league team ID","example":"id = player GetLeagueTeamID()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLightingState","description":"Gets the current lighting state for the player","example":"ls = player GetLightingState()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLockOnLossRadius","description":"Returns the lock on loss radius for the currently equipped heatseeking launcher.","example":"radius = player GetLockOnRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLockOnOrigin","description":"gets the origin to use for the replay gun lockon on the entity","example":"player GetLockOnOrigin( entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true}]}]},{"name":"GetLockOnRadius","description":"Returns the lock on radius for the currently equipped heatseeking launcher.","example":"radius = player GetLockOnRadius()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLockOnSpeed","description":"Returns the lock on speed in miliseconds for the currently equipped heatseeking launcher.","example":"speed = player GetLockOnSpeed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetLUIMenu","description":"Returns a handle to a lui menu.","example":"player GetLUIMenu( \"myMenu\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu name","description":"name of the menu.","mandatory":true}]}]},{"name":"GetLUIMenuData","description":"Gets the current value for the given data name.","example":"player GetLUIMenuData( menu, \"title\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu handle","description":"handle for the lui menu.","mandatory":true},{"name":"lui menu data name","description":"name of the data which had been set on the menu.","mandatory":true}]}]},{"name":"GetMpDialogName","description":"Get the name of the mpdialog bundle of the currently associated character body","example":"mpDialogBundleName = player GetMpDialogName( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[]}]},{"name":"GetNormalizedCameraMovement","description":"Get the player's camera movement normalized","example":"v_stick = player GetNormalizedCameraMovement()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetNormalizedMovement","description":"Get the player's movement normalized","example":"norm_move = self GetNormalizedMovement()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetOffHandSecondaryClass","description":"Get whether the player is using a flash or smoke","example":"offhand_secondary = self GetOffHandSecondaryClass()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPerks","description":"Gets all the player's active perks.","example":"perks = player GetPerks()","flags":["verified"],"verifiedInRevision":4,"overloads":[{"calledOn":{"name":"player","description":"The player to get the perks of.","type":{"dataType":"struct","instanceType":"player"}},"parameters":[],"returns":{"name":"perks","description":"An array of the `specialty` names of the perks the player currently has. This is empty when the player has no perks.","type":{"dataType":"string","isArray":true}}}]},{"name":"GetPlayerAngles","description":"Get the player view angles","example":"angles = player GetPlayerAngles()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayerAttachmentCosmeticVariantIndexes","description":"Get the player's held weapon acvi ","example":"acvi = self GetPlayerAttachmentCosmeticVariantIndexes( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get acvi from","mandatory":true}]}]},{"name":"GetPlayerCameraPos","description":"Get the player's camera position","example":"vieworg = player GetPlayerCameraPos()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayerGenderType","description":"Returns the gender string of the player","example":"if ( self GetPlayerGenderType() == \"male\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"mode","description":"SessionMode","mandatory":true}]}]},{"name":"GetPlayerMovementState","description":"Returns the player movement state for the match record. ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetPlayerSelectedGesture","description":"Get the equipped gesture ","example":"gesture = player GetPlayerSelectedGesture( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"gestureType","description":"The type of gesture to get","mandatory":true}]}]},{"name":"GetPlayerSelectedTaunt","description":"Get the equipped taunt ","example":"taunt = player GetPlayerSelectedTaunt( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"tauntType","description":"The type of taunt to get","mandatory":true}]}]},{"name":"GetPlayerShowcaseWeapon","description":"Get the showcase weapon of the given player","example":"showcaseWeapon = player GetPlayerShowcaseWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetPlayerViewHeight","description":"Get the player's view height","example":"height = player GetPlayerViewHeight()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"getreplaygunlockonorigin","description":"gets the origin to use for the replay gun lockon on the entity","example":"player GetLockOnOrigin( entity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true}]}]},{"name":"GetSnapshotAckIndex","description":"Get the snapshot acknowledgment index","example":"num = self getsnapshotackindex()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetSunShadowSplitDistance","description":"Gets the current sun shadow split difference for the player","example":"distance = player GetSunShadowSplitDistance()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetTargetScreenAngles","description":"Get target screen view angles","example":"angles = self GetTargetScreenAngles( targetpos )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"targetpos","description":"The position to get angles for.","mandatory":true}]}]},{"name":"GetVehicleBoostTime","description":"Gets the vehicle's max boost time","example":"boostTime = player GetVehicleBoostTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleBoostTimeLeft","description":"Gets the vehicle's remaining boost time","example":"boostTimeLeft = player GetVehicleBoostTimeLeft()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleFocusEntity","description":"Gets the current vehicle focus entity for the player","example":"focusEnt = player GetVehicleFocusEntity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleMinBoostTime","description":"Gets the vehicle's min boost time needed in order to boost","example":"minBoostTime = player GetVehicleMinBoostTime()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetVehicleOccupied","description":"Returns the vehicle entity that the player occupies. If player isn't in a vehicle then this causes an error.","example":"self GetVehicleOccupied()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GetWeaponAcvi","description":"Gets weapon options from held weapon","example":"primaryWeaponAcvi = self GetWeaponAcvi( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true}]}]},{"name":"GetWeaponAmmoClip","description":"Gets the given weapon's magazine ammo count.","example":"ammo = self GetWeaponAmmoClip( weapon )","flags":["verified"],"verifiedInRevision":4,"overloads":[{"calledOn":{"name":"player","description":"The player that owns the weapon.","type":{"dataType":"struct","instanceType":"player"}},"parameters":[{"name":"weapon","description":"The weapon to get the ammo count of.","type":{"dataType":"struct","instanceType":"weapon"},"mandatory":true}],"returns":{"name":"ammo","description":"The number of rounds the weapon has in its magazine.","type":{"dataType":"int","isArray":false}}}]},{"name":"GetWeaponAmmoFuel","description":"Get the weapon's fuel count ","example":"fuel = self GetWeaponAmmoFuel( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get fuel count from","mandatory":true}]}]},{"name":"GetWeaponAmmoStock","description":"Get the weapon's total ammo count ","example":"ammo = self GetWeaponAmmoStock( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get ammo count from","mandatory":true}]}]},{"name":"GetWeaponForWeaponRoot","description":"Returns a weapon that the player is holding that has the same weapon root. Returns undefined if the player is not holding the weapon.","example":"weapon_with_attachments = player GetWeaponForWeaponRoot( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to check","mandatory":true}]}]},{"name":"GetWeaponOptions","description":"Get the weapon's render options ","example":"weaponOptions = self GetWeaponOptions( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to get options from","mandatory":true}]}]},{"name":"GetWeaponsList","description":"Gets an array of all weapons that the player has. Alt-mode weapons by default are not included","example":"weapList = player GetWeaponsList()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"include_alt_modes","description":"1/True to include alt-mode weapons","mandatory":false}]}]},{"name":"GetWeaponsListPrimaries","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GiveDedicatedShadow","description":"Sets the model lod bias","example":"player GiveDedicatedShadow( 8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"entity","description":null},"parameters":[{"name":"entity","description":"The entity to enable the dedicated shadow on","mandatory":true}]}]},{"name":"GiveMaxAmmo","description":"Give the weapon max ammo","example":"self GiveMaxAmmo( primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give ammo to","mandatory":true}]}]},{"name":"GiveNextBaseWeapon","description":"Give the player the next base weapon","example":"self GiveNextBaseWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"GiveStartAmmo","description":"Give the weapon initial ammo","example":"self GiveStartAmmo( primary )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give ammo to","mandatory":true}]}]},{"name":"GiveWeapon","description":"Give a weapon to the player","example":"e_player GiveWeapon( w_spike_launcher )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to give","mandatory":true},{"name":"options","description":"The weapon options","mandatory":false},{"name":"acvi","description":"The attachment cosmetic variant index","mandatory":false}]}]},{"name":"GiveWeaponNextAttachment","description":"Give the weapon the next attachment","example":"self giveweaponnextattachment( \"muzzle\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"attachment point","description":"The attachment point name","mandatory":true}]}]},{"name":"HasAGrenadePulledBack","description":"check is a client has a grenade (any type including special) currently pulled back","example":"self HasAGrenadePulledBack( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"HasMaxPrimaryWeapons","description":"Returns true if the player has maximum primary weapons","example":"if( self HasMaxPrimaryWeapons() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"HasPerk","description":"test if player has a perk","example":"player HasPerk( \"specialty_gpsjammer\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"perk name","description":"the perk to check","mandatory":true}]}]},{"name":"HasRiotShield","description":"Return true if player has a riot shield in their inventory.","example":"if ( player HasRiotShield() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"HasWeapon","description":"Returns true if the player has the given weapon","example":"if( e_player HasWeapon( w_spike_launcher, true ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to check","mandatory":true},{"name":"ignore_attachments","description":"Only check the root weapon, ignore all the attachments.","mandatory":false}]}]},{"name":"HideViewModel","description":"Hide the player's current view model.","example":"player HideViewModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"InitialWeaponRaise","description":"Setup weaponstate to force first raise animation","example":"self InitialWeaponRaise( \"ak47\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon name","description":"The weapon to try first raise anim with","mandatory":true}]}]},{"name":"InventoryButtonPressed","description":"Check if the player is pressing the inventory button","example":"if ( self InventoryButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsCarryingTurret","description":"Check if player is carrying turret or not.","example":"player IsCarryingTurret()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsChargeShotPending","description":"Returns true if player has a charge shot pending with a charge shot weapon","example":"if( self IsChargeShotPending() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsDroppingWeapon","description":"Returns true if the player is currently dropping their weapon","example":"player IsDroppingWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsFiring","description":"Returns true if the player is currently meleeing","example":"player IsFiring()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsGrappling","description":"Returns true if the player is currently grappling","example":"player IsGrappling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsHost","description":"Returns true if the player is the host","example":"player IsHost()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsHostForBots","description":"Returns true if the passed in entity is the host for bots","example":"player IsHostForBots()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsInMoveMode","description":"Returns true if the player is in either of the given move modes","example":"if ( player IsInMoveMode( \"ufo\", \"noclip\" ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"move_mode_1","description":"The move mode to check","mandatory":true},{"name":"move_mode_2","description":"The move mode to check","mandatory":false}]}]},{"name":"IsInVehicle","description":"Returns whether or not this player is currently occupying a vehicle.","example":"self IsInVehicle()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsLocalToHost","description":"Returns true if the player is on the same physical machine as the host","example":"player IsLocalToHost()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsLookingAt","description":"Returns true if the player is looking at entity","example":"if( isplayer( self.enemy ) && self.enemy islookingat( self ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":"The entity to check","mandatory":true}]}]},{"name":"IsMeleeing","description":"Returns true if the player is currently meleeing","example":"player IsMeleeing()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsPlayerOnSameMachine","description":"Returns whether or not this player is on the same machine as the other player.","example":"if ( self IsPlayerOnSameMachine( player ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"player","description":"The player to test against","mandatory":true}]}]},{"name":"IsReloading","description":"Returns true if the player is currently reloading","example":"player IsReloading()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsRemoteControlling","description":"Returns whether or not this player is currently occupying a remote controlled entity.","example":"self IsRemoteControlling()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsSwitchingWeapons","description":"Returns true if the player is currently switching weapons","example":"player IsSwitchingWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsTalking","description":"Returns true if the player is talking via voice chat","example":"if( player IsTalking() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsThrowingGrenade","description":"Returns true if the player is currently throwing a grenade","example":"player IsThrowingGrenade()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsUsingOffHand","description":"Returns true if player is using offhand weapon","example":"if( self IsUsingOffHand() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"IsWeaponOverheating","description":"Is the players Weapon Overheating?","example":"self IsWeaponOverheating()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"get heatval","description":"If positive pass back the heatval of the weapon (0 to 100).","mandatory":false},{"name":"weapon","description":"If present check this specific weapon otherwise check the player's current weapon.","mandatory":false}]}]},{"name":"IsWeaponViewOnlyLinked","description":"Returns whether or not this player is linked to an enity with weapon view only linking.","example":"self IsWeaponViewOnlyLinked()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"JumpButtonPressed","description":"Check if the player is pressing the 'jump' button.","example":"while( self JumpButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"LinkGuidedMissileCamera","description":"set player eflags for the guided missile","example":"player LinkGuidedMissileCamera()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"LinkToMissile","description":"Links a player camera and controls to a missile","example":"player LinkToMissile( rocket, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{},{"name":"boost_enabled","description":": If true, the player can trigger missile boost","mandatory":false},{"name":"brake_enabled","description":": If true, the player can trigger missile brake","mandatory":false}]}]},{"name":"MeleeButtonPressed","description":"Check if the player is pressing the melee button","example":"if ( self MeleeButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"MurderLine","description":"Get all the enemy players on the line between given points and murder them to death","example":"player MurderLine( origin, endpos, \"kniferang_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"from","description":"The from position","mandatory":true},{"name":"to","description":"The to position","mandatory":true},{"name":"weapon","description":"The weapon used","mandatory":true}]}]},{"name":"NextPlayerRenderOption","description":"Set the next player render option","example":"level.dev_cac_player NextPlayerRenderOption( tag, forward )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"optionName","description":"The tag of the next option","mandatory":true},{"name":"forward","description":"The delta","mandatory":true}]}]},{"name":"OffhandSpecialButtonPressed","description":"Check if the player is pressing the gadget button","example":"if ( self OffhandSpecialButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"OpenLUIMenu","description":"Opens a lui menu( has to be precahced ) and returns a handle to it.","example":"player OpenLUIMenu( \"myMenu\", true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu name","description":"name of the menu.","mandatory":true},{"name":"persistent","description":"the menu will remain open even if the player dies.","mandatory":false}]}]},{"name":"OpenMenu","description":"Open the menu with the given menu index","example":"self openMenu( game[ \"menu_changeclass\" ] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"menu index","description":"The menu index","mandatory":true}]}]},{"name":"OpenMenuNoMouse","description":"Open the menu with the given menu index","example":"self OpenMenuNoMouse( game[ \"menu_changeclass\" ] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"menu index","description":"The menu index","mandatory":true}]}]},{"name":"PickupAmmoEvent","description":"Lets the client know a weapon was picked up","example":"self PickupAmmoEvent( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"PickupWeaponEvent","description":"Lets the client know a weapon was picked up","example":"self PickupWeaponEvent( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":true}]}]},{"name":"PingPlayer","description":"Flashes a player on their teammate's compasses","example":"self PingPlayer()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayBombDefuse","description":"Play the players bomb defuse animation","example":"self PlayBombDefuse()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayBombPlant","description":"Play the players bomb plant animation","example":"self PlayBombPlant()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayClientAirstrike","description":"Plays the client sided part of the airstrike/bombrun","example":"PlayClientAirstrike( pos, yaw, \"marines\", \"axis\", owner, \"left\", height )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of airstrike","mandatory":true},{"name":"yaw","description":"The yaw","mandatory":true},{"name":"teamFaction","description":"The team faction","mandatory":true},{"name":"team","description":"The team","mandatory":true},{"name":"owner","description":"The owner of airstike","mandatory":true},{"name":"exittype","description":"The exit type","mandatory":true},{"name":"height","description":"The height","mandatory":true}]}]},{"name":"PlayClientNapalm","description":"Plays the client sided part of the Napalm","example":"PlayClientNapalm( startPos, plane.yaw, \"vietcong\", \"axis\", plane.owner, \"left\", height )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"position","description":"The position of Napalm","mandatory":true},{"name":"yaw","description":"The yaw","mandatory":true},{"name":"teamFaction","description":"The team faction","mandatory":true},{"name":"team","description":"The team","mandatory":true},{"name":"owner","description":"The owner of Napalm","mandatory":true},{"name":"exittype","description":"The exit type","mandatory":true},{"name":"height","description":"The height","mandatory":true}]}]},{"name":"PlayerADS","description":"Gets the player weapon position fraction","example":"if ( self PlayerADS() > 0.3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PlayerKnockback","description":"Turn knockback on and off for a player","example":"self PlayerKnockback( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"actor","description":null},"parameters":[{"name":"true/false","description":"if true, client affected by knockback","mandatory":true}]}]},{"name":"PlayHitMarker","description":"Plays a hit marker event","example":"self PlayHitMarker( \"evt_squad_activate\", 3, \"flakjacket\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"sound name","description":"The name of the sound or hash","mandatory":true},{"name":"damage state","description":"How damaged the victim is","mandatory":false},{"name":"perk feedback","description":"If the victim had any perks active that modified the hit marker","mandatory":false},{"name":"is dead","description":"If the victim has died from this hit marker and needs a red flash","mandatory":false}]}]},{"name":"PlayLocalSound","description":"Plays a sound locally","example":"self playlocalsound( \"evt_squad_activate\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"sound name","description":"The name of the sound or hash","mandatory":true}]}]},{"name":"PrimaryButtonPressedLocal","description":"Check if the local player is pressing the primary button (BUTTON_A)","example":"if ( self PrimaryButtonPressedLocal() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"PrimeMovie","description":"Starts priming the cinematic movie to be played.","example":"self PrimeMovie( \"mymovie\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"moviename","description":"movie name","mandatory":true}]}]},{"name":"ReloadButtonPressed","description":"Check if the player is pressing the 'usereload' button.","example":"while( self reloadButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ReloadWeaponAmmo","description":"Set the weapon's ammoclip from the ammo","example":"self ReloadWeaponAmmo( )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to be reloaded","mandatory":true}]}]},{"name":"RemoteControlTurret","description":"Remote control into a turret","example":"player RemoteControlTurret( turret )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"the remote controlled turret.","mandatory":true}]}]},{"name":"RemoteControlTurretOff","description":"Stops remote controlling a turret","example":"player RemoteControlTurretOff( turret )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"the remote controlled turret.","mandatory":true}]}]},{"name":"ResetAnimations","description":"Reset player animations after a body type change","example":"self ResetAnimations())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetCharacterCustomization","description":"Resets all of the character customization to what is in the player stats","example":"self ResetCharacterCustomization()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetFlashBack","description":"Resets the players flashback history","example":"self resetflashback()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ResetSpreadOverride","description":"Reset the player's aim spread to 255","example":"self ResetSpreadOverride()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"Revive","description":"Revive the player","example":"self Revive())","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"RevivePlayer","description":"Callback from script to get player out of last stand, increases health, removes damage timer, should clear screen of damageFX","example":"self RevivePlayer()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"SayAll","description":"Write a client chat message from this client to everybody","example":"self SayAll( saytext )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"message","description":"A localizable message to send to all players","mandatory":true}]}]},{"name":"SayTeam","description":"Write a client chat message from this client to everybody on their team","example":"self SayTeam( sayText )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"message","description":"A localizable message to send to all players on the player's team.","mandatory":true}]}]},{"name":"SecondaryButtonPressedLocal","description":"Check if the local player is pressing the secondary button (BUTTON_B)","example":"if ( self SecondaryButtonPressedLocal() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SecondaryOffhandButtonPressed","description":"Check if the player is pressing the secondary offhand button","example":"if ( self SecondaryOffhandButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SetActionSlot","description":"Sets action slot for the player","example":"self SetActionSlot( 4, \"weapon\", level.DEAD_CONTROL_WEAPON )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slot","description":"The action slot","mandatory":true},{"name":"action slot type","description":"The type of slot. can be \"weapon\"/\"altMode\"/\"\"","mandatory":true},{"name":"weapon","description":"The weapon to set","mandatory":false}]}]},{"name":"SetArenaPoints","description":"Sets the player's arena points","example":"player SetArenaPoints( 19 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"point","description":"points","mandatory":true}]}]},{"name":"SetBlockWeaponPickup","description":"Blocks the player from picking up other weapons while using this weapon","example":"self setBlockWeaponPickup( killstreakWeapon, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to set block for","mandatory":true},{"name":"enabled","description":"True if weapon pickup should be blocked","mandatory":true}]}]},{"name":"SetCarryingObject","description":"Enable or disable the player carrying object flag. Disables doublejump and juke","example":"self SetCarryingObject( true ); // disables doublejump and juke","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"True to enable, false otherwise","mandatory":true}]}]},{"name":"SetCharacterBodyStyle","description":"Sets the character body style for the current body type. Resets all colors for the body style to default.","example":"self SetCharacterBodyStyle( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"character body type index","description":"The index of the character body type","mandatory":true}]}]},{"name":"SetCharacterBodyType","description":"Sets the character body type for the player. Resets all other customization to default for the new body type.","example":"self SetCharacterBodyType( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"character body type index","description":"The index of the character body type","mandatory":true},{"name":"character head type index","description":"The index of the character head type","mandatory":false}]}]},{"name":"SetCharacterHelmetStyle","description":"Sets the character body style for the current helmet type. Resets all colors for the helmet style to default.","example":"self SetCharacterHelmetStyle( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"character body type index","description":"The index of the character body type","mandatory":true}]}]},{"name":"SetClientCGObjectiveText","description":"Sets the objective text only on this client","example":"self SetClientCGObjectiveText( util::getObjectiveScoreText( self.pers[\"team\"] ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"text","description":"The text to set","mandatory":true}]}]},{"name":"SetClientCompass","description":"Sets compass dvar only on this client","example":"self SetClientCompass( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientDrawTalk","description":"Sets cg_drawTalk dvar only on this client","example":"self SetClientDrawTalk( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientFocalLength","description":"Sets cg_focalLength dvar only on this client","example":"self SetClientFocalLength( 23.3622 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The focal length value to set (float)","mandatory":true}]}]},{"name":"SetClientHUDHardcore","description":"Sets ui_hud_hardcore dvar only on this client","example":"self SetClientHUDHardcore( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientMiniScoreboardHide","description":"Sets miniscoreboardhide dvar only on this client","example":"players[i] SetClientMiniScoreboardHide( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"enable","description":"True/1 to hide, false/0 otherwise","mandatory":true}]}]},{"name":"SetClientNumLives","description":"Sets scr_numLives dvar only on this client","example":"self SetClientNumLives( level.numLives )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"numLives","description":"The numlives to set","mandatory":true}]}]},{"name":"SetClientPlayerPushAmount","description":"Sets playerPushAmount dvar only on this client","example":"self SetClientPlayerPushAmount( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"amount","description":"The push amount","mandatory":true}]}]},{"name":"SetClientPlayerSprintTime","description":"Sets player_sprintTime dvar only on this client","example":"self SetClientPlayerSprintTime( level.playerSprintTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"time","description":"The spring time","mandatory":true}]}]},{"name":"SetClientScriptMainMenu","description":"Sets g_scriptMainMenu dvar only on this client","example":"self SetClientScriptMainMenu( game[\"menu_class\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetClientThirdPerson","description":"Set the client to be third person","example":"self SetClientThirdPerson( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"1 to set, 0 otherwise","mandatory":true}]}]},{"name":"SetClientThirdPersonAngle","description":"Sets cg_thirdPerson dvar only on this client","example":"self SetClientThirdPersonAngle( 354 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"angle","description":"The angle to set","mandatory":true}]}]},{"name":"SetClientUIVisibilityFlag","description":"Sets a HUD visibility flag only on this client","example":"e_player SetClientUIVisibilityFlag( \"hud_visible\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flagName","description":"The name of the flag","mandatory":true},{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetControllerUIModelValue","description":"Sets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.","example":"player SetControllerUIModelValue( \"hudItems.regenDelayProgress\", 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"ui model data path from controller","description":"precached name string for the data which we're trying to set.","mandatory":true},{"name":"ui model value","description":"value for the data which we're trying to set on the controller.","mandatory":true}]}]},{"name":"SetCurrentSpectatorClient","description":"Set the given client as a spectator","example":"self SetCurrentSpectatorClient( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"client","description":"The client to set spectator","mandatory":true}]}]},{"name":"SetCurrentWeaponSpinLerp","description":"Set the current weapon's spin ","example":"self SetCurrentWeaponSpinLerp( 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"spin","description":"The spin value","mandatory":true}]}]},{"name":"SetDisabledTargetHint","description":"Set target not selected hint","example":"self SetDisabledTargetHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetElectrifiedState","description":"Sets the player into the electrified state for 3rd person anim purposes. Different from SetElectrified() which plays the postfx","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"electrified","description":": bool whether the player should be in this state.","mandatory":true}]}]},{"name":"SetEnterTime","description":"Sets the player's session enter time","example":"self setEnterTime( getTime() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"time","description":"The time to set","mandatory":true}]}]},{"name":"SetEverHadWeaponAll","description":"Set the EverHadAllPlayerHeldWeapons flag of the player","example":"self SetEverHadWeaponAll( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"flag","description":"True to set the flag","mandatory":true}]}]},{"name":"SetHighlighted","description":"Highlight the player","example":"self SetHighlighted( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"True to highlight, false otherwise","mandatory":true}]}]},{"name":"SetInventoryHeldWeapon","description":"Sets the player's inventoryHeldWeapon.","example":"player SetInventoryHeldWeapon( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The held weapon to be set as inventoryHeldWeapon. Use undefined to clear the inventoryHeldWeapon.","mandatory":true}]}]},{"name":"SetInventoryWeapon","description":"Set the inventory weapon","example":"self SetInventoryWeapon( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to set","mandatory":true}]}]},{"name":"SetLowReady","description":"set the player into low ready weapon state. ","example":"self SetLowReady(true)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"enable","description":"true to set this state","mandatory":true}]}]},{"name":"SetLUIMenuData","description":"Sets a data value for a given lui menu, the data name has to be precached and the value as well, if its a string.","example":"player SetLUIMenuData( menu, \"title\", \"Some Title\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"lui menu handle","description":"handle to the lui menu opened.","mandatory":true},{"name":"lui menu data name","description":"precached name string for the data which we're trying to set.","mandatory":true},{"name":"lui menu data value","description":"value for the data which we're trying to set on the menu.","mandatory":true}]}]},{"name":"SetModelLodBias","description":"Sets the model lod bias","example":"player SetModelLodBias( 8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bias","description":"bias. Setting of 0 reverts to the model lod bias.","mandatory":true}]}]},{"name":"SetNoLOSOnTargetsHint","description":"Set target not selected hint","example":"self SetNoLOSOnTargetsHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetNoTargetsHint","description":"Set target not selected hint","example":"self SetNoTargetsHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"setOffhandPrimaryClass","description":"Set whether the player is using a grenade or gear.","example":"player setOffhandPrimaryClass( \"claymore_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"name","description":"the weapon name","mandatory":true}]}]},{"name":"SetOffhandSecondaryClass","description":"Set whether the player is using a flash or smoke grenade.","example":"player SetOffhandSecondaryClass( \"concussion_grenade_mp\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"name","description":"the weapon name","mandatory":true}]}]},{"name":"SetOffhandVisible","description":"Enable or disable visibility of the offhand weapon","example":"self SetOffhandVisible( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"True/1 to enable, false otherwise","mandatory":true}]}]},{"name":"SetOrigin","description":"Set the player's origin","example":"player SetOrigin( v_origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"The origin to set","mandatory":true}]}]},{"name":"SetParagonIconId","description":"Sets the player's paragon icon id","example":"player SetParagonIconId( 1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"paragon icon id","description":"the paragon rank id","mandatory":true}]}]},{"name":"SetParagonRank","description":"Sets the player's paragon rank","example":"player SetParagonRank( 1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"paragon rank id","description":"the paragon rank id","mandatory":true}]}]},{"name":"SetPerk","description":"give the specified perk","example":"player SetPerk( \"specialty_gpsjammer\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"perk name","description":"the perk to give","mandatory":true}]}]},{"name":"SetPlacementHint","description":"Sets the placement hint string that will be displayed for this player.","example":"player SetPlacementHint( turret.canBePlaced )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"onoff","description":"true if the hint should say that the weapon can be placed, false if not","mandatory":true}]}]},{"name":"SetPlayerAngles","description":"Set the player's view angles","example":"player SetPlayerAngles( v_angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"angles","description":"The view angles to set","mandatory":true}]}]},{"name":"SetPlayerRenderOptions","description":"Sets the player render options","example":"self SetPlayerRenderOptions( playerRenderOptions );\t","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"options","description":"The player render options","mandatory":true}]}]},{"name":"SetRank","description":"Sets the player's rank and prestige level","example":"player SetRank( 1, 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"rank id","description":"the rank id","mandatory":true},{"name":"prestige level","description":"The prestige level","mandatory":false}]}]},{"name":"SetRiotshieldFailHint","description":"Set riot shield fail hint","example":"self SetRiotshieldFailHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetSpawnWeapon","description":"Set the weapon that this player will spawn with","example":"self SetSpawnWeapon( \"ak47\" )during prematch period or grace period in mp)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon name","description":"The name of the weapon to spawn with","mandatory":true}]}]},{"name":"SetSpreadOverride","description":"Set the player's aim spread ","example":"self SetSpreadOverride( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"value","description":"The value to set","mandatory":true}]}]},{"name":"SetSprintCooldown","description":"Set the player's sprint cooldown duration","example":"self SetSprintCooldown( 4 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"The duration to set","mandatory":true}]}]},{"name":"SetSprintDuration","description":"Set the player's sprint duration","example":"self SetSprintDuration( 4 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"The duration to set","mandatory":true}]}]},{"name":"SetSunShadowSplitDistance","description":"Sets the sun shadow split distance for the player","example":"player SetSunShadowSplitDistance( 200 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"distance","description":"split distance. Setting of 0 reverts to the default split distance.","mandatory":true}]}]},{"name":"SetTacticalWheel","description":"Sets whether this player will be able to use the cybercom tactical wheel or not","example":"player SetTacticalWheel( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"enabled","description":"turn on or off","mandatory":true}]}]},{"name":"SetTargetAlreadyInUseHint","description":"Set target already in use failure hint","example":"self SetTargetAlreadyInUseHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetAlreadyTargetedHint","description":"Set target already being targeted hint","example":"self SetTargetAlreadyTargetedHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetedEntityEndTime","description":"Set targeted entity end time, for use on the client side in the UI. ","example":"self SetTargetedEntityEndTime( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"endtime","description":"The end time of the targeted entity","mandatory":true}]}]},{"name":"SetTargetedMissilesRemaining","description":"Set targeted entity missiles remaining, for use on the client side in the UI. ","example":"self SetTargetedMissilesRemaining( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"missilesRemaining","description":"The amount of missiles remaining to destroy the target","mandatory":true}]}]},{"name":"SetTargetingAbortedHint","description":"Set targeting aborted hint","example":"self SetDisabledTargetHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetOORHint","description":"Set out of range failure hint","example":"self SetTargetOORHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetTargetWrongTypeHint","description":"Set target validity failure hint","example":"self SetTargetWrongTypeHint()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":": Weapon to use for the event","mandatory":false}]}]},{"name":"SetVehicleDamageMeter","description":"Sets the vehicle damage meter","example":"player SetRefEndTime( killstreaEndTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"damage","description":"the amount of damage normalized 0..1","mandatory":true}]}]},{"name":"SetVehicleDrivableDuration","description":"Sets the drivable duration for the players vehicle (intended for use with client side display purposes)","example":"player SetVehicleDrivableDuration( killstreakDuration )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"the drivable duration in milliseconds","mandatory":true}]}]},{"name":"SetVehicleDrivableEndTime","description":"Sets the vehicle drivable end time.","example":"player SetVehicleDrivableEndTime( killstreakEndTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"end time","description":"the drivable end time in milliseconds","mandatory":true}]}]},{"name":"SetVehicleFocusEntity","description":"Sets the focus entity for a player driven vehicle (currently only supported by helicopters). This will attempt to make the vehicle orient towards the focus target.","example":"player SetVehicleFocusEntity( focusEntity )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"focus entity","description":"The entity to focus on","mandatory":true}]}]},{"name":"SetVehicleLockedOnByEnt","description":"Sets the vehicle locked on by entity","example":"player SetVehicleLockedOnByEnt( mostDangerousEnemyWithLockOn )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":"an entity that acquired a missile lock on the player's vehicle","mandatory":true}]}]},{"name":"SetVehicleWeaponWaitDuration","description":"Sets the weapon wait duration for the players vehicle (intended for use with client side display purposes)","example":"player SetVehicleWeaponWaitDuration( reloadDuration )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"duration","description":"the weapon reload (or recharge) duration in milliseconds","mandatory":true}]}]},{"name":"SetVehicleWeaponWaitEndTime","description":"Sets the vehicle weapon wait end time.","example":"player SetVehicleWeaponWaitEndTime( weaponReloadEndTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"end time","description":"the weapon wait end time in milliseconds","mandatory":true}]}]},{"name":"SetVelocity","description":"Set the velocity of the player","example":"self setvelocity(force)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"velocity","description":"The velocity to set","mandatory":true}]}]},{"name":"SetViewClamp","description":"Set the view clamp for the player, only works during animscripted for now. Ranges are relative to tag_camera. Left, Right, Top, Bottom","example":"player SetViewClamp( 50, 50, 30, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SetWeaponAmmoClip","description":"Set the weapon's ammo","example":"self SetWeaponAmmoClip( weapon, weapon.clipSize )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true},{"name":"ammo","description":"The ammo count","mandatory":true}]}]},{"name":"SetWeaponAmmoFuel","description":"Set the weapon ammo fuel","example":"self SetWeaponAmmoFuel( weapon, weapondata[\"fuel\"] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true},{"name":"fuel","description":"The ammo fuel amount","mandatory":true}]}]},{"name":"SetWeaponAmmoStock","description":"Set the weapon's ammo","example":"reviver SetWeaponAmmoStock( level.weaponReviveTool, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon","mandatory":true},{"name":"ammo","description":"The new ammo count","mandatory":true}]}]},{"name":"SetWeaponFriendlyHacking","description":"Set the weapon lockon completion percentage","example":"self SetWeaponFriendlyTargetLocked( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"isFriendlyHacking","description":"Set to true if a friendly is hacking the target","mandatory":true}]}]},{"name":"SetWeaponFriendlyTargeting","description":"Set the weapon lockon completion percentage","example":"self SetWeaponFriendlyTargeting( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"isFriendlyTargeting","description":"Set to true if a friendly is targetting","mandatory":true}]}]},{"name":"SetWeaponFriendlyTargetLocked","description":"Set the weapon lockon completion percentage","example":"self SetWeaponFriendlyTargetLocked( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"isFriendlyTargetLocked","description":"Set to true if a friendly is target locked","mandatory":true}]}]},{"name":"SetWeaponHackPercent","description":"Set the weapon hack completion percentage","example":"self SetWeaponHackPercent( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"heat","description":"The heat percent to set","mandatory":true}]}]},{"name":"SetWeaponHeatPercent","description":"Set the weapon heat percentage","example":"self SetWeaponHeatPercent( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"heat","description":"The heat percent to set","mandatory":true}]}]},{"name":"SetWeaponLockOnPercent","description":"Set the weapon lockon completion percentage","example":"self SetWeaponLockOnPercent( weapon, 0.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon (player should have this weapon)","mandatory":true},{"name":"heat","description":"The heat percent to set","mandatory":true}]}]},{"name":"SetWeaponOverheating","description":"Set the players Weapon Overheating value","example":"self SetWeaponOverheating( weapondata[\"overheat\"], weapondata[\"heat\"], weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"overheat","description":"Whether the weapon is overheating.","mandatory":true},{"name":"heatval","description":"The new heatval of the weapon (0 to 100).","mandatory":true},{"name":"weapon","description":"If present set this specific weapon otherwise set the player's current weapon.","mandatory":false}]}]},{"name":"ShowViewModel","description":"Show the player's current view model.","example":"player ShowViewModel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SortHeldWeapons","description":"Sort the playerState heldWeapons to remove empty spaces","example":"e_player SortHeldWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SpawnSpectator","description":"Spawns the player, does not send any notifies","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"origin","description":"origin to spawn","mandatory":true},{"name":"angles","description":"angles to spawn","mandatory":true}]}]},{"name":"SprintButtonPressed","description":"Check if the player is pressing the 'sprint' button.","example":"while( self SprintButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SprintUpRequired","description":"Force the player to release the sprint button before sprinting.","example":"self SprintUpRequired()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StanceButtonPressed","description":"Check if the player is pressing the 'stance' button.","example":"while( self StanceButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"StartCameraTween","description":"Start a camera tween, call this right before a camera pop to do a blend.","example":"player StartCameraTween( 0.5 );","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"time","description":"How long to do the blend.\"","mandatory":true}]}]},{"name":"StartRevive","description":"Starts the revive sequence on a player. is the one administering aid to the player this is called on.","example":"playerInLastStand StartRevive( rescuer )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"reviver","description":"the player reviving the player this is called on","mandatory":true}]}]},{"name":"StopCarryTurret","description":"UnLinks the auto turret from the player and sets it on the ground.","example":"player StopCarryTurret( turret, origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"turret","description":"turret entity","mandatory":true},{"name":"origin","description":"The new origin of turret","mandatory":false},{"name":"angles","description":"The new angles of turret","mandatory":false}]}]},{"name":"StopLocalSound","description":"Stops the local sound","example":"targetent StopLocalSound( level.missileDroneSoundStart )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"sound name","description":"The name of the sound","mandatory":true}]}]},{"name":"StopRevive","description":"Stops the revive behavior on a player when the revive did not complete. is the one administering aid to the player this is called on.","example":"playerInLastStand StopRevive( rescuer )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"reviver","description":"the player reviving the player this is called on","mandatory":true}]}]},{"name":"Suicide","description":"Kills the player immediately as a suicide","example":"self suicide()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"SwitchToOffHand","description":"Switch to the offhand weapon","example":"self SwitchToOffhand( primaryOffhand )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"Weapon to switch to","mandatory":true}]}]},{"name":"SwitchToWeapon","description":"Switch to a different weapon or cycle weapons if no weapon is given","example":"level.player SwitchToWeapon( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon object","description":"The weapon to switch to","mandatory":false}]}]},{"name":"SwitchToWeaponImmediate","description":"Switch to a different weapon or cycle weapons if no weapon is given without playing the dropping animation for current weapon","example":"level.player SwitchToWeaponImmediate( weapon )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon object","description":"The weapon to switch to","mandatory":false}]}]},{"name":"TakeAllWeapons","description":"Makes the player take all weapons","example":"player TakeAllWeapons()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"TakeWeapon","description":"Take the weapon","example":"e_player TakeWeapon( w_spike_launcher )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon","description":"The weapon to take","mandatory":true},{"name":"ignore_attachments","description":"Only check the root weapon, ignore all the attachments.","mandatory":false}]}]},{"name":"ThrowButtonPressed","description":"Check if the player is pressing the 'throw' button.","example":"while( self ThrowButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"TurnedHuman","description":"Called when client is turned back to human","example":"self TurnedHuman()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"UndoLastStand","description":"Undo the last stand for the client","example":"self UndoLastStand()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"client","description":null},"parameters":[]}]},{"name":"UnlinkFromMissile","description":"Unlinks a player camera from a missile","example":"player UnlinkFromMissile()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"UnlinkGuidedMissileCamera","description":"clear player eflags for the guided missile","example":"player UnlinkGuidedMissileCamera()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"UnSetPerk","description":"takes the specified perk from the player","example":"player UnSetPerk( \"specialty_gpsjammer\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"perk name","description":"the perk to unset","mandatory":true}]}]},{"name":"UpdateWeaponOptions","description":"Update weapon options for a weapon that the player has","example":"player UpdateWeaponOptions( \"m1garand\", player calcWeaponOptions() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"weapon name","description":"The weapon name to give to the player","mandatory":true},{"name":"weapon options","description":"options value computed using calcweaponoptions call","mandatory":false}]}]},{"name":"UseButtonPressed","description":"Check if the player is pressing the use button","example":"if ( self UseButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"VehicleMoveUpButtonPressed","description":"Check if the player is pressing the 'stance' button.","example":"while( self StanceButtonPressed() )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponLockCount","description":"returns the number of active lock objects (i.e. those with at least lock started or lock set active)","example":"player WeaponLockCount()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponLockDetect","description":"Sets the tartget as detected. Will clear any existing hard lock. Use WeaponLockStart() to start lock.","example":"player WeaponLockDetect( enemyGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":": An entity.","mandatory":true},{"name":"slot","description":": The slot to operate on (up to MAX_SIMULTANEOUS_LOCKONS)","mandatory":false}]}]},{"name":"WeaponLockFinalize","description":"Locks player's weapon onto an entity. Implies WeaponLockStart(), so this may be called to jump to a hard lock.","example":"player WeaponLockFinalize( enemyGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":": An entity.","mandatory":true},{"name":"slot","description":": The slot to operate on (up to MAX_SIMULTANEOUS_LOCKONS)","mandatory":false}]}]},{"name":"WeaponLockFree","description":"Clears player's weapon lock.","example":"player WeaponLockClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slot","description":"The weapon slot. Default is 0","mandatory":false}]}]},{"name":"WeaponLockNoClearance","description":"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":"player WeaponLockNoClearance( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true},{"name":"slot","description":"The weapon slot. Default is 0","mandatory":false}]}]},{"name":"WeaponLockRemoveSlot","description":"removes the given slot values and compresses the remaining slots (i.e. 1,2,3 with 2 removed becomes 1,3,blank)","example":"player WeaponLockGetFlags()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"slot","description":"The weapon slot. Default is 0","mandatory":true}]}]},{"name":"WeaponLockStart","description":"Begins player's weapon lockon sequence (hud effects, etc). Will clear any existing hard lock. Use WeaponLockFinalize() to complete lock.","example":"player WeaponLockStart( enemyGuy )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"entity","description":": An entity.","mandatory":true},{"name":"slot","description":": The slot to operate on (up to MAX_SIMULTANEOUS_LOCKONS)","mandatory":false}]}]},{"name":"WeaponLockTargetTooClose","description":"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":"player WeaponLockTargetTooClose( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[{"name":"bool","description":": true or false.","mandatory":true},{"name":"slot","description":"The weapon slot. Default is 0","mandatory":false}]}]},{"name":"WeaponPlayEjectBrass","description":"Play the eject brass FX for a weapon.","example":"player WeaponPlayEjectBrass()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"WeaponSwitchButtonPressed","description":"Check if the player is pressing the weapon switch button","example":"if ( self WeaponSwitchButtonPressed() ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"player","description":null},"parameters":[]}]},{"name":"ChangeFontScaleOverTime","description":"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 after calling ChangeFontScaleOverTime, then the hud element will transition to the new fontScale over the remaining .","example":"level.introstring1 ChangeFontScaleOverTime( 1.2 ); level.introstring1.fontScale = 0.3; // This will transition the fontScale from whatever it was before to the new value of 0.3 over 1.2 seconds.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to scale the element font in seconds","mandatory":true}]}]},{"name":"ClearTargetEnt","description":"Clear this waypoint from targetting an entity.","example":"waypoint ClearTargetEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"Destroy","description":"Remove this Hud element altogether.","example":"self.bombstopwatch Destroy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"FadeOverTime","description":"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 after calling fadeOverTime, then the hud element will transition to the new color over the remaining .","example":"level.introstring1 FadeOverTime( 1.2 ); level.introstring1.alpha = 0.3; // This will transition the alpha from whatever it was before to the new value of 0.3 over 1.2 seconds.","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to fade the element in seconds","mandatory":true}]}]},{"name":"GetTextWidth","description":"Returned the width of the text in the hudelem.","example":"width = elem GetTextWidth()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"MoveOverTime","description":"Set a hud element to move over time.","example":"newStr MoveOverTime( timer )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to move the element in seconds","mandatory":true}]}]},{"name":"NewClientHudElem","description":"Create a new hud element for a particular client","example":"self.kc_topbar = NewClientHudElem(self)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"The client for whom the hud element is created.","mandatory":true}]}]},{"name":"NewDamageIndicatorHudElem","description":"Create a new hud element for a particular client","example":"self.kc_topbar = NewClientHudElem(self)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"The client for whom the hud element is created.","mandatory":true}]}]},{"name":"NewDebugHudElem","description":null,"flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"NewHudElem","description":"Create a new hud element","example":"overlay = NewHudElem()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"NewScoreHudElem","description":"Create a new score hud element for a particular client","example":"self.hud_rankscroreupdate = NewScoreHudElem(self)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"client","description":"The client for whom the hud element is created.","mandatory":true}]}]},{"name":"NewTeamHudElem","description":"Create a new hud element for a particular team","example":"level.progressbar_allies_neutralize = NewTeamHudElem( \"axis\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"team","description":"The team for whom the hud element is created. Must be 'axis', 'allies' or 'spectator'","mandatory":true}]}]},{"name":"Reset","description":"Reset a HUD element to its default state.","example":"element Reset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[]}]},{"name":"ScaleOverTime","description":"Set a hud element to scale over time.","example":"other.progressbar ScaleOverTime( level.planttime, level.barsize, 8 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"time","description":"The time to scale the element in seconds","mandatory":true},{"name":"width","description":"The new width of the material.","mandatory":true},{"name":"height","description":"The new height of the material.","mandatory":true}]}]},{"name":"SetClock","description":"Set a clock HUD element to count down over a time period.","example":"level.bombstopwatch SetClock( 5, 60, \"hudStopwatch\", 64, 64 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_clock_element","description":null},"parameters":[{"name":"time","description":"The new timer time in seconds to count down","mandatory":true},{"name":"time","description":"The time in seconds represented by a full cycle of the hand, for instance a stopwatch would be 60s.","mandatory":true},{"name":"material","description":"The material for the hud clock","mandatory":true},{"name":"width","description":"The width of the material.","mandatory":false},{"name":"height","description":"The height of the material.","mandatory":false}]}]},{"name":"SetClockUp","description":"Set a clock HUD element to count up over a time period.","example":"level.bombstopwatch SetClockUp( 5, 60, \"hudStopwatch\", 64, 64 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_clock_element","description":null},"parameters":[{"name":"time","description":"The new timer time in seconds to count up","mandatory":true},{"name":"full time","description":"The time in seconds represented by a full cycle of the hand, for instance a stopwatch would be 60s.","mandatory":true},{"name":"material","description":"The material for the hud clock","mandatory":true},{"name":"width","description":"The width of the material.","mandatory":false},{"name":"height","description":"The height of the material.","mandatory":false}]}]},{"name":"SetCOD7DecodeFX","description":"Set the hudelem string to display with a decode effect.","example":"elem SetCOD7DecodeFX( 2000, 600 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"decodeTime","description":"Time for each letter to decode.","mandatory":true},{"name":"decayStart","description":"Time to wait before starting the text decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetGameTypeString","description":"Set the game type string for the game","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"game type","description":"A string containing the game type","mandatory":true}]}]},{"name":"SetMapNameString","description":"Set the map name string","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"map name","description":"A string containing the map name","mandatory":true}]}]},{"name":"SetPerks","description":"Sets a hud element to be a perks element.","example":"hudelement SetPerks( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"client","description":"client we should be showing the perks of","mandatory":true}]}]},{"name":"SetPlayerNameString","description":"Set the player name string for a HUD element","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"player","description":"A player entity","mandatory":true}]}]},{"name":"SetPulseFX","description":"Set the hudelem string to display with a \"Pulse\" effect.","example":"elem SetPulseFX( 40, 2000, 600 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"speed","description":"Time (in milliseconds) each letter takes to type out.","mandatory":true},{"name":"decayStart","description":"Time to wait before starting the string's decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetRedactFX","description":"Set the hudelem string to display with a redact effect.","example":"elem SetRedactFX( 2000, 600, 3000, 400 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"decayStart","description":"Time to wait before starting the text decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true},{"name":"redactDecayStart","description":"Time to wait before starting the redact decay effect.","mandatory":true},{"name":"redactDecayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetShader","description":"Set the material for this Hud Element","example":"waypoint SetShader( \"playbook_objective_stop\", 15, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"materialname","description":"A the name of the material to set","mandatory":true},{"name":"width","description":"The width of the material.","mandatory":false},{"name":"height","description":"The height of the material.","mandatory":false}]}]},{"name":"SetTargetEnt","description":"Set the entity that this waypoint should target. In MP, entity should already be a broadcasting entity, as with Objective_OnEntity().","example":"waypoint SetTargetEnt( level.axis.bombcarrier )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"entity","description":"Entity to Target","mandatory":true}]}]},{"name":"SetTenthsTimer","description":"Set a timer HUD element to count down in tenths of a second","example":"self.kc_timer SetTenthsTimer( self.archivetime - delay )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetTenthsTimerUp","description":"Set a timer HUD element to count up in tenths of a second","example":"self.kc_timer SetTenthsTimerUp( self.archivetime - delay )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetText","description":"Set HUD text for this element.","example":"level.introstring1 SetText(string1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"text","description":"A localized text reference","mandatory":true}]}]},{"name":"SetTimer","description":"Set a timer HUD element to count down","example":"level.reinforcement_hud SetTimer( level.counter )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetTimerUp","description":"Set a timer HUD element to count up","example":"level.reinforcement_hud SetTimerUp( level.counter )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_timer_element","description":null},"parameters":[{"name":"time","description":"The new timer time","mandatory":true}]}]},{"name":"SetTypewriterFX","description":"Set the hudelem string to display with a redact effect.","example":"elem SetTypewriterFX( 100, 600, 3000 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"letterTime","description":"Time it take for each letter to type in.","mandatory":true},{"name":"decayStart","description":"Time to wait before starting the text decay effect.","mandatory":true},{"name":"decayDuration","description":"How long to spend decaying.","mandatory":true}]}]},{"name":"SetValue","description":"Set a value HUD element to a given value.","example":"level.reinforcement_hud SetValue( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_value_element","description":null},"parameters":[{"name":"value","description":"The value to set the element to","mandatory":true}]}]},{"name":"SetWarGameData","description":"Creates a WAR specific HUD progress element","example":"hudelement SetWarGameData( 0, 1, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"momentumProgress","description":", , ","mandatory":true}]}]},{"name":"SetWayPoint","description":"Sets a hud element to be a waypoint.","example":"newdeathicon SetWayPoint( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"hud_element","description":null},"parameters":[{"name":"constantSize","description":"boolean describing whether the hud element remains the same size","mandatory":true},{"name":"offscreenMaterialName","description":"Material to draw when waypoint is offscreen.","mandatory":false},{"name":"isDistanceShown","description":"boolean turning on/off player distance to waypoint display above the waypoint.","mandatory":false},{"name":"no offscreen","description":"boolean turning on/off arrow indicators when element is offscreen.","mandatory":false}]}]},{"name":"array","description":"create an array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"args","description":"one or more args to add to the array","mandatory":true}]}]},{"name":"ArrayCombine","description":"combine two arrays into and returns one new array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array1","description":"array to operate on","mandatory":true},{"name":"array2","description":"array to operate on","mandatory":true},{"name":"allowdupes","description":"if true then allow duplicate entries, otherwise prune them out when combining","mandatory":true},{"name":"preserve_keys","description":"if true then preserve the keys (only for string keys) otherwise renumber when combining","mandatory":true}]}]},{"name":"ArrayCopy","description":"returns a copy of an array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array1","description":"array to operate on","mandatory":true}]}]},{"name":"ArrayGetClosest","description":"Returns the entity/vector that is closest to the from the .","example":"ent = ArrayGetClosest( player.origin, a_enemies )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The origin to get closest from","mandatory":true},{"name":"array","description":"The array to search in","mandatory":true},{"name":"dist","description":"The minimum distance to check when finding closest (has to be positive)","mandatory":false}]}]},{"name":"ArrayGetFarthest","description":"Returns the entity/vector that is farthest to the from the .","example":"ent = ArrayGetFarthest( player.origin, a_enemies )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The origin to get farthest from","mandatory":true},{"name":"array","description":"The array to search in","mandatory":true},{"name":"dist","description":"The maximum distance when finding farthest (has to be positive)","mandatory":false}]}]},{"name":"ArrayInsert","description":"insert a value into an array at a given index","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to operate on","mandatory":true},{"name":"value","description":"value to insert","mandatory":true},{"name":"index","description":"index at which to insert the value (must be an integer) - moves existing entries as required","mandatory":true}]}]},{"name":"ArrayIntersect","description":"Returns an array of values that are present in both arrays.","example":"newArray = ArrayIntersect( array1, array2 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array1","description":"An Array","mandatory":true},{"name":"array2","description":"An Array","mandatory":true},{"name":"matchKeys","description":"Optionally returns an array of matching key/value pairs from the two input arrays (preserving the keys).","mandatory":false}]}]},{"name":"ArrayRemoveIndex","description":"Remove a value from an array at a given index","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to operate on","mandatory":true},{"name":"index","description":"index of value to remove","mandatory":true},{"name":"preserve_keys","description":"defaults to false, if true then it preserves the keys - otherwise creates integer keys","mandatory":false}]}]},{"name":"ArrayRemoveValue","description":"Remove a value from an array (may affect multiple indexes)","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to operate on","mandatory":true},{"name":"value","description":"value to remove (may be undefined)","mandatory":true},{"name":"preserve_keys","description":"defaults to false, if true then it preserves the keys - otherwise creates integer keys","mandatory":false}]}]},{"name":"Assert","description":"Assert that the given statement is correct. The function will throw a script error if this is false.","example":"Assert( enemyInSight == true )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"statement that is asserted to be correct","mandatory":true},{"name":"desc","description":"string describing the nature of the assert","mandatory":false}]}]},{"name":"AssertMsg","description":"Throws a script error with the given message.","example":"AssertMsg( \"Unhandled enemy type.\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"message","description":"error message","mandatory":true}]}]},{"name":"associativeArray","description":"creates an associativeArray","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"key_i","description":"the string key for the next value","mandatory":false},{"name":"value_i","description":"the value for the previous key","mandatory":false}]}]},{"name":"ErrorMsg","description":"Throws a non-fatal script error with the given message.","example":"ErrorMsg( \"Unhandled enemy type.\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"message","description":"error message","mandatory":true}]}]},{"name":"GetArrayKeys","description":"Returns an array consisting of the keys of the input array.","example":"result = GetArrayKeys( array )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true}]}]},{"name":"GetAttachmentTableIndex","description":"Returns the attachment table index for the attachment name","example":"attachmentIndex = GetAttachmentTableIndex( \"reflex\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"attachmentRef","description":"Attachment Reference","mandatory":true}]}]},{"name":"GetDvarFloat","description":"Gets the value of a dvar.","example":"GetDvarFloat( \"r_eyesAdjust\", 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be an float.","mandatory":false}]}]},{"name":"GetDvarInt","description":"Gets the value of a dvar.","example":"GetDvarInt( \"r_eyesAdjust\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be an integer.","mandatory":false}]}]},{"name":"GetDvarString","description":"Gets the value of a dvar.","example":"GetDvarString( \"r_eyesAdjust\", \"yes\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be a string.","mandatory":false}]}]},{"name":"GetDvarVector","description":"Gets the value of a dvar.","example":"GetDvarVector( \"r_eyesAdjust\", (1,0,0) )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"dvar","description":"The dvar name as a string or hash.","mandatory":true},{"name":"default_value","description":"The value to be returned if the dvar doesn't exist, must be an vector.","mandatory":false}]}]},{"name":"GetFirstArrayKey","description":"Returns the first key of the input array.","example":"key = GetFirstArrayKey( array )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true}]}]},{"name":"GetItemIndexFromRef","description":"Returns the item index for the specified item reference","example":"itemIndex = GetItemIndexFromRef( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"itemRef","description":"Item Reference","mandatory":true}]}]},{"name":"GetLastArrayKey","description":"Returns the last key of the input array.","example":"key = GetLastArrayKey( array )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true}]}]},{"name":"GetNextArrayKey","description":"Returns the next key of the input array, after the specified key.","example":"key = GetNextArrayKey( array, key )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true},{"name":"key","description":"The given key","mandatory":true}]}]},{"name":"GetPrevArrayKey","description":"Returns the prev key of the input array, before the specified key.","example":"key = GetPrevArrayKey( array, key )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"Input array","mandatory":true},{"name":"key","description":"The given key","mandatory":true}]}]},{"name":"GetSubStr","description":"Returns the substring of characters >= and < . is optional.","example":"name = getSubStr( playerwarp_string, 8 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The input string","mandatory":true},{"name":"start index","description":"The start index of the substring","mandatory":true},{"name":"end index","description":"The end index of the substring","mandatory":false}]}]},{"name":"IsArray","description":"Checks whether this entity/variable is an array","example":"if ( isarray ( gun_owner )) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a array","mandatory":true}]}]},{"name":"IsClass","description":"Checks whether this entity/variable is a class object","example":"if ( isclass(self)) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a class","mandatory":true}]}]},{"name":"IsFloat","description":"Checks whether this entity/variable is a float","example":"if ( IsFloat( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a float","mandatory":true}]}]},{"name":"IsFunctionPtr","description":"Checks whether given variable is of type Function Pointer in script, useful to differentiate between Var and FuncPtr in Script.","example":"if ( IsFunctionPtr( myFuncPtr ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable to test","mandatory":true}]}]},{"name":"IsInArray","description":"searches an array to determine if a given value is present in that array","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"array","description":"array to search","mandatory":true},{"name":"value","description":"value to search for","mandatory":true}]}]},{"name":"IsInt","description":"Checks whether this entity/variable is an int","example":"if ( IsInt( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be an int","mandatory":true}]}]},{"name":"IsString","description":"Checks whether this entity/variable is a string","example":"if ( isstring ( gun_owner )) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a string","mandatory":true}]}]},{"name":"IsStruct","description":"Checks whether this variable is a struct object","example":"if ( isstruct(self)) ... ","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a struct","mandatory":true}]}]},{"name":"IsSubStr","description":"Returns true/false if is a substring of . Case sensitive.","example":"has_str = IsSubStr( \"my_string\", \"str\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"istring","description":"Casts a string to an istring","example":"x = istring( String )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"value","description":"A string to cast to an istring","mandatory":true}]}]},{"name":"IsVec","description":"Checks whether this entity/variable is a vector","example":"if ( IsVec( gun_owner ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"variable","description":"variable that may or may not be a vector","mandatory":true}]}]},{"name":"IsWeapon","description":"Checks whether this is a weapon object","example":"if ( IsWeapon( current_weapon ) ) ...","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon_object","description":"An parameter that may be a weapon object","mandatory":true}]}]},{"name":"MakeLocalizedString","description":"Make a localized string of the given string","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The string to translate","mandatory":true}]}]},{"name":"sprintf","description":"Replaces field specifiers in a string with values passed in, returns result string format specifiers take the form of {[n]} in the source string where [n] indicates which value to print, e.g. 0 is the first user arg","example":"sprintf(\"{0} is the first string\",\"first\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The string to translate","mandatory":true},{"name":"args","description":"zero or more arguments","mandatory":false}]}]},{"name":"StrEndsWith","description":"Returns true/false if ends with . Case sensitive.","example":"ends_with = StrEndsWith( \"my_string\", \"_string\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"String to search","mandatory":true},{"name":"substring","description":"Substring to search with.","mandatory":true}]}]},{"name":"StrIsFloat","description":"Check if a string is a float.","example":"StrIsFloat( \"1.2\" ); // true","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to check.","mandatory":true}]}]},{"name":"StrIsInt","description":"Check if a string is an int.","example":"StrIsInt( \"1\" ); // true","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to check.","mandatory":true}]}]},{"name":"StrIsNumber","description":"Check if a string is a number.","example":"StrIsNumber( \"1.2\" ); // true","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to check.","mandatory":true}]}]},{"name":"StrStartsWith","description":"Returns true/false if starts with . Case sensitive.","example":"starts_with = StrStartsWith( \"my_string\", \"my_\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"String to search","mandatory":true},{"name":"substring","description":"Substring to search with.","mandatory":true}]}]},{"name":"StrStrip","description":"Strip whitespace from right and left side of string.","example":"StrStrip( \" hq_cleared \" ); // 'hq_cleared'","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":": The string to strip.","mandatory":true}]}]},{"name":"StrTok","description":"Tokenizes by the delimiters . Returns the array of string tokens.","example":"my_string_array = StrTok( \"my_string; my_string_2\", \"; \" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The input string","mandatory":true},{"name":"delim","description":"The delimiter to tokenize by","mandatory":true}]}]},{"name":"StrTok2","description":"Tokenizes by a single delimiter string. doesn't treat the delimiter string as a series of characters, but as a string","example":"my_string_array = StrTok2( \"my_string foo; my_string_2\", \"foo; \" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"The input string","mandatory":true},{"name":"delim","description":"The delimiter to tokenize by","mandatory":true},{"name":"case_sensitive","description":"true if test is case sensitive","mandatory":false}]}]},{"name":"TableLookup","description":"look up a row in a table and pull out a particular column from that row","example":"TableLookup( \"mp/statstable.csv\", 0, \"INDEX_KILLS\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search column num","description":"The column number of the stats table to search through","mandatory":true},{"name":"search value","description":"The value to use when searching the ","mandatory":true},{"name":"return value column num","description":"The column number value to return after we find the correct row","mandatory":true}]}]},{"name":"TableLookupColumnCount","description":"look up the number of columns in a table","example":"TableLookup( \"mp/statstable.csv\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true}]}]},{"name":"TableLookupColumnForRow","description":"look up a particular row and column in a table","example":"TableLookupColumnForRow( \"gamedata/tables/mp/exampleStringTable.csv\", 101, 7 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search row num","description":"The row number of the string table to search through","mandatory":true},{"name":"search column num","description":"The column number of the string table to search through","mandatory":true}]}]},{"name":"TableLookupFindCoreAsset","description":"Find core asset index for a stringtable","example":"TableLookupRowNum( \"mp/statstable.csv\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true}]}]},{"name":"TableLookupIString","description":"look up a row in a table and pull out a particular column from that row","example":"TableLookupIString( \"mp/statstable.csv\", 0, \"INDEX_KILLS\", 1 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search column num","description":"The column number of the stats table to search through","mandatory":true},{"name":"search value","description":"The value to use when searching the ","mandatory":true},{"name":"return value column num","description":"The column number value to return after we find the correct row","mandatory":true}]}]},{"name":"TableLookupRow","description":"Return an array of strings for the columns in that row","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"row num","description":"The row num of the row in table to return","mandatory":true}]}]},{"name":"TableLookupRowCount","description":"look up the number of rows in a table","example":"TableLookup( \"mp/statstable.csv\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true}]}]},{"name":"TableLookupRowNum","description":"look up a row number in a table","example":"TableLookupRowNum( \"mp/statstable.csv\", 0, \"INDEX_KILLS\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"filename","description":"The table to look up","mandatory":true},{"name":"search column num","description":"The column number of the stats table to search through","mandatory":true},{"name":"search value","description":"The value to use when searching the ","mandatory":true}]}]},{"name":"Throw","description":"force a script exception (from a builtin call)","example":"throw( )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ToLower","description":"Converts to a lower case string which is returned.","example":"my_string = ToLower( \"MY_STRING\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"(string) Base string","mandatory":true}]}]},{"name":"ToUpper","description":"Converts to a upper case string which is returned.","example":"my_string = ToUpper( \"lower\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"string","description":"(string) Base string","mandatory":true}]}]},{"name":"AttachPath","description":"Attaches this vehicle to the given path.","example":"bomber AttachPath( aBomberPaths[i] )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node","description":"A node on the path to attach.","mandatory":true}]}]},{"name":"CancelAIMove","description":"Tell the vehicle to stop moving towards its current goal position.","example":"eTank CancelAIMove()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearDefaultPitch","description":"Clears the desired default pitch for a vehicle.","example":"level.heli cleardefaultpitch()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearGoalYaw","description":"Clear the goal yaw direction for this vehicle.","example":"level.flak1 ClearGoalYaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearGunnerTarget","description":"Clear the target for the vehicle turret.","example":"eTank ClearGunnerTarget(0)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"Which gun, 0-3.","mandatory":false}]}]},{"name":"ClearLookAtEnt","description":"Clear the entity or origin the vehicle is orienting towards.","example":"heli clearLookAtEnt()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearTargetYaw","description":"Clear the target yaw direction for this vehicle.","example":"level.flak1 cleartargetyaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ClearTurretTarget","description":"Clear the target for the vehicle turret.","example":"eTank ClearTurretTarget()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"ClearVehGoalPos","description":"Clears the target position for this vehicle.","example":"tank ClearVehGoalPos()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"CreateTrack","description":"Set the node enabled or disabled for vehicle pathfinding. SetVehGoalPos will now return true or false if it can find a path.","example":"CreateTrack( track_node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{}]}]},{"name":"DisableDriverFiring","description":"Enables or disables the driver's vehicle turret","example":"tank DisableDriverFiring( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"DisableGunnerFiring","description":"Enable or disable gunner firing","example":"tank DisableGunnerFiring( 1, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"The gunner to disable/enable","mandatory":true},{"name":"onoff","description":"true to disable, false otherwise","mandatory":true}]}]},{"name":"DrawTrajectory","description":"Draws the vehicles trajectory.","example":"plane DrawTrajectory( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"show","description":"Whether to draw trajectory or not","mandatory":true}]}]},{"name":"DrivePath","description":"Starts the vehicle driving this path and uses the vehicle physics, not locked to the spline, can only achieve turns that the physics can handle.","example":"huey DrivePath( start_node )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node index","description":"A node on the path to attach.","mandatory":false},{"name":"allow free drive","description":"This give the player free driving but script notifies when passing nodes on a vehcile spline","mandatory":false}]}]},{"name":"FinishVehicleDamage","description":"Does damage to an vehicle - usually as part of the damage callback","example":"self FinishVehicleDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, vDir, sHitLoc, psOffsetTime, damageUnderneathVehicle, modelindex, partname, damageteammates )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Point","description":"Point of damage","mandatory":true},{"name":"Direction","description":"(vector) The direction of the damage","mandatory":true},{"name":"Hit Loc","description":"The location of the hit","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true},{"name":"DamageFromUnderneath","description":"If the hit is underneath the vehicle","mandatory":true},{"name":"modelIndex","description":"which model in the dobj was hit","mandatory":true},{"name":"partIndex","description":"which bone was hit","mandatory":true},{"name":"damageteammates","description":"Whether to damage teammates or not","mandatory":true}]}]},{"name":"FinishVehicleRadiusDamage","description":"Does damage to an vehicle - usually as part of the damage callback","example":"self FinishVehicleRadiusDamage( eInflictor, eAttacker, iDamage, iDFlags, sMeansOfDeath, sWeapon, vPoint, fRadius, fConeRadius, fConeDir, psOffsetTime )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"Inflictor","description":"The entity that causes the damage.(e.g. a turret)","mandatory":true},{"name":"Attacker","description":"The entity that is attacking.","mandatory":true},{"name":"Damage","description":"Integer specifying the amount of damage done","mandatory":true},{"name":"Inner Damage","description":"Integer specifying the amount of inner damage done","mandatory":true},{"name":"Outer Damage","description":"Integer specifying the amount of outer damage done","mandatory":true},{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true},{"name":"Point","description":"(vector) The Point of the damage","mandatory":true},{"name":"Radius","description":"(float) The radius of the damage","mandatory":true},{"name":"ConeRadius","description":"(float) The radius of the cone damage","mandatory":true},{"name":"ConeDirection","description":"(vector) The direction of the cone damage","mandatory":true},{"name":"Offset Time","description":"The time offset for the damage","mandatory":true}]}]},{"name":"FireWeapon","description":"Fire the vehicle's weapon","example":"m_vehicle FireWeapon( 0, m_e_target, v_target_offset )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret_index","description":"turret index, 0 being main turret, 1~4 being gunners","mandatory":false},{"name":"target ent","description":"A target entity for guided missiles","mandatory":false},{"name":"target offset","description":"Only used for projectile and bomb weapons","mandatory":false},{"name":"attacker","description":"real attacker who should take credit of this shot","mandatory":false}]}]},{"name":"Flip180","description":"Flips this vehicle 180 (for going forwards / backwards along a path)","example":"huey Flip180()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"FreeVehicle","description":"Frees this vehicle instance. It will unlink any players occupying the vehicle. It will change the vehicle into a vehicle corpse. It will send a death notify on the vehicle. Once called the vehicle cannot move anymore.","example":"self FreeVehicle()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetAllVehicleNodes","description":"Gets all of the vehicle nodes in a level","example":"nodes = GetAllVehicleNodes()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetAngularVelocity","description":"Gets the current angular velocity.","example":"self GetAngularVelocity()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetAttachPos","description":"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":"pos = self GetAttachPos( node )origin = pos[0]angles = pos[1]","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node index","description":"A node on the path to attach.","mandatory":true}]}]},{"name":"GetBrake","description":"Gets the brake value of a nitrous physics vehicle.","example":"jeep getbrake()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetDefaultAcceleration","description":"Gets the acceleration value set in GDT.","example":"accel = self GetDefaultAcceleration()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"getgoalspeedMPH","description":"Gets the goal speed in miles per hour.","example":"self GetGoalSpeedMPH()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetGoalYaw","description":"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":"level.flak1 GetGoalYaw()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetGunnerTargetEnt","description":"Gets the target entity for this gunner position.","example":"target = huey GetGunnerTurretEnt( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"Which gun, 0-3.","mandatory":true}]}]},{"name":"GetGunnerTargetVec","description":"Get the target position for this vehicle turret gunner.","example":"endpt = GetGunnerTargetVec( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"which gun 0-3","mandatory":true}]}]},{"name":"GetHandBrake","description":"Gets the hand brake value of a nitrous physics vehicle.","example":"jeep gethandbrake()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetHeliHeightLock","description":"Locks the heli to the height mesh","example":"if ( vehicle GetHeliHeightLock( ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetHeliHeightLockHeight","description":"Gets the mesh height at a given point.","example":"maxheight = GetHeliHeightLockHeight( point )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"point","description":"The point to check at","mandatory":true}]}]},{"name":"GetMaxSpeed","description":"Get the max speed of a vehicle. By default gets the script setting","example":"heli GetMaxSpeed( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"get gdt","description":"true to get the gdt setting and not the script set.","mandatory":false}]}]},{"name":"GetNumVehicles","description":"Gets the number of vehicles entities in the level","example":"vehicleCount = GetNumVehicles()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"GetOccupantSeat","description":"Get the seat index occupied by the given player. -1 if player isn't in vehicle.","example":"isDriver = 0 == vehicle GetOccupantSeat( player )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"player","description":"The player to get the seat index for","mandatory":true}]}]},{"name":"GetPathFixedOffset","description":"Gets a fixed offset from the path for a specific vehicle.","example":"offset = huey GetPathFixedOffset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetPathVariableOffset","description":"Gets a variable offset from the path for a specific vehicle.","example":"offset = huey GetPathVariableOffset()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetPhysAcceleration","description":"Gets the vehicles acceleration vector.","example":"accel = plane GetPhysAccel()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetScriptBrake","description":"Gets the script brake value of a nitrous physics vehicle.","example":"jeep getscriptbrake()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetSeatFiringAngles","description":"Retrieve the angles specifying the direction in which bullets, projectiles, etc. will be emitted from the weapon when it is fired.","example":"turretBarrelAngles = tank GetSeatFiringAngles( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat index","description":"The seat to firing angles for","mandatory":true}]}]},{"name":"GetSeatFiringOrigin","description":"Retrieve the location at the end of the barrel where bullets, projectiles, etc. are emitted when the gun is fired.","example":"turretBarrelOrigin = tank GetSeatFiringOrigin( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat index","description":"The seat to firing origin for","mandatory":true}]}]},{"name":"GetSeatOccupant","description":"Get the entity occupying the given seat index. Undefined if the seat is empty.","example":"driver = vehicle GetSeatOccupant( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true}]}]},{"name":"GetSpeed","description":"Gets the current speed in inches per second.","example":"self GetSpeed()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetSpeedMPH","description":"Gets the current speed in miles per hour.","example":"self GetSpeedMPH()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetSteering","description":"Returns the steer factor of the vehicle.","example":"self GetSteering()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetThrottle","description":"Returns the throttle factor of the vehicle.","example":"self GetThrottle()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetTimeFromVehicleNodeToNode","description":"The time it would take to go from start node to end node if traveling the spline speed.","example":"time = GetTimeFromVehicleNodeToNode( start_node, end_node )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"start_node","description":"The start node of the path","mandatory":true},{"name":"end_node","description":"The end node of the path","mandatory":true}]}]},{"name":"GetTurretHeatValue","description":"Get the current heat value for a vehicle weapon.","example":"heat = self GetTurretHeatValue( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"which gun 0-3","mandatory":true}]}]},{"name":"GetTurretLimitsYaw","description":"Get the furthest relative yaw angles the turret can aim, all numbers are positive","example":"limit = veh GetTurretLimits( 1 ); limitMin = -limit[0]; limitMax = limit[1]","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"GetTurretTargetVec","description":"Get the target position for this vehicle turret or gunner.","example":"endpt = GetTurretTargetVec( 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"GetVehDamageMultiplier","description":"Gets the damage multiplier that applies to the damage type.","example":"vehicle GetVehDamageMultiplier( damgType )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"damageType","description":"The type of damage being applied to the vehicle","mandatory":true}]}]},{"name":"GetVehicleAvoidance","description":"Locks the heli to the height mesh","example":"if ( vehicle GetVehicleAvoidance() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetVehicleAvoidanceNodes","description":"Get the positions for nearby avoidance nodes.","example":"nodes = plane GetVehicleAvoidanceNodes( radius )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"radius","description":"A radius to filter out nodes returned.","mandatory":true}]}]},{"name":"GetVehicleNode","description":"Gets a vehicle node with the given name, key pair","example":"node = getvehiclenode(self.target, \"targetname\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"(string) The name to search for","mandatory":true},{"name":"key","description":"(string) The key that name goes with","mandatory":true}]}]},{"name":"GetVehicleNodeArray","description":"Gets an array of vehicle nodes that have the given name, key pair","example":"nodes = GetVehicleNodeArray(self.target, \"targetname\")","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"name","description":"(string) The name to search for","mandatory":true},{"name":"key","description":"(string) The key that name goes with","mandatory":true}]}]},{"name":"GetVehicleOwner","description":"Returns the owner of this particular vehicle.","example":"eFlak88user = eFlak88 GetVehicleOwner()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetVehOccupants","description":"Get the occupants of this vehicle in an entity array.","example":"ridersarray = vehicle getvehoccupants()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"GetWheelSurface","description":"Returns the surface type of the given wheel as a string.","example":"surface = self GetWheelSurface( side )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"wheel","description":"The wheel position, can be 'front_left', 'front_right', 'back_left', 'back_right', 'middle_left', 'middle_right'","mandatory":true}]}]},{"name":"IsDriverFiring","description":"Checks if this driver is firing the vehicle turret","example":"if( tank IsDriverFiring() )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsGunnerFiring","description":"Checks if this gun is currently firing.","example":"if( tank IsGunnerFiring( 1 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"The gunner to check","mandatory":true}]}]},{"name":"IsInsideHeliHeightLock","description":"Returns true if Helicopter is inside height mesh","example":"if ( IsInsideHeliHeightLock() )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"isremotecontrol","description":"Query whether this vehicle is usable by players","example":"if ( vehicle isvehicleusable( ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsTurretReady","description":"Query whether this vehicle's turret is ready for firing","example":"while ( level.playertank IsTurretReady() != true ) ...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsVehicleImmuneToDamage","description":"This checks the vehicle GDT settings related to bulletdamage, grenadedamage, etc.","example":"if ( vehicle IsVehicleImmuneToDamage( flags, mod, weapon ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"Damage Flags","description":"Integer specifying flags that are to be applied to the damage","mandatory":true},{"name":"Means Of Death","description":"Integer specifying the method of death","mandatory":true},{"name":"Weapon","description":"The weapon number of the weapon used to inflict the damage","mandatory":true}]}]},{"name":"IsVehicleManualControl","description":"check if vehicle hkai behavior is enabled. Not to be confused with UseVehicle()","example":"vehicle IsVehicleManualControl()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"IsVehicleSeatOccupied","description":"same as useby except you can specify a seat, 0 driver, 1-4 gunners, 5-10 passengers","example":"lvt IsVehicleSeatOccupied( 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true}]}]},{"name":"IsVehicleTurretOverheating","description":"Returns true if the vehicle turret weapon is overheating, else returns false.","example":"if( self IsVehicleTurretOverheating( 1 ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"which gun 0-3","mandatory":true}]}]},{"name":"IsVehicleUsable","description":"Query whether this vehicle is usable by players","example":"if ( vehicle isvehicleusable( ) )...","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"JoltBody","description":"Jolts the vehicle.","example":"self JoltBody( (self.origin + (0,0,64)), 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"jolt position","description":"The position of the jolt","mandatory":true},{"name":"intensity","description":"The intensity of the jolt","mandatory":true},{"name":"speedFrac","description":"A speed fraction to apply to the jolt. Most be betweeon 0 and 1.","mandatory":false},{"name":"deceleration","description":"The deceleration to apply to this vehicle in miles per hour per second.","mandatory":false}]}]},{"name":"MakeVehicleUnusable","description":"Sets this vehicle to be not usable by the player","example":"car MakeVehicleUnusable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"MakeVehicleUsable","description":"Sets this vehicle to be usable by the player","example":"nFlak makeVehicleUsable()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"PathFixedOffset","description":"Sets a fixed offset for this vehicle to travel on a vehicle path.","example":"huey PathFixedOffset( (0, -200, 0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"offset","description":"The offset to apply. A vector in the form (forward, right, up)","mandatory":true}]}]},{"name":"PathFixedOffsetClear","description":"Clears the vehicles fixed offset.","example":"huey PathFixedOffsetClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"PathMove","description":"Moves the entire path for this vehicle to the specific origin and angles.","example":"huey PathMove( node, origin, angles )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"node index","description":"Which node to move to the new location (it moves the whole path not just this node).","mandatory":true},{"name":"new origin","description":"The new position","mandatory":true},{"name":"new angles","description":"The new angles","mandatory":true}]}]},{"name":"PathMoveClear","description":"Clears the moved path for this vehicle. If not cleared then all paths taken will be moved.","example":"huey PathMoveClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"PathVariableOffset","description":"Sets a variable offset for this vehicle to travel on a vehicle path.","example":"huey PathVariableOffset( (0, 50, 0), 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"offset","description":"The offset to apply. A vector in the form (forward, right, up)","mandatory":true},{"name":"time","description":", The interval at which to choose new offsets","mandatory":true}]}]},{"name":"PathVariableOffsetClear","description":"Clears the vehicles variable offset.","example":"huey PathVariableOffsetClear()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"RecalcSplinePaths","description":"Recalcs all the nodes int the map","example":"tank2 RecalcSplinePaths()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ReconnectVehicleNodes","description":"Reconnect vehicle nodes","example":"ReconnectVehicleNodes()","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[]}]},{"name":"ResetVehicleFromDropDeploy","description":"Reset vehicle properties from drop deploy so that it may behave as normal.","example":"raps ResetVehicleFromDropDeploy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"ResumeSpeed","description":"Sets the vehicle to resume its path speed.","example":"level.tank ResumeSpeed( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"acceleration","description":"The acceleration to apply to this vehicle in miles per hour per second.","mandatory":false}]}]},{"name":"ReturnPlayerControl","description":"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":"cobra returnplayercontrol()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"SeatGetWeapon","description":"Returns the weapon name for the specified seat. Undefined if there isn't a weapon. Only driver and gunner seats can have weapons.","example":"weaponname = vehicle SeatGetWeapon( 0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat index","description":"The seat to get weapon for","mandatory":true}]}]},{"name":"SetAcceleration","description":"Sets the acceleration for this vehicle.","example":"self SetAcceleration( 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"acceleration","description":"The acceleration of the vehicle in miles per hour per second","mandatory":true}]}]},{"name":"SetAirResistance","description":"Sets the speed at which air resistance maxes out.","example":"self SetAirResistance( 60 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"max air resistance speed","description":"speed at which air resistance maxes out (MPH)","mandatory":true}]}]},{"name":"SetAngularVelocity","description":"Sets the angular velocity of a vehicle in degs/s.","example":"self SetAngularVelocity( (0, 90, 0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"angular velocity","description":"The angular velocity to set","mandatory":true}]}]},{"name":"SetBrake","description":"Turns off/on the hand brake of a nitrous physics vehicle.","example":"jeep setbrake(1)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"bool","description":"True or 1 to turn on the brake, false or 0 otherwise","mandatory":true}]}]},{"name":"SetBuoyancyOffset","description":"set buoyancy offset that changes the height an individual vehicle floats in water","example":"crocodile SetBuoyancyOffset( 20 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"offset","description":"A height offset from water surface.","mandatory":true}]}]},{"name":"SetDamageStage","description":"Set the damage stage of the helicopter","example":"self setdamagestage( 3 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"stage","description":"the damage stage to set","mandatory":true}]}]},{"name":"SetDeceleration","description":"Sets the deceleration for this vehicle.","example":"self SetDeceleration( 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"deceleration","description":"The deceleration of the vehicle in miles per hour per second","mandatory":true}]}]},{"name":"SetDefaultPitch","description":"Set the desired default pitch for a vehicle.","example":"level.heli setdefaultpitch(10)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"pitch","description":"Set the default pitch","mandatory":true}]}]},{"name":"SetDrivePathPhysicsScale","description":"This scales all of the necessary parameters that will help a vehicle drive a path better.","example":"boat SetDrivePathPhysicsScale( 3.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"scale","description":"The scale to set","mandatory":false}]}]},{"name":"SetGoalYaw","description":"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":"level.flak1 SetGoalYaw( int_value )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"integer","description":"The yaw direction of the target: 0 to 360 integer value","mandatory":true}]}]},{"name":"SetGunnerTargetEnt","description":"Set the target entity for this vehicle gunner.","example":"eLiberator SetGunnerTargetEnt( eFlaktarget, (0,0,0), 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target entity","description":"The target.","mandatory":true},{"name":"target offset","description":"The target offset.","mandatory":false},{"name":"gunner index","description":"Which gun, 0-3.","mandatory":false}]}]},{"name":"SetGunnerTargetVec","description":"Set the target position for this vehicle turret gunner.","example":"level.flak1 SetGunnerTargetVec( vec1, 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target position","description":"vecter to aim at/ the position of the target","mandatory":true},{"name":"gunner index","description":"which gun 0-3","mandatory":false}]}]},{"name":"SetGunnerTurretOnTargetRange","description":"Set the range at which the gunner_turret_on_target notify will occur.","example":"boat SetGunnerTurretOnTargetRange( 0, 15 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"gunner index","description":"Which gun, 0-3.","mandatory":true},{"name":"range","description":"In degrees","mandatory":false}]}]},{"name":"SetHeliDogfighting","description":"Sets the vehicle (intended for VTOLs only) to be in dogfighting mode (dogfights with the vehicle's focus entity)","example":"vehicle SetHeliDogfighting( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"true to enable dogfighting, false otherwise","mandatory":true}]}]},{"name":"SetHeliHeightCap","description":"Pulls the heli back down below the height mesh","example":"vehicle SetHeliHeightCap( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"true to enable, false otherwise","mandatory":true}]}]},{"name":"SetHeliHeightLock","description":"Locks the heli to the height mesh","example":"vehicle SetHeliHeightLock( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"true to enable lock, false otherwise","mandatory":true}]}]},{"name":"SetHeliHeightPatchEnabled","description":"Enabled or disables the specified heli height lock path","example":"SetHeliHeightPatchEnabled( \"area51\", 0 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"targetname","description":"All heli height lock patches with this target name","mandatory":true},{"name":"enabled","description":"Turn it on or off","mandatory":true},{"name":"player","description":"If defined, only modify the setting for that player","mandatory":false}]}]},{"name":"SetHoverParams","description":"Set the hovering parameters.","example":"self SetHoverParams( 50, 1, 0.5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"radius","description":"The hovering range.","mandatory":true},{"name":"speed","description":"Speed to hover at (MPH)","mandatory":false},{"name":"accel","description":"Acceleration to hover at (MPH/s)","mandatory":false}]}]},{"name":"SetJitterParams","description":"Set the jitter parameters. Set everything to 0 to stop jittering. Vehicle ignores jitter parameters when on ground","example":"self SetJitterParams( (0,0,20), 0.5, 1.5 ); // Jitter up or down randomly within 20 units, switching every 0.5 to 1.5 seconds","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"range vector","description":"The jitter range vector.","mandatory":true},{"name":"min period","description":"Minimum time in seconds to switch jitter direction. Default 0.5 sec","mandatory":false},{"name":"max period","description":"Maximum time in seconds to switch jitter direction. Default 1.0 sec","mandatory":false}]}]},{"name":"SetLookAtEnt","description":"Set the entity this vehicle will orient towards.","example":"eFlak88 setLookAtEnt( eFlaktarget )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"entity","description":"The target.","mandatory":true}]}]},{"name":"SetLookAtOrigin","description":"Set the origin this vehicle will orient towards.","example":"heli setLookAtOrigin( org )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"entity","description":"The target.","mandatory":true}]}]},{"name":"SetMantleEnabled","description":"Sets the mantle enabled flag on the vehicle","example":"vehicle SetMantleEnabled( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"True to set the mantle enabled, false otherwise","mandatory":true}]}]},{"name":"SetMaxAccelerationScale","description":"Sets the max acceleration scale for this physics vehicle.","example":"self SetMaxAccelerationScale( 2.6 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"scale","description":"The acceleration scale of the physics vehicle","mandatory":true}]}]},{"name":"SetMaxPitchRoll","description":"Sets max pitch and roll angle for this vehicle.","example":"self SetMaxPitchRoll( 30, 30 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"pitch","description":"Max pitch angle","mandatory":true},{"name":"roll","description":"Max roll angle","mandatory":true}]}]},{"name":"SetMaxSpeedScale","description":"Sets the max speed scale for this physics vehicle.","example":"self SetMaxSpeedScale( 2.6 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"scale","description":"The max speed scale of the physics vehicle","mandatory":true}]}]},{"name":"SetMinDesiredTurnYaw","description":"The vehicle will not update its desired yaw until the min turn yaw is reached. Set it to 0 to clear it.","example":"quadtank SetMinDesiredTurnYaw( 45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"yaw","description":"The min desired turn yaw to set","mandatory":true}]}]},{"name":"SetNearGoalNotifyDist","description":"Set distance near goal at which near_goal notification should be sent once.","example":"tank setNearGoalNotifyDist( 50 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"dist","description":"Distance to goal position","mandatory":true}]}]},{"name":"SetPathTransitionTime","description":"Set the time it takes for a vehicle to lerp on to a spline.","example":"boat SetPathTransitionTime( 1.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"time","description":"The transition time","mandatory":true}]}]},{"name":"SetPhysAcceleration","description":"Sets the vehicles acceleration vector.","example":"plane SetPhysAcceleration( ( 0, 0, -1600) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"acceleration","description":"The vehicle acceleration","mandatory":true}]}]},{"name":"SetPhysAngles","description":"Sets the angles on the phys structure","example":"self SetPhysAngles( VectorToAngles( desired_forward ) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"angles vector","description":"The desired angles.","mandatory":true}]}]},{"name":"SetPlaneBarrelRoll","description":"Set the goal Roll direction for this plane. PLANE_ON_CURVE has priority over ROLL if this is not set.","example":"level.plane SetPlaneBarrelRoll( 1, 5.0f )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"plane","description":null},"parameters":[{"name":"number","description":"The number of rolls","mandatory":true},{"name":"time","description":"The goal roll time","mandatory":false}]}]},{"name":"SetPlaneGoalPos","description":"Set the target position, speed, angles for this vehicle.","example":"plane Setplanegoalpos( ( 200, 200, 200 ), ( 30, 0, 90 ), 170.0 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"plane","description":null},"parameters":[{"name":"goal position","description":"The goal position","mandatory":true}]}]},{"name":"SetRotorSpeed","description":"Sets the helicopters rotor speed.","example":"heli SetRotorSpeed( 0.2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The rotor speed, 0 is stopped 1 is full speed.","mandatory":true}]}]},{"name":"SetSeatOccupied","description":"Sets this seat to be occupied/disabled (for players.","example":"vehicle SetSeatOccupied( 2, true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true},{"name":"onoff","description":"true to enable, false otherwise","mandatory":false}]}]},{"name":"SetSpeed","description":"Sets the speed and acceleration for this vehicle.","example":"self SetSpeed( 60, 15, 5 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed of the vehicle in miles per hour","mandatory":true},{"name":"acceleration","description":"The acceleration of the vehicle in miles per hour per second","mandatory":false},{"name":"deceleration","description":"Deceleration. If not specified, set to be equal to half of accleration","mandatory":false}]}]},{"name":"SetSpeedImmediate","description":"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":"self setspeedimmediate(60, 15, 5)","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed of the vehicle in miles per hour","mandatory":true},{"name":"acceleration","description":"The acceleration of the vehicle in miles per hour per second","mandatory":false},{"name":"deceleration","description":"Deceleration. If not specified, set to be equal to half of accleration","mandatory":false}]}]},{"name":"SetSwitchNode","description":"Sets a switch node for this vehicle.","example":"tank2 SetSwitchNode( tank2snode1, tank2snode2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"source node","description":"The switch source node","mandatory":true},{"name":"dest node","description":"The switch destination node.","mandatory":true}]}]},{"name":"SetTargetYaw","description":"Set the target yaw direction for this vehicle. Goal yaw has priority over target yaw.","example":"level.flak1 SetTargetYaw( vec1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"yaw","description":"The yaw direction of the target","mandatory":true}]}]},{"name":"SetTurningAbility","description":"If this is higher, helicopters can make sharper turns to match goal positions better.","example":"self SetTurningAbility( 0.9 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"turning ability","description":"Between 0.001 and 1.0. Defaults to 0.5","mandatory":true}]}]},{"name":"SetTurretTargetEnt","description":"Set the target entity for this vehicle turret.","example":"eFlak88 SetTurretTargetEnt( eFlaktarget, eFlaktarget.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target entity","description":"The target.","mandatory":true},{"name":"target offset","description":"The target offset.","mandatory":false}]}]},{"name":"SetTurretTargetRelativeAngles","description":"Set the target entity for this vehicle turret.","example":"eFlak88 SetTurretTargetEnt( eFlaktarget, eFlaktarget.origin )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"relative angles","description":"The target angle","mandatory":true},{"name":"turret index","description":"0 for turret, 1-4 for gunners","mandatory":false}]}]},{"name":"SetTurretTargetVec","description":"Set the target position for this vehicle turret.","example":"level.flak1 SetTurretTargetVec( vec1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"target position","description":"The position of the target","mandatory":true}]}]},{"name":"SetVehGoalPos","description":"Set the target position for this vehicle. Returns true if it can find a path. If it fails to find a path the vehicle will be stopped.","example":"tank SetVehGoalPos( (0, 0, 0), 1 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"goalpos","description":"The goal position","mandatory":true},{"name":"stopAtGoal","description":"Whether the vehicle should slow down to stop at the goal position","mandatory":false},{"name":"usepath","description":"set to 1 to use pathfinding","mandatory":false}]}]},{"name":"SetVehicleAvoidance","description":"Turns on and off vehicle avoidance","example":"vehicle SetVehicleAvoidance( true, 50 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"True to enable avoidance, false otherwise","mandatory":true},{"name":"radius","description":"The avoidance radius","mandatory":false},{"name":"priority","description":"Vehicles will avoid everything that is the same priority or higher. Default priority is 1.","mandatory":false}]}]},{"name":"SetVehicleForDropDeploy","description":"Set vehicle properties so that it can be dropped into a map.","example":"raps SetVehicleForDropDeploy()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"SetVehicleManualControl","description":"Turns on and off vehicle hkai behavior. Not to be confused with UseVehicle()","example":"vehicle SetVehicleManualControl( true )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"enabled","description":"True to enable vehicle hkai behavior, false otherwise","mandatory":true}]}]},{"name":"SetVehicleType","description":"Sets the vehicles type.","example":"plane SetVehicleType(\"f35_vtol\")","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"type","description":"The type name","mandatory":true}]}]},{"name":"SetVehMaxSpeed","description":"overrides the max speed for this vehicle.","example":"self SetVehMaxSpeed( 45 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed to set","mandatory":true}]}]},{"name":"SetVehVelocity","description":"Sets the linear velocity on a vehicle/s.","example":"self SetVehVelocity( (45, 0, 0) )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"velocity","description":"The vehicle velocity","mandatory":true}]}]},{"name":"SetVehWeapon","description":"Set the vehicle's weapon","example":"chopper setVehWeapon( \"AGM_114\" )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"weapon name","description":"The name of the weapon","mandatory":true}]}]},{"name":"SetYawSpeed","description":"Sets the yaw speed for this vehicle.","example":"self SetYawSpeed( 120, 60 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"speed","description":"The speed of the vehicle in angles per second","mandatory":true},{"name":"acceleration","description":"The acceleration of the vehicle in angles per second^2","mandatory":true},{"name":"deceleration","description":"Deceleration. If not specified, set to be equal to acceleration","mandatory":false}]}]},{"name":"StartPath","description":"Starts the vehicle following this path.","example":"bomber StartPath()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"StopFireWeapon","description":"Stop firing the vehicle's main weapon","example":"nFlak StopFireWeapon()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"SwitchStartNode","description":"Swaps the start node for this vehicle.","example":"tank2 SwitchStartNode( tank2snode1, tank2snode2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"source node","description":"The start source node","mandatory":true},{"name":"dest node","description":"The start destination node.","mandatory":true}]}]},{"name":"TakePlayerControl","description":"You call this function to take control away from a player.","example":"cobra TakePlayerControl()","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[]}]},{"name":"UseVehicle","description":"same as useby except you can specify a seat, 0 driver, 1-4 gunners","example":"lvt usevehicle( player, 2 )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"user entity","description":"The player to use the vehicle","mandatory":true},{"name":"seat","description":"0 driver, 1-4 gunners, 5-10 passengers","mandatory":true}]}]},{"name":"VehDriverAimAtCrosshairs","description":"Enables or disables the driver turret aiming at the crosshairs (aiming at the crosshairs overrides all other aim targets and is the default behavior)","example":"vehicle VehDriverAimAtCrosshairs( false )","flags":["autogenerated"],"overloads":[{"calledOn":{"name":"vehicle","description":null},"parameters":[{"name":"AimAtCrosshairs","description":"True to aim the turret at the crosshairs","mandatory":true}]}]},{"name":"EnumerateWeapons","description":"Return an array of weapon names for the weapons of weapon type in fastfile","example":"a_weapons = EnumerateWeapons( \"weapon\" )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"weapon type","description":"The type of weapon to return(weapon or weaponfull)","mandatory":true}]}]},{"name":"Missile_CreateAttractorEnt","description":"Creates a missile attractor at the origin of an entity","example":"attractor = Missile_CreateAttractorEnt( enemy_chopper, 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity that is to be an attractor","mandatory":true},{"name":"strength","description":"The strength of the attractor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectdist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_CreateAttractorOrigin","description":"Creates a missile attractor at the given location","example":"attractor = Missile_CreateAttractorOrigin( (100, 350, 10), 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The center of the attractor","mandatory":true},{"name":"strength","description":"The strength of the attractor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectDist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_CreateRepulsorEnt","description":"Creates a missile repulsor at the origin of an entity","example":"repulsor = Missile_CreateRepulsorEnt( enemy_chopper, 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"entity","description":"The entity that is to be a repulsor","mandatory":true},{"name":"strength","description":"The strength of the repulsor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectDist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_CreateRepulsorOrigin","description":"Creates a missile Repulsor at the given location","example":"repulsor = Missile_CreateRepulsorOrigin( (100, 350, 10), 10000, 6000 )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"origin","description":"The center of the Repulsor","mandatory":true},{"name":"strength","description":"The strength of the Repulsor (maximum acceleration it can apply to a missile)","mandatory":true},{"name":"affectDist","description":"The effective distance at which the missile can be affected. The effect of the attractor falls off from to zero from the center to this distance away from the center.","mandatory":true},{"name":"affectAllProjectiles","description":"If set it will affect all projectiles inculding grenades and guided missiles.","mandatory":false},{"name":"alert range","description":"If set it send notify when missile breaches range(but will not repulse).","mandatory":false}]}]},{"name":"Missile_DeleteAttractor","description":"Deletes a missile attractor or repulsor","example":"Missile_DeleteAttractor( attractor )","flags":["autogenerated"],"overloads":[{"calledOn":null,"parameters":[{"name":"attractor","description":"The attractor or repulsor","mandatory":true}]}]}]},"enums":[{"name":"MeansOfDeath","values":["MOD_UNKNOWN","MOD_CRUSH","MOD_TELEFRAG","MOD_SUICIDE","MOD_DROWN","MOD_HIT_BY_OBJECT","MOD_FALLING","MOD_PROJECTILE","MOD_MELEE","MOD_MELEE_WEAPON_BUTT","MOD_EXPLOSIVE","MOD_PROJECTILE_SPLASH","MOD_GRENADE","MOD_GRENADE_SPLASH","MOD_PISTOL_BULLET","MOD_RIFLE_BULLET","MOD_BURNED","MOD_TRIGGER_HURT"]},{"name":"HitLocation","values":[["none","torso_upper","torso_lower","helmet","head","neck","left_arm_upper","left_arm_lower","left_hand","right_arm_upper","right_arm_lower","right_hand","left_leg_upper","left_leg_lower","left_foot","right_leg_upper","right_leg_lower","right_foot"]]}],"gameId":"t7","languageId":"gsc","revisedOn":"2024-11-22T19:49:00.000Z","revision":6}

ActivateClientExploder

Activates a client-side exploder.

Specification

Parameters

Returns

Usage

Remarks

Community contribution