https://wiki.alliedmods.net/api.php?action=feedcontributions&feedformat=atom&user=Pheadxdll 2026-04-18T10:27:02Z User contributions MediaWiki 1.31.6 https://wiki.alliedmods.net/index.php?title=Category:SourceMod_Development&diff=10032 2015-10-06T21:12:44Z

<p>Pheadxdll: </p> <hr /> <div>This category contains articles about developing for SourceMod extensions. [[:Category:SourceMod_Scripting|Click here for the scripting category]].<br /> <br /> ==Scripting==<br /> *[[:Category:SourceMod_Scripting|Scripting Tutorials]]<br /> *[https://sm.alliedmods.net/new-api/ Scripting Reference]<br /> <br /> ==Introductions==<br /> *[[SourceMod SDK]]<br /> *[[Writing Extensions]]<br /> *[[Writing Extensions from Metamod:Source Plugins]]<br /> *[http://docs.sourcemod.net/dox Doxygen of SourceMod API]<br /> <br /> ==Detailed Tutorials==<br /> *[[Admin API (SourceMod)|Administration API]]<br /> *[[Compiling SourceMod]]<br /> *[[Handle API (SourceMod)|Handle System API]]<br /> *[[Menu API (SourceMod)|Menu System API]]<br /> *[[Natives (SourceMod Development)|Writing Native Functions]]<br /> *[[Finding Virtual Offsets]]<br /> <br /> ==Resources==<br /> <br /> *[[Virtual_Offsets_(Source_Mods)|Virtual Offsets List]]<br /> *[[Entity Properties]]<br /> *[[Game Events (Source)|Game Events]]<br /> *[[Mod TempEnt List (Source)|Temporary Entity Lists]]<br /> *[[Useful Signatures (Source)|Useful Signatures]]<br /> *[[:Category:Metamod:Source Development|Metamod:Source Development]]<br /> *[[:Category:Game_Resources|Mod Specific Resources]]<br /> *[[User_Messages|User Messages]]<br /> <br /> <br /> [[Category:SourceMod]]</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Team_Fortress_2_Item_Definition_Indexes&diff=7848 2010-09-13T04:08:14Z

<p>Pheadxdll: </p> <hr /> <div>This is a list of the item definition indexes in TF2, these are useful for distinguishing an unlockable weapon from its original (for example: The Backburner from an ordinary Flamethrower.)<br /> <br /> This list is divided in to Weapons, Hats and Crafting Items.<br /> <br /> Usage: &lt;pawn&gt;SetEntProp(edict, Prop_Send, &quot;m_iItemDefinitionIndex&quot;, index);&lt;/pawn&gt;<br /> <br /> == Weapons ==<br /> <br /> These are all of the weapons currently in TF2 and their item definition indexes.<br /> <br /> '''0''' - Bat&lt;br&gt;<br /> '''1''' - Bottle&lt;br&gt;<br /> '''2''' - Fire Axe&lt;br&gt;<br /> '''3''' - Kukri&lt;br&gt;<br /> '''4''' - Knife&lt;br&gt;<br /> '''5''' - Fists&lt;br&gt;<br /> '''6''' - Shovel&lt;br&gt;<br /> '''7''' - Wrench&lt;br&gt;<br /> '''8''' - Bonesaw&lt;br&gt;<br /> '''9''' - Engineer's Shotgun&lt;br&gt;<br /> '''10''' - Soldier's Shotgun&lt;br&gt;<br /> '''11''' - Heavy's Shotgun&lt;br&gt;<br /> '''12''' - Pyro's Shotgun&lt;br&gt;<br /> '''13''' - Scattergun&lt;br&gt;<br /> '''14''' - Sniper Rifle&lt;br&gt;<br /> '''15''' - Minigun&lt;br&gt;<br /> '''16''' - SMG&lt;br&gt;<br /> '''17''' - Syringe Gun&lt;br&gt;<br /> '''18''' - Rocket Launcher&lt;br&gt;<br /> '''19''' - Pipe Grenade Launcher&lt;br&gt;<br /> '''20''' - Sticky Bomb Launcher&lt;br&gt;<br /> '''21''' - Flamethrower&lt;br&gt;<br /> '''22''' - Engineer's Pistol&lt;br&gt;<br /> '''23''' - Scout's Pistol&lt;br&gt;<br /> '''24''' - Spy's Revolver&lt;br&gt;<br /> '''25''' - Builder PDA&lt;br&gt;<br /> '''26''' - Demolisher PDA&lt;br&gt;<br /> '''27''' - Disguise Kit PDA&lt;br&gt;<br /> '''29''' - Medigun&lt;br&gt;<br /> '''30''' - Cloak Watch&lt;br&gt;<br /> '''35''' - The Kritzkrieg&lt;br&gt;<br /> '''36''' - The Blutsauger&lt;br&gt;<br /> '''37''' - The Ubersaw&lt;br&gt;<br /> '''38''' - The Axtinguisher&lt;br&gt;<br /> '''39''' - The Flaregun&lt;br&gt;<br /> '''40''' - The Backburner&lt;br&gt;<br /> '''41''' - Natascha&lt;br&gt;<br /> '''42''' - Sandvich&lt;br&gt;<br /> '''43''' - The Killer Gloves Of Boxing&lt;br&gt;<br /> '''44''' - Sandman (Wooden Bat)&lt;br&gt;<br /> '''45''' - Force-A-Nature&lt;br&gt;<br /> '''46''' - Bonk! Atomic Punch&lt;br&gt;<br /> '''56''' - Huntsman&lt;br&gt;<br /> '''57''' - Razorback&lt;br&gt;<br /> '''58''' - Jarate&lt;br&gt;<br /> '''59''' - Dead Ringer&lt;br&gt;<br /> '''60''' - Cloak And Dagger&lt;br&gt;<br /> '''61''' - The Ambassador&lt;br&gt;<br /> '''127''' - The Direct Hit&lt;br&gt;<br /> '''128''' - The Equalizer&lt;br&gt;<br /> '''129''' - The Buff Banner&lt;br&gt;<br /> '''130''' - The Scottish Resistance&lt;br&gt;<br /> '''131''' - Chargin' Targe&lt;br&gt;<br /> '''132''' - The Eyelander&lt;br&gt;<br /> '''133''' - The Gunboats&lt;br&gt;<br /> '''140''' - The Wrangler&lt;br&gt;<br /> '''141''' - The Frontier Justice&lt;br&gt;<br /> '''142''' - The Gunslinger&lt;br&gt;<br /> '''153''' - Homewrecker&lt;br&gt;<br /> '''154''' - Pain Train&lt;br&gt;<br /> '''155''' - The Southern Hospitality&lt;br&gt;<br /> '''159''' - Dalokohs Bar&lt;br&gt;<br /> '''160''' - Lugermorph&lt;br&gt;<br /> '''161''' - Big Kill&lt;br&gt;<br /> '''163''' - Crit-a-Cola&lt;br&gt;<br /> '''169''' - Golden Wrench&lt;br&gt;<br /> '''171''' - Tribalman's Shiv&lt;br&gt;<br /> '''172''' - Scotsman's Skullcutter&lt;br&gt;<br /> <br /> == Hats ==<br /> <br /> These are all of the hats and wearables available in the game.<br /> <br /> '''47''' - Demoman's 'Fro&lt;br&gt;<br /> '''48''' - Mining Light&lt;br&gt;<br /> '''49''' - Football Helmet&lt;br&gt;<br /> '''50''' - Prussian Pickelhaube&lt;br&gt;<br /> '''51''' - Pyro's Beanie&lt;br&gt;<br /> '''52''' - Batter's Helmet&lt;br&gt;<br /> '''53''' - Trophy Hat&lt;br&gt;<br /> '''54''' - Soldier's Stash&lt;br&gt;<br /> '''55''' - Fancy Fedora&lt;br&gt;<br /> '''94''' - Texas Ten Gallon&lt;br&gt;<br /> '''95''' - Engineer's Cap&lt;br&gt;<br /> '''96''' - Officer's Ushanka&lt;br&gt;<br /> '''97''' - Tough Guy's Tuque&lt;br&gt;<br /> '''98''' - Stainless Pot&lt;br&gt;<br /> '''99''' - Tyrant's Helm&lt;br&gt;<br /> '''100''' - Glengarry Bonnet&lt;br&gt;<br /> '''101''' - Vintage Tyrolean&lt;br&gt;<br /> '''102''' - Respectless Rubber Glove&lt;br&gt;<br /> '''103''' - Camera Beard&lt;br&gt;<br /> '''104''' - Otolaryngologist's Mirror&lt;br&gt;<br /> '''105''' - Brigade Helm&lt;br&gt;<br /> '''106''' - Bonk Helm&lt;br&gt;<br /> '''107''' - Ye Olde Baker Boy&lt;br&gt;<br /> '''108''' - Backbiter's Billycock&lt;br&gt;<br /> '''109''' - Professional's Panama&lt;br&gt;<br /> '''110''' - Master's Yellow Belt&lt;br&gt;<br /> '''111''' - Baseball Bill's Sports Shine (Hatless Scout)&lt;br&gt;<br /> '''115''' - Halloween Hat (Only appears on Halloween)&lt;br&gt;<br /> '''116''' - Ghastly Gibus&lt;br&gt;<br /> '''117''' - Ritzy Rick's Hair Fixative (Hatless Sniper)&lt;br&gt;<br /> '''118''' - Texas Slim's Dome Shine (Hatless Engineer)&lt;br&gt;<br /> '''120''' - Scottsman's Stove Pipe&lt;br&gt;<br /> '''121''' - Service Medal&lt;br&gt;<br /> '''125''' - Cheater's Lament&lt;br&gt;<br /> '''126''' - Bill's Hat&lt;br&gt;<br /> '''134''' - J.Axer's Dapper Topper&lt;br&gt;<br /> '''135''' - Towering Pillar of Hats&lt;br&gt;<br /> '''136''' - Amber's Rad As All Hell Hat&lt;br&gt;<br /> '''137''' - Noble Amassment of Hats&lt;br&gt;<br /> '''138''' - Uncle Sam&lt;br&gt;<br /> '''139''' - Modest Pile of Hat&lt;br&gt;<br /> '''143''' - Earbuds&lt;br&gt;<br /> '''144''' - Physician's Procedure Mask&lt;br&gt;<br /> '''145''' - Hound Dog&lt;br&gt;<br /> '''146''' - Hustler's Hallmark&lt;br&gt;<br /> '''147''' - Magistrate's Mullet&lt;br&gt;<br /> '''148''' - Hotrod&lt;br&gt;<br /> '''150''' - Troublemaker's Tossle Cap&lt;br&gt;<br /> '''151''' - Triboniophorus Tyrannus&lt;br&gt;<br /> '''152''' - Killer's Kabuto&lt;br&gt;<br /> '''158''' - Shooter's Sola Topi&lt;br&gt;<br /> '''162''' - Max's Severed Head&lt;br&gt;<br /> '''164''' - Grizzled Veteran&lt;br&gt;<br /> '''165''' - Soldier of Fortune&lt;br&gt;<br /> '''166''' - Mercenary&lt;br&gt;<br /> '''170''' - Primeval Warrior&lt;br&gt;<br /> '''174''' - Whoopee Cap&lt;br&gt;<br /> '''175''' - Whiskered Gentleman&lt;br&gt;<br /> '''177''' - Ze Goggles&lt;br&gt;<br /> '''178''' - Safe'n'Sound&lt;br&gt;<br /> '''179''' - Tippler's Tricorne&lt;br&gt;<br /> '''180''' - Frenchman's Beret&lt;br&gt;<br /> '''181''' - Bloke's Bucket Hat&lt;br&gt;<br /> '''182''' - Vintage Merryweather&lt;br&gt;<br /> '''183''' - Sergeant's Drill Hat&lt;br&gt;<br /> '''184''' - Gentleman's Gatsby&lt;br&gt;<br /> '''185''' - Heavy Duty Rag&lt;br&gt;<br /> '''189''' - Alien Swarm Parasite&lt;br&gt;<br /> '''240''' - Lumbricus Lid&lt;br&gt;<br /> <br /> == Craft Items ==<br /> <br /> These are the items obtained and used primarily through crafting.<br /> <br /> '''5000''' - Scrap Metal&lt;br&gt;<br /> '''5001''' - Reclaimed Metal&lt;br&gt;<br /> '''5002''' - Refined Metal&lt;br&gt;<br /> '''5003''' - Scout Class Token&lt;br&gt;<br /> '''5004''' - Sniper Class Token&lt;br&gt;<br /> '''5005''' - Soldier Class Token&lt;br&gt;<br /> '''5006''' - Demoman Class Token&lt;br&gt;<br /> '''5007''' - Heavy Class Token&lt;br&gt;<br /> '''5008''' - Medic Class Token&lt;br&gt;<br /> '''5009''' - Pyro Class Token&lt;br&gt;<br /> '''5010''' - Spy Class Token&lt;br&gt;<br /> '''5011''' - Engineer Class Token&lt;br&gt;<br /> '''5012''' - Primary Slot Token&lt;br&gt;<br /> '''5013''' - Secondary Slot Token&lt;br&gt;<br /> '''5014''' - Melee Slot Token&lt;br&gt;<br /> '''5015''' - Grenade Slot Token&lt;br&gt;<br /> '''5016''' - Building Slot Token&lt;br&gt;<br /> '''5017''' - PDA Slot Token&lt;br&gt;<br /> '''5018''' - PDA2 Slot Token&lt;br&gt;<br /> '''5019''' - Head Slot Token&lt;br&gt;</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Team_Fortress_2_Events&diff=7793 2010-08-03T14:50:00Z

<p>Pheadxdll: </p> <hr /> <div>:''Refer back to [[Game Events (Source)]] for more events.''<br /> === intro_finish ===<br /> {{begin-hl2msg|intro_finish|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{end-hl2msg}}<br /> <br /> === intro_nextcamera ===<br /> {{begin-hl2msg|intro_nextcamera|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{end-hl2msg}}<br /> <br /> === player_changeclass ===<br /> {{qnotice|When a player changes their class}}&lt;br&gt;<br /> {{begin-hl2msg|player_changeclass|string}}<br /> {{hl2msg|short|userid|user ID who changed class}}<br /> {{hl2msg|short|class|class that they changed to}}<br /> {{end-hl2msg}}<br /> <br /> === player_death ===<br /> {{qnotice|When a player dies}}&lt;br&gt;<br /> {{begin-hl2msg|player_death|string}}<br /> {{hl2msg|short|userid|user ID who died}}<br /> {{hl2msg|long|victim_entindex|}}<br /> {{hl2msg|long|inflictor_entindex|ent index of inflictor (a sentry, for example)}}<br /> {{hl2msg|short|attacker|user ID who killed}}<br /> {{hl2msg|string|weapon|weapon name killer used}}<br /> {{hl2msg|short|weaponid|ID of weapon killed used}}<br /> {{hl2msg|long|damagebits|bits of type of damage}}<br /> {{hl2msg|short|customkill|type of custom kill}}<br /> {{hl2msg|short|assister|user ID of assister}}<br /> {{hl2msg|string|weapon_logclassname|weapon name that should be printed on the log}}<br /> {{hl2msg|short|stun_flags|victim's stun flags at the moment of death}}<br /> {{hl2msg|short|death_flags|death flags.}}<br /> {{hl2msg|short|dominated|did killer dominate victim with this kill}}<br /> {{hl2msg|short|assister_dominated|did assister dominate victim with this kill}}<br /> {{hl2msg|short|revenge|did killer get revenge on victim with this kill}}<br /> {{hl2msg|short|assister_revenge|did assister get revenge on victim with this kill}}<br /> {{hl2msg|bool|first_blood|was this a first blood kill}}<br /> {{hl2msg|bool|feign_death|the victim is feign death}}<br /> {{end-hl2msg}}<br /> <br /> === object_removed ===<br /> {{begin-hl2msg|object_removed|string}}<br /> {{hl2msg|short|userid|user ID of the object owner}}<br /> {{hl2msg|short|objecttype|type of object removed}}<br /> {{hl2msg|short|index|index of the object removed}}<br /> {{end-hl2msg}}<br /> <br /> === object_destroyed ===<br /> {{qnotice|When a player destroys an object}}&lt;br&gt;<br /> {{begin-hl2msg|object_destroyed|string}}<br /> {{hl2msg|short|userid|user ID who died}}<br /> {{hl2msg|short|attacker|user ID who killed}}<br /> <br /> {{hl2msg|short|assister|user ID of assister}}<br /> {{hl2msg|string|weapon|weapon name killer used}}<br /> {{hl2msg|short|weaponid|id of the weapon used}}<br /> <br /> {{hl2msg|short|objecttype|type of object destroyed}}<br /> {{hl2msg|short|index|index of the object destroyed}}<br /> {{hl2msg|bool|was_building|object was being built when it died}}<br /> {{end-hl2msg}}<br /> <br /> === tf_map_time_remaining ===<br /> {{begin-hl2msg|tf_map_time_remaining|string}}<br /> {{hl2msg|long|seconds|}}<br /> {{end-hl2msg}}<br /> <br /> === tf_game_over ===<br /> {{qnotice|When a tf game ends}}&lt;br&gt;<br /> {{begin-hl2msg|tf_game_over|string}}<br /> {{hl2msg|string|reason|why the game is over ( timelimit, winlimit )}}<br /> <br /> {{end-hl2msg}}<br /> <br /> === ctf_flag_captured ===<br /> {{qnotice|When a flag is captured by a player}}&lt;br&gt;<br /> {{begin-hl2msg|ctf_flag_captured|string}}<br /> {{hl2msg|short|capping_team|}}<br /> {{hl2msg|short|capping_team_score|}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_initialized ===<br /> {{qnotice|When a player begins to capture a control point}}&lt;br&gt;<br /> {{begin-hl2msg|controlpoint_initialized|string}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_updateimages ===<br /> {{begin-hl2msg|controlpoint_updateimages|string}}<br /> {{hl2msg|short|index|index of the cap being updated}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_updatelayout ===<br /> {{begin-hl2msg|controlpoint_updatelayout|string}}<br /> {{hl2msg|short|index|index of the cap being updated}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_updatecapping ===<br /> {{begin-hl2msg|controlpoint_updatecapping|string}}<br /> {{hl2msg|short|index|index of the cap being updated}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_updateowner ===<br /> {{begin-hl2msg|controlpoint_updateowner|string}}<br /> {{hl2msg|short|index|index of the cap being updated}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_starttouch ===<br /> {{qnotice|When a player enters a capture point zone}}&lt;br&gt;<br /> {{begin-hl2msg|controlpoint_starttouch|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{hl2msg|short|area|index of the control point area}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_endtouch ===<br /> {{qnotice|When a player leaves a capture point zone}}&lt;br&gt;<br /> {{begin-hl2msg|controlpoint_endtouch|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{hl2msg|short|area|index of the control point area}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_pulse_element ===<br /> {{begin-hl2msg|controlpoint_pulse_element|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_fake_capture ===<br /> {{begin-hl2msg|controlpoint_fake_capture|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{hl2msg|short|int_data|}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_fake_capture_mult ===<br /> {{begin-hl2msg|controlpoint_fake_capture_mult|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{hl2msg|short|int_data|}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_round_selected ===<br /> {{qnotice|When a round is selected.}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_round_selected|string}}<br /> {{hl2msg|string|round|name of the round selected}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_round_start ===<br /> {{qnotice|round restart}}&lt;br&gt; <br /> {{begin-hl2msg|teamplay_round_start|string}}<br /> {{hl2msg|bool|full_reset|is this a full reset of the map}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_round_active ===<br /> {{qnotice|called when round is active, players can move}}&lt;br&gt; <br /> {{begin-hl2msg|teamplay_round_active|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_waiting_begins ===<br /> {{qnotice|When the &quot;waiting for players&quot; pre-round begins}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_waiting_begins|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_waiting_ends ===<br /> {{qnotice|When the &quot;waiting for players&quot; pre-round ends}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_waiting_ends|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_waiting_abouttoend ===<br /> {{qnotice|When the &quot;waiting for players&quot; pre-round is about to end}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_waiting_abouttoend|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_restart_round ===<br /> {{qnotice|When a round is restarted}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_restart_round|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_ready_restart ===<br /> {{begin-hl2msg|teamplay_ready_restart|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_round_restart_seconds ===<br /> {{begin-hl2msg|teamplay_round_restart_seconds|string}}<br /> {{hl2msg|short|seconds|}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_team_ready ===<br /> {{begin-hl2msg|teamplay_team_ready|string}}<br /> {{hl2msg|byte|team|which team is ready}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_round_win ===<br /> {{qnotice|When a team wins a round}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_round_win|string}}<br /> {{hl2msg|byte|team|which team won the round}}<br /> {{hl2msg|byte|winreason|the reason the team won}}<br /> {{hl2msg|short|flagcaplimit|if win reason was flag cap limit, the value of the flag cap limit}}<br /> <br /> {{hl2msg|short|full_round|was this a full round or a mini-round}}<br /> {{hl2msg|float|round_time|elapsed time of this round}}<br /> {{hl2msg|short|losing_team_num_caps|# of caps this round by losing team}}<br /> {{hl2msg|byte|was_sudden_death|did a team win this after entering sudden death}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_update_timer ===<br /> {{begin-hl2msg|teamplay_update_timer|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_round_stalemate ===<br /> {{qnotice|When a game ends in a stalemate}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_round_stalemate|string}}<br /> {{hl2msg|byte|reason|why the stalemate is occuring}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_overtime_begin ===<br /> {{qnotice|When an overtime round begins}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_overtime_begin|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_overtime_end ===<br /> {{qnotice|When an overtime round ends}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_overtime_end|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_suddendeath_begin ===<br /> {{qnotice|When a sudden death round begins}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_suddendeath_begin|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_suddendeath_end ===<br /> {{qnotice|When a sudden death round ends}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_suddendeath_end|string}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_game_over ===<br /> {{qnotice|When a teamplay game ends}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_game_over|string}}<br /> {{hl2msg|string|reason|why the game is over ( timelimit, winlimit )}}<br /> <br /> {{end-hl2msg}}<br /> <br /> === teamplay_map_time_remaining ===<br /> {{begin-hl2msg|teamplay_map_time_remaining|string}}<br /> {{hl2msg|short|seconds|}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_broadcast_audio ===<br /> {{qnotice|Broadcast an audio file.}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_broadcast_audio|string}}<br /> {{hl2msg|byte|team|which team should hear the broadcast. 0 will make everyone hear it.}}<br /> <br /> {{hl2msg|string|sound|sound to play}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_timer_flash ===<br /> <br /> {{begin-hl2msg|teamplay_timer_flash|string}}<br /> {{hl2msg|short|time_remaining|how many seconds until the round ends}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_timer_time_added ===<br /> {{begin-hl2msg|teamplay_timer_time_added|string}}<br /> {{hl2msg|short|timer|entindex of the timer}}<br /> {{hl2msg|short|seconds_added|how many seconds were added to the round timer}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_point_startcapture ===<br /> {{qnotice|When a point is beginning to be captured}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_point_startcapture|string}}<br /> {{hl2msg|byte|cp|index of the point being captured}}<br /> {{hl2msg|string|cpname|name of the point}}<br /> {{hl2msg|byte|team|which team currently owns the point}}<br /> {{hl2msg|byte|capteam|which team is capping}}<br /> {{hl2msg|string|cappers|string where each character is a player index of someone capping}}<br /> {{hl2msg|float|captime|time between when this cap started and when the point last changed hands}}<br /> <br /> <br /> {{end-hl2msg}}<br /> <br /> === teamplay_point_captured ===<br /> {{qnotice|When a control point is captured by a team}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_point_captured|string}}<br /> {{hl2msg|byte|cp|index of the point that was captured}}<br /> <br /> {{hl2msg|string|cpname|name of the point}}<br /> {{hl2msg|byte|team|which team capped}}<br /> {{hl2msg|string|cappers|string where each character is a player index of someone that capped}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_point_locked ===<br /> {{begin-hl2msg|teamplay_point_locked|string}}<br /> {{hl2msg|byte|cp|index of the point being captured}}<br /> {{hl2msg|string|cpname|name of the point}}<br /> {{hl2msg|byte|team|which team currently owns the point}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_point_unlocked ===<br /> {{begin-hl2msg|teamplay_point_unlocked|string}}<br /> {{hl2msg|byte|cp|index of the point being captured}}<br /> {{hl2msg|string|cpname|name of the point}}<br /> {{hl2msg|byte|team|which team currently owns the point}}<br /> <br /> {{end-hl2msg}}<br /> <br /> === teamplay_capture_broken ===<br /> <br /> {{begin-hl2msg|teamplay_capture_broken|string}}<br /> {{hl2msg|byte|cp|}}<br /> {{hl2msg|string|cpname|}}<br /> {{hl2msg|float|time_remaining|}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_capture_blocked ===<br /> {{qnotice|When a player blocks the capture of a control point}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_capture_blocked|string}}<br /> {{hl2msg|byte|cp|index of the point that was blocked}}<br /> <br /> {{hl2msg|string|cpname|name of the point}}<br /> {{hl2msg|byte|blocker|index of the player that blocked the cap}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_flag_event ===<br /> {{begin-hl2msg|teamplay_flag_event|string}}<br /> {{hl2msg|short|player|player this event involves}}<br /> {{hl2msg|short|carrier|the carrier if needed}}<br /> {{hl2msg|short|eventtype|pick up, capture, defend, dropped}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_win_panel ===<br /> {{qnotice|When the win-game panel is displayed}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_win_panel|string}}<br /> {{hl2msg|byte|panel_style|for client to determine layout}}<br /> {{hl2msg|byte|winning_team|}}<br /> {{hl2msg|byte|winreason|the reason the team won}}<br /> {{hl2msg|string|cappers|string where each character is a player index of someone that capped}}<br /> {{hl2msg|short|flagcaplimit|if win reason was flag cap limit, the value of the flag cap limit}}<br /> <br /> <br /> {{hl2msg|short|blue_score|red team score}}<br /> {{hl2msg|short|red_score|blue team score}}<br /> {{hl2msg|short|blue_score_prev|previous red team score}}<br /> {{hl2msg|short|red_score_prev|previous blue team score}}<br /> {{hl2msg|short|round_complete|is this a complete round, or the end of a mini-round}}<br /> {{hl2msg|short|rounds_remaining|# of rounds remaining for wining team, if mini-round}}<br /> <br /> {{hl2msg|short|player_1|}}<br /> {{hl2msg|short|player_1_points|}}<br /> {{hl2msg|short|player_2|}}<br /> {{hl2msg|short|player_2_points|}}<br /> {{hl2msg|short|player_3|}}<br /> {{hl2msg|short|player_3_points|}}<br /> {{end-hl2msg}}<br /> <br /> === teamplay_teambalanced_player ===<br /> {{qnotice|When a player is balanced to another team}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_teambalanced_player|string}}<br /> {{hl2msg|short|player|entindex of the player}}<br /> {{hl2msg|byte|team|which team the player is being moved to}}<br /> <br /> {{end-hl2msg}}<br /> <br /> === teamplay_setup_finished ===<br /> {{qnotice|When the setup round ends}}&lt;br&gt;<br /> {{begin-hl2msg|teamplay_setup_finished|string}}<br /> {{end-hl2msg}}<br /> <br /> === show_freezepanel ===<br /> {{qnotice|When the death-snapshot panel is shown}}&lt;br&gt;<br /> {{begin-hl2msg|show_freezepanel|string}}<br /> {{hl2msg|short|killer|entindex of the killer entity}}<br /> {{end-hl2msg}}<br /> <br /> === hide_freezepanel ===<br /> {{qnotice|When the death-snapshot panel is hidden}}&lt;br&gt;<br /> {{begin-hl2msg|hide_freezepanel|string}}<br /> {{end-hl2msg}}<br /> <br /> === freezecam_started ===<br /> {{qnotice|When a player enters the death-snapshot view}}&lt;br&gt;<br /> {{begin-hl2msg|freezecam_started|string}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_changeteam ===<br /> {{qnotice|When a LAN player changes team}}&lt;br&gt;<br /> {{begin-hl2msg|localplayer_changeteam|string}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_score_changed ===<br /> {{begin-hl2msg|localplayer_score_changed|string}}<br /> {{hl2msg|short|score|}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_changeclass ===<br /> {{qnotice|When a LAN player changes class}}&lt;br&gt;<br /> {{begin-hl2msg|localplayer_changeclass|string}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_respawn ===<br /> {{qnotice|When a LAN player respawns}}&lt;br&gt;<br /> {{begin-hl2msg|localplayer_respawn|string}}<br /> {{end-hl2msg}}<br /> <br /> === building_info_changed ===<br /> {{begin-hl2msg|building_info_changed|string}}<br /> {{hl2msg|byte|building_type|}}<br /> {{hl2msg|byte|object_mode|}}<br /> {{hl2msg|byte|remove|}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_changedisguise ===<br /> {{qnotice|Whena LAN player changes their disguise as a spy}}&lt;br&gt;<br /> {{begin-hl2msg|localplayer_changedisguise|string}}<br /> {{hl2msg|bool|disguised|}}<br /> {{end-hl2msg}}<br /> <br /> === player_account_changed ===<br /> {{begin-hl2msg|player_account_changed|string}}<br /> {{hl2msg|short|old_value|}}<br /> {{hl2msg|short|new_value|}}<br /> {{end-hl2msg}}<br /> <br /> === spy_pda_reset ===<br /> {{begin-hl2msg|spy_pda_reset|string}}<br /> {{end-hl2msg}}<br /> <br /> === flagstatus_update ===<br /> {{begin-hl2msg|flagstatus_update|string}}<br /> {{end-hl2msg}}<br /> <br /> === player_stats_updated ===<br /> {{qnotice|When a players stats are updated}}&lt;br&gt;<br /> {{begin-hl2msg|player_stats_updated|string}}<br /> {{hl2msg|bool|forceupload|}}<br /> {{end-hl2msg}}<br /> <br /> === playing_commentary ===<br /> {{qnotice|When a commentary is being played}}&lt;br&gt;<br /> {{begin-hl2msg|playing_commentary|string}}<br /> {{end-hl2msg}}<br /> <br /> === player_chargedeployed ===<br /> {{qnotice|When an uber is deployed}}&lt;br&gt;<br /> {{begin-hl2msg|player_chargedeployed|string}}<br /> {{hl2msg|short|userid|user ID of medic who deployed charge}}<br /> {{hl2msg|short|targetid|user ID of who the medic charged}}<br /> {{end-hl2msg}}<br /> <br /> === player_builtobject ===<br /> {{qnotice|When a player builds an object}}&lt;br&gt;<br /> {{begin-hl2msg|player_builtobject|string}}<br /> {{hl2msg|short|userid|user ID of the builder}}<br /> {{hl2msg|byte|object|}}<br /> {{hl2msg|short|index|index of the object}}<br /> {{end-hl2msg}}<br /> <br /> === player_upgradedobject ===<br /> {{begin-hl2msg|player_upgradedobject|string}}<br /> {{hl2msg|short|userid|}}<br /> {{hl2msg|byte|object|}}<br /> {{hl2msg|short|index|}}<br /> {{hl2msg|bool|isbuilder|}}<br /> {{end-hl2msg}}<br /> <br /> === achievement_earned ===<br /> {{qnotice|When a player earns an achievement}}&lt;br&gt;<br /> {{begin-hl2msg|achievement_earned|string}}<br /> {{hl2msg|byte|player|entindex of the player}}<br /> {{hl2msg|short|achievement|achievement ID}}<br /> {{end-hl2msg}}<br /> <br /> === spec_target_updated ===<br /> {{begin-hl2msg|spec_target_updated|string}}<br /> {{end-hl2msg}}<br /> <br /> === tournament_stateupdate ===<br /> {{begin-hl2msg|tournament_stateupdate|string}}<br /> {{hl2msg|short|userid|user ID on server}}<br /> {{hl2msg|bool|namechange|}}<br /> {{hl2msg|short|readystate|}}<br /> {{hl2msg|string|newname|players new name}}<br /> {{end-hl2msg}}<br /> <br /> === player_calledformedic ===<br /> {{qnotice|When a player calls for a medic}}&lt;br&gt;<br /> {{begin-hl2msg|player_calledformedic|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_becameobserver ===<br /> <br /> {{begin-hl2msg|localplayer_becameobserver|string}}<br /> {{end-hl2msg}}<br /> <br /> === player_ignited_inv ===<br /> {{qnotice|sent when a player is ignited by a pyro who is being invulned, only to the medic who's doing the invulning}}&lt;br&gt; <br /> {{begin-hl2msg|player_ignited_inv|string}}<br /> {{hl2msg|byte|pyro_entindex|entindex of the pyro who ignited the victim}}<br /> {{hl2msg|byte|victim_entindex|entindex of the player ignited by the pyro}}<br /> {{hl2msg|byte|medic_entindex|entindex of the medic releasing the invuln}}<br /> {{end-hl2msg}}<br /> <br /> === player_ignited ===<br /> {{qnotice|sent when a player is ignited, only to the two players involved}}&lt;br&gt; <br /> {{begin-hl2msg|player_ignited|string}}<br /> {{hl2msg|byte|pyro_entindex|entindex of the pyro who ignited the victim}}<br /> {{hl2msg|byte|victim_entindex|entindex of the player ignited by the pyro}}<br /> {{hl2msg|byte|weaponid|weaponid of the weapon used}}<br /> {{end-hl2msg}}<br /> <br /> === player_extinguished ===<br /> {{qnotice|sent when a burning player is extinguished by a medic}}&lt;br&gt; <br /> {{begin-hl2msg|player_extinguished|string}}<br /> {{hl2msg|byte|victim|entindex of the player that was extinguished}}<br /> {{hl2msg|byte|healer|entindex of the player who did the extinguishing}}<br /> <br /> <br /> {{end-hl2msg}}<br /> <br /> === player_teleported ===<br /> {{qnotice|Sent when a player is teleported}}&lt;br&gt;<br /> {{begin-hl2msg|player_teleported|string}}<br /> {{hl2msg|short|userid|userid of the player}}<br /> {{hl2msg|short|builderid|userid of the player who built the teleporter}}<br /> {{hl2msg|float|dist|distance the player was teleported}}<br /> {{end-hl2msg}}<br /> <br /> === player_healedmediccall ===<br /> {{qnotice|local player heals someone who called for medic.}}&lt;br&gt; <br /> {{begin-hl2msg|player_healedmediccall|string}}<br /> {{hl2msg|short|userid|userid of person who got healed}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_chargeready ===<br /> {{qnotice|local player has full medic charge}}&lt;br&gt; <br /> {{begin-hl2msg|localplayer_chargeready|string}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_winddown ===<br /> {{qnotice|local player minigun winddown}}&lt;br&gt; <br /> {{begin-hl2msg|localplayer_winddown|string}}<br /> {{end-hl2msg}}<br /> <br /> === player_invulned ===<br /> {{qnotice|Send when a player is made invulnerable}}&lt;br&gt;<br /> {{begin-hl2msg|player_invulned|string}}<br /> {{hl2msg|short|userid|}}<br /> {{hl2msg|short|medic_userid|}}<br /> {{end-hl2msg}}<br /> <br /> === escort_speed ===<br /> <br /> {{begin-hl2msg|escort_speed|string}}<br /> {{hl2msg|byte|team|which team}}<br /> {{hl2msg|byte|speed|}}<br /> {{hl2msg|byte|players|}}<br /> {{end-hl2msg}}<br /> <br /> === escort_progress ===<br /> <br /> {{begin-hl2msg|escort_progress|string}}<br /> {{hl2msg|byte|team|which team}}<br /> {{hl2msg|float|progress|}}<br /> {{hl2msg|bool|reset|}}<br /> {{end-hl2msg}}<br /> <br /> === escort_recede ===<br /> <br /> {{begin-hl2msg|escort_recede|string}}<br /> {{hl2msg|byte|team|which team}}<br /> {{hl2msg|float|recedetime|}}<br /> {{end-hl2msg}}<br /> <br /> === client_loadout_changed ===<br /> <br /> {{begin-hl2msg|client_loadout_changed|string}}<br /> {{end-hl2msg}}<br /> <br /> === gameui_activated ===<br /> <br /> {{begin-hl2msg|gameui_activated|string}}<br /> {{end-hl2msg}}<br /> <br /> === gameui_hidden ===<br /> <br /> {{begin-hl2msg|gameui_hidden|string}}<br /> {{end-hl2msg}}<br /> <br /> === player_escort_score ===<br /> <br /> {{begin-hl2msg|player_escort_score|string}}<br /> {{hl2msg|byte|player|}}<br /> {{hl2msg|byte|points|}}<br /> {{end-hl2msg}}<br /> <br /> === player_healonhit ===<br /> <br /> {{begin-hl2msg|player_healonhit|string}}<br /> {{hl2msg|short|amount|}}<br /> {{hl2msg|byte|entindex|}}<br /> {{end-hl2msg}}<br /> <br /> === player_stealsandvich ===<br /> {{begin-hl2msg|player_stealsandvich|string}}<br /> {{hl2msg|short|owner|}}<br /> {{hl2msg|short|target|}}<br /> {{end-hl2msg}}<br /> <br /> === show_class_layout ===<br /> <br /> {{begin-hl2msg|show_class_layout|string}}<br /> {{hl2msg|bool|show|}}<br /> {{end-hl2msg}}<br /> <br /> === show_vs_panel ===<br /> <br /> {{begin-hl2msg|show_vs_panel|string}}<br /> {{hl2msg|bool|show|}}<br /> {{end-hl2msg}}<br /> <br /> === player_damaged ===<br /> <br /> <br /> {{begin-hl2msg|player_damaged|string}}<br /> {{hl2msg|short|amount|}}<br /> {{hl2msg|long|type|}}<br /> {{end-hl2msg}}<br /> <br /> === player_hurt ===<br /> <br /> {{begin-hl2msg|player_hurt|string}}<br /> {{hl2msg|short|userid|}}<br /> {{hl2msg|short|health|}}<br /> {{hl2msg|short|attacker|}}<br /> <br /> {{hl2msg|short|damageamount|}}<br /> {{hl2msg|bool|crit|}}<br /> {{hl2msg|bool|minicrit|}}<br /> {{hl2msg|bool|allseecrit|}}<br /> {{hl2msg|short|weaponid|}}<br /> {{end-hl2msg}}<br /> <br /> === arena_player_notification ===<br /> <br /> {{begin-hl2msg|arena_player_notification|string}}<br /> {{hl2msg|byte|player|}}<br /> {{hl2msg|byte|message|}}<br /> {{end-hl2msg}}<br /> <br /> === arena_match_maxstreak ===<br /> <br /> {{begin-hl2msg|arena_match_maxstreak|string}}<br /> {{hl2msg|byte|team|}}<br /> {{hl2msg|byte|streak|}}<br /> {{end-hl2msg}}<br /> <br /> === arena_round_start ===<br /> {{qnotice|called when round is active, players can move}}&lt;br&gt; <br /> {{begin-hl2msg|arena_round_start|string}}<br /> {{end-hl2msg}}<br /> <br /> === arena_win_panel ===<br /> <br /> {{begin-hl2msg|arena_win_panel|string}}<br /> {{hl2msg|byte|panel_style|for client to determine layout}}<br /> {{hl2msg|byte|winning_team|}}<br /> {{hl2msg|byte|winreason|the reason the team won - 1 (someone capped) 2 (entire team was killed)}}<br /> {{hl2msg|string|cappers|string where each character is a player index of someone that capped}}<br /> {{hl2msg|short|flagcaplimit|if win reason was flag cap limit, the value of the flag cap limit}}<br /> <br /> <br /> {{hl2msg|short|blue_score|red team score}}<br /> {{hl2msg|short|red_score|blue team score}}<br /> {{hl2msg|short|blue_score_prev|previous red team score}}<br /> {{hl2msg|short|red_score_prev|previous blue team score}}<br /> {{hl2msg|short|round_complete|is this a complete round, or the end of a mini-round}}<br /> {{hl2msg|short|player_1|}}<br /> {{hl2msg|short|player_1_damage|}}<br /> {{hl2msg|short|player_1_healing|}}<br /> {{hl2msg|short|player_1_lifetime|}}<br /> {{hl2msg|short|player_1_kills|}}<br /> {{hl2msg|short|player_2|}}<br /> {{hl2msg|short|player_2_damage|}}<br /> {{hl2msg|short|player_2_healing|}}<br /> {{hl2msg|short|player_2_lifetime|}}<br /> {{hl2msg|short|player_2_kills|}}<br /> {{hl2msg|short|player_3|}}<br /> {{hl2msg|short|player_3_damage|}}<br /> {{hl2msg|short|player_3_healing|}}<br /> {{hl2msg|short|player_3_lifetime|}}<br /> {{hl2msg|short|player_3_kills|}}<br /> {{hl2msg|short|player_4|}}<br /> {{hl2msg|short|player_4_damage|}}<br /> {{hl2msg|short|player_4_healing|}}<br /> {{hl2msg|short|player_4_lifetime|}}<br /> {{hl2msg|short|player_4_kills|}}<br /> {{hl2msg|short|player_5|}}<br /> {{hl2msg|short|player_5_damage|}}<br /> {{hl2msg|short|player_5_healing|}}<br /> {{hl2msg|short|player_5_lifetime|}}<br /> {{hl2msg|short|player_5_kills|}}<br /> {{hl2msg|short|player_6|}}<br /> {{hl2msg|short|player_6_damage|}}<br /> {{hl2msg|short|player_6_healing|}}<br /> {{hl2msg|short|player_6_lifetime|}}<br /> {{hl2msg|short|player_6_kills|}}<br /> {{end-hl2msg}}<br /> <br /> === inventory_updated ===<br /> <br /> {{begin-hl2msg|inventory_updated|string}}<br /> {{end-hl2msg}}<br /> <br /> === air_dash ===<br /> {{qnotice|Called when a scout Performs Double Jump}}&lt;br&gt;<br /> {{begin-hl2msg|air_dash|string}}<br /> {{hl2msg|byte|player|}}<br /> {{end-hl2msg}}<br /> <br /> === landed ===<br /> <br /> {{begin-hl2msg|landed|string}}<br /> {{hl2msg|byte|player|}}<br /> {{end-hl2msg}}<br /> <br /> === player_damage_dodged ===<br /> {{qnotice|When a Player Evades Damage}}&lt;br&gt;<br /> {{begin-hl2msg|player_damage_dodged|string}}<br /> {{hl2msg|short|damage|}}<br /> {{end-hl2msg}}<br /> <br /> === player_stunned ===<br /> {{qnotice|When a Player is Stunned}}&lt;br&gt;<br /> {{begin-hl2msg|player_stunned|string}}<br /> {{hl2msg|short|stunner|}}<br /> {{hl2msg|short|victim|}}<br /> {{hl2msg|bool|victim_capping|}}<br /> {{hl2msg|bool|big_stun|}}<br /> {{end-hl2msg}}<br /> <br /> === scout_grand_slam ===<br /> {{qnotice|When a Player is Killed by the Scout Taunt}}&lt;br&gt;<br /> {{begin-hl2msg|scout_grand_slam|string}}<br /> {{hl2msg|short|scout_id|}}<br /> {{hl2msg|short|target_id|}}<br /> {{end-hl2msg}}<br /> <br /> === scout_slamdoll_landed ===<br /> {{begin-hl2msg|scout_slamdoll_landed|string}}<br /> {{hl2msg|short|target_index|}}<br /> {{hl2msg|float|x|}}<br /> {{hl2msg|float|y|}}<br /> {{hl2msg|float|z|}}<br /> {{end-hl2msg}}<br /> <br /> === scout_slamdoll_landed ===<br /> <br /> {{begin-hl2msg|scout_slamdoll_landed|string}}<br /> {{hl2msg|short|target_index|}}<br /> {{hl2msg|float|x|}}<br /> {{hl2msg|float|y|}}<br /> {{hl2msg|float|z|}}<br /> {{end-hl2msg}}<br /> <br /> === arrow_impact ===<br /> {{qnotice|When a player is hit by a Sniper's Huntsman arrow}}&lt;br&gt;<br /> {{begin-hl2msg|arrow_impact|string}}<br /> {{hl2msg|short|attachedEntity|}}<br /> {{hl2msg|short|shooter|}}<br /> {{hl2msg|short|boneIndexAttached|}}<br /> {{hl2msg|float|bonePositionX|}}<br /> {{hl2msg|float|bonePositionY|}}<br /> {{hl2msg|float|bonePositionZ|}}<br /> {{hl2msg|float|boneAnglesX|}}<br /> {{hl2msg|float|boneAnglesY|}}<br /> {{hl2msg|float|boneAnglesZ|}}<br /> {{end-hl2msg}}<br /> <br /> === player_jarated ===<br /> {{qnotice|sent when a player is jarated, only to the two players involved}}&lt;br&gt; <br /> {{begin-hl2msg|player_jarated|string}}<br /> {{hl2msg|byte|thrower_entindex|entindex of the player who threw the jarate}}<br /> {{hl2msg|byte|victim_entindex|entindex of the player receiving it}}<br /> {{end-hl2msg}}<br /> <br /> === player_jarated_fade ===<br /> {{qnotice|sent when a player is jarated, only to the two players involved}}&lt;br&gt; <br /> <br /> {{begin-hl2msg|player_jarated_fade|string}}<br /> {{hl2msg|byte|thrower_entindex|entindex of the player who threw the jarate}}<br /> {{hl2msg|byte|victim_entindex|entindex of the player receiving it}}<br /> {{end-hl2msg}}<br /> <br /> === player_shield_blocked ===<br /> {{qnotice|sent when a player is jarated, only to the two players involved}}&lt;br&gt; <br /> <br /> {{begin-hl2msg|player_shield_blocked|string}}<br /> {{hl2msg|byte|attacker_entindex|entindex of the player who threw the jarate}}<br /> {{hl2msg|byte|blocker_entindex|entindex of the player receiving it}}<br /> {{end-hl2msg}}<br /> <br /> === player_pinned ===<br /> {{qnotice|When a player is pinned to a wall}}&lt;br&gt;<br /> {{begin-hl2msg|player_pinned|string}}<br /> {{hl2msg|byte|pinned|}}<br /> {{end-hl2msg}}<br /> <br /> === player_healedbymedic ===<br /> <br /> {{begin-hl2msg|player_healedbymedic|string}}<br /> {{hl2msg|byte|medic|}}<br /> {{end-hl2msg}}<br /> <br /> === player_spawn ===<br /> <br /> {{begin-hl2msg|player_spawn|string}}<br /> {{hl2msg|short|userid|user ID who spawned}}<br /> {{hl2msg|short|team|team they spawned on}}<br /> {{hl2msg|short|class|class they spawned as}}<br /> {{end-hl2msg}}<br /> <br /> === player_sapped_object ===<br /> <br /> {{begin-hl2msg|player_sapped_object|string}}<br /> {{hl2msg|short|userid|user ID of the spy}}<br /> {{hl2msg|short|ownerid|user ID of the building owner}}<br /> {{hl2msg|byte|object|}}<br /> {{hl2msg|short|sapperid|index of the sapper}}<br /> {{end-hl2msg}}<br /> <br /> === item_found ===<br /> {{qnotice|When a player finds an item}}&lt;br&gt;<br /> {{begin-hl2msg|item_found|string}}<br /> {{hl2msg|byte|player|entindex of the player}}<br /> {{hl2msg|byte|quality|quality of the item}}<br /> {{hl2msg|string|item|item name (unlocalized)}}<br /> {{hl2msg|bool|crafted|}}<br /> {{hl2msg|bool|propername|}}<br /> {{end-hl2msg}}<br /> <br /> === show_annotations ===<br /> {{begin-hl2msg|show_annotations|string}}<br /> {{hl2msg|float|worldPosX|}}<br /> {{hl2msg|float|worldPosY|}}<br /> {{hl2msg|float|worldPosZ|}}<br /> {{hl2msg|long|id|}}<br /> {{hl2msg|string|text|item name (unlocalized)}}<br /> {{end-hl2msg}}<br /> <br /> === hide_annotations ===<br /> {{begin-hl2msg|hide_annotations|string}}<br /> {{end-hl2msg}}<br /> <br /> === post_inventory_application ===<br /> {{qnotice|sent when a player gets a whole new set of items}}&lt;br&gt; <br /> {{begin-hl2msg|post_inventory_application|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === controlpoint_unlock_updated ===<br /> <br /> {{begin-hl2msg|controlpoint_unlock_updated|string}}<br /> {{hl2msg|short|index|index of the cap being updated}}<br /> {{hl2msg|float|time|time}}<br /> {{end-hl2msg}}<br /> <br /> === deploy_buff_banner ===<br /> <br /> {{begin-hl2msg|deploy_buff_banner|string}}<br /> {{hl2msg|byte|buff_type|type of buff (skin index)}}<br /> {{hl2msg|short|buff_owner|user ID of the person who gets the banner}}<br /> {{end-hl2msg}}<br /> <br /> === player_buff ===<br /> <br /> {{begin-hl2msg|player_buff|string}}<br /> {{hl2msg|short|userid|user ID of the player the buff is being applied to}}<br /> <br /> {{hl2msg|short|buff_owner|user ID of the player with the banner}}<br /> {{hl2msg|byte|buff_type|type of buff}}<br /> {{end-hl2msg}}<br /> <br /> === medic_death ===<br /> {{qnotice|When a medic dies}}&lt;br&gt;<br /> {{begin-hl2msg|medic_death|string}}<br /> {{hl2msg|short|userid|user ID who died}}<br /> {{hl2msg|short|attacker|user ID who killed}}<br /> {{hl2msg|short|healing|amount healed in this life}}<br /> {{hl2msg|bool|charged|had a full ubercharge?}}<br /> {{end-hl2msg}}<br /> <br /> === overtime_nag ===<br /> <br /> {{begin-hl2msg|overtime_nag|string}}<br /> {{end-hl2msg}}<br /> <br /> === teams_changed ===<br /> <br /> {{begin-hl2msg|teams_changed|string}}<br /> {{end-hl2msg}}<br /> <br /> <br /> <br /> <br /> <br /> <br /> <br /> === halloween_pumpkin_grab ===<br /> <br /> {{begin-hl2msg|halloween_pumpkin_grab|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === rocket_jump ===<br /> <br /> {{begin-hl2msg|rocket_jump|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === rocket_jump_landed ===<br /> <br /> {{begin-hl2msg|rocket_jump_landed|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === sticky_jump ===<br /> <br /> {{begin-hl2msg|sticky_jump|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === sticky_jump_landed ===<br /> <br /> {{begin-hl2msg|sticky_jump_landed|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === medic_defended ===<br /> <br /> {{begin-hl2msg|medic_defended|string}}<br /> {{hl2msg|short|userid|}}<br /> {{hl2msg|short|medic|}}<br /> {{end-hl2msg}}<br /> <br /> === localplayer_healed ===<br /> {{begin-hl2msg|localplayer_healed|string}}<br /> {{hl2msg|short|amount|}}<br /> {{end-hl2msg}}<br /> <br /> === player_destroyed_pipebomb ===<br /> <br /> {{begin-hl2msg|player_destroyed_pipebomb|string}}<br /> {{hl2msg|short|userid|}}<br /> {{end-hl2msg}}<br /> <br /> === object_deflected ===<br /> <br /> {{begin-hl2msg|object_deflected|string}}<br /> {{hl2msg|short|userid|player who deflected the object}}<br /> {{hl2msg|short|ownerid|owner of the object}}<br /> {{hl2msg|short|weaponid|weapon id (0 means the player in ownerid was pushed)}}<br /> <br /> {{end-hl2msg}}<br /> <br /> === player_mvp ===<br /> <br /> {{begin-hl2msg|player_mvp|string}}<br /> {{hl2msg|short|player|}}<br /> {{end-hl2msg}}<br /> <br /> === raid_spawn_mob ===<br /> {{begin-hl2msg|raid_spawn_mob|string}}<br /> {{end-hl2msg}}<br /> <br /> === raid_spawn_squad ===<br /> {{begin-hl2msg|raid_spawn_squad|string}}<br /> {{end-hl2msg}}<br /> <br /> === nav_blocked ===<br /> {{begin-hl2msg|nav_blocked|string}}<br /> {{hl2msg|long|area|}}<br /> {{hl2msg|bool|blocked|}}<br /> {{end-hl2msg}}<br /> <br /> === path_track_passed ===<br /> {{begin-hl2msg|path_track_passed|string}}<br /> {{hl2msg|short|index|index of the node being passed}}<br /> {{end-hl2msg}}<br /> <br /> === num_cappers_changed ===<br /> {{begin-hl2msg|num_cappers_changed|string}}<br /> {{hl2msg|short|index|index of the trigger}}<br /> {{hl2msg|byte|count|number of cappers (-1 for blocked)}}<br /> {{end-hl2msg}}<br /> <br /> === player_regenerate ===<br /> {{begin-hl2msg|player_regenerate|string}}<br /> {{end-hl2msg}}<br /> <br /> === update_status_item ===<br /> {{begin-hl2msg|update_status_item|string}}<br /> {{hl2msg|byte|index|}}<br /> {{hl2msg|byte|object|}}<br /> {{end-hl2msg}}<br /> <br /> === cart_updated ===<br /> {{begin-hl2msg|cart_updated|string}}<br /> {{end-hl2msg}}</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Team_Fortress_2_Item_Definition_Indexes&diff=7767 2010-07-11T01:53:32Z

<p>Pheadxdll: </p> <hr /> <div>This is a list of the item definition indexes in TF2, these are useful for distinguishing an unlockable weapon from its original (for example: The Backburner from an ordinary Flamethrower.)<br /> <br /> This list is divided in to Weapons, Hats and Crafting Items.<br /> <br /> Usage: &lt;pawn&gt;SetEntProp(edict, Prop_Send, &quot;m_iItemDefinitionIndex&quot;, index);&lt;/pawn&gt;<br /> <br /> == Weapons ==<br /> <br /> These are all of the weapons currently in TF2 and their item definition indexes.<br /> <br /> '''0''' - Bat&lt;br&gt;<br /> '''1''' - Bottle&lt;br&gt;<br /> '''2''' - Fire Axe&lt;br&gt;<br /> '''3''' - Kukri&lt;br&gt;<br /> '''4''' - Knife&lt;br&gt;<br /> '''5''' - Fists&lt;br&gt;<br /> '''6''' - Shovel&lt;br&gt;<br /> '''7''' - Wrench&lt;br&gt;<br /> '''8''' - Bonesaw&lt;br&gt;<br /> '''9''' - Engineer's Shotgun&lt;br&gt;<br /> '''10''' - Soldier's Shotgun&lt;br&gt;<br /> '''11''' - Heavy's Shotgun&lt;br&gt;<br /> '''12''' - Pyro's Shotgun&lt;br&gt;<br /> '''13''' - Scattergun&lt;br&gt;<br /> '''14''' - Sniper Rifle&lt;br&gt;<br /> '''15''' - Minigun&lt;br&gt;<br /> '''16''' - SMG&lt;br&gt;<br /> '''17''' - Syringe Gun&lt;br&gt;<br /> '''18''' - Rocket Launcher&lt;br&gt;<br /> '''19''' - Pipe Grenade Launcher&lt;br&gt;<br /> '''20''' - Sticky Bomb Launcher&lt;br&gt;<br /> '''21''' - Flamethrower&lt;br&gt;<br /> '''22''' - Engineer's Pistol&lt;br&gt;<br /> '''23''' - Scout's Pistol&lt;br&gt;<br /> '''24''' - Spy's Pistol&lt;br&gt;<br /> '''25''' - Builder PDA&lt;br&gt;<br /> '''26''' - Demolisher PDA&lt;br&gt;<br /> '''27''' - Disguise Kit PDA&lt;br&gt;<br /> '''29''' - Medigun&lt;br&gt;<br /> '''30''' - Cloak Watch&lt;br&gt;<br /> '''35''' - The Kritzkrieg&lt;br&gt;<br /> '''36''' - The Blutsauger&lt;br&gt;<br /> '''37''' - The Ubersaw&lt;br&gt;<br /> '''38''' - The Axtinguisher&lt;br&gt;<br /> '''39''' - The Flaregun&lt;br&gt;<br /> '''40''' - The Backburner&lt;br&gt;<br /> '''41''' - Natascha&lt;br&gt;<br /> '''42''' - Sandvich&lt;br&gt;<br /> '''43''' - The Killer Gloves Of Boxing&lt;br&gt;<br /> '''44''' - Sandman (Wooden Bat)&lt;br&gt;<br /> '''45''' - Force-A-Nature&lt;br&gt;<br /> '''46''' - Bonk! Atomic Punch&lt;br&gt;<br /> '''56''' - Huntsman&lt;br&gt;<br /> '''57''' - Razorback&lt;br&gt;<br /> '''58''' - Jarate&lt;br&gt;<br /> '''59''' - Dead Ringer&lt;br&gt;<br /> '''60''' - Cloak And Dagger&lt;br&gt;<br /> '''61''' - The Ambassador&lt;br&gt;<br /> '''127''' - The Direct Hit&lt;br&gt;<br /> '''128''' - The Equalizer&lt;br&gt;<br /> '''129''' - The Buff Banner&lt;br&gt;<br /> '''130''' - The Scottish Resistance&lt;br&gt;<br /> '''131''' - Chargin' Targe&lt;br&gt;<br /> '''132''' - The Eyelander&lt;br&gt;<br /> '''133''' - The Gunboats&lt;br&gt;<br /> '''140''' - The Wrangler&lt;br&gt;<br /> '''141''' - The Frontier Justice&lt;br&gt;<br /> '''142''' - The Gunslinger&lt;br&gt;<br /> '''153''' - Homewrecker&lt;br&gt;<br /> '''154''' - Pain Train&lt;br&gt;<br /> '''155''' - The Southern Hospitality&lt;br&gt;<br /> '''159''' - Dalokohs Bar&lt;br&gt;<br /> '''160''' - Lugermorph&lt;br&gt;<br /> '''161''' - Big Kill&lt;br&gt;<br /> '''163''' - Crit-a-Cola&lt;br&gt;<br /> '''169''' - Golden Wrench&lt;br&gt;<br /> '''171''' - Tribalman's Shiv&lt;br&gt;<br /> '''172''' - Scotsman's Skullcutter&lt;br&gt;<br /> <br /> == Hats ==<br /> <br /> These are all of the hats and wearables available in the game.<br /> <br /> '''47''' - Demoman's 'Fro&lt;br&gt;<br /> '''48''' - Mining Light&lt;br&gt;<br /> '''49''' - Football Helmet&lt;br&gt;<br /> '''50''' - Prussian Pickelhaube&lt;br&gt;<br /> '''51''' - Pyro's Beanie&lt;br&gt;<br /> '''52''' - Batter's Helmet&lt;br&gt;<br /> '''53''' - Trophy Hat&lt;br&gt;<br /> '''54''' - Soldier's Stash&lt;br&gt;<br /> '''55''' - Fancy Fedora&lt;br&gt;<br /> '''94''' - Texas Ten Gallon&lt;br&gt;<br /> '''95''' - Engineer's Cap&lt;br&gt;<br /> '''96''' - Officer's Ushanka&lt;br&gt;<br /> '''97''' - Tough Guy's Tuque&lt;br&gt;<br /> '''98''' - Stainless Pot&lt;br&gt;<br /> '''99''' - Tyrant's Helm&lt;br&gt;<br /> '''100''' - Glengarry Bonnet&lt;br&gt;<br /> '''101''' - Vintage Tyrolean&lt;br&gt;<br /> '''102''' - Respectless Rubber Glove&lt;br&gt;<br /> '''103''' - Camera Beard&lt;br&gt;<br /> '''104''' - Otolaryngologist's Mirror&lt;br&gt;<br /> '''105''' - Brigade Helm&lt;br&gt;<br /> '''106''' - Bonk Helm&lt;br&gt;<br /> '''107''' - Ye Olde Baker Boy&lt;br&gt;<br /> '''108''' - Backbiter's Billycock&lt;br&gt;<br /> '''109''' - Professional's Panama&lt;br&gt;<br /> '''110''' - Master's Yellow Belt&lt;br&gt;<br /> '''111''' - Baseball Bill's Sports Shine (Hatless Scout)&lt;br&gt;<br /> '''115''' - Halloween Hat (Only appears on Halloween)&lt;br&gt;<br /> '''116''' - Ghastly Gibus&lt;br&gt;<br /> '''117''' - Ritzy Rick's Hair Fixative (Hatless Sniper)&lt;br&gt;<br /> '''118''' - Texas Slim's Dome Shine (Hatless Engineer)&lt;br&gt;<br /> '''120''' - Scottsman's Stove Pipe&lt;br&gt;<br /> '''121''' - Service Medal&lt;br&gt;<br /> '''125''' - Cheater's Lament&lt;br&gt;<br /> '''126''' - Bill's Hat&lt;br&gt;<br /> '''134''' - J.Axer's Dapper Topper&lt;br&gt;<br /> '''135''' - Towering Pillar of Hats&lt;br&gt;<br /> '''136''' - Amber's Rad As All Hell Hat&lt;br&gt;<br /> '''137''' - Noble Amassment of Hats&lt;br&gt;<br /> '''138''' - Uncle Sam&lt;br&gt;<br /> '''139''' - Modest Pile of Hat&lt;br&gt;<br /> '''143''' - Earbuds&lt;br&gt;<br /> '''144''' - Physician's Procedure Mask&lt;br&gt;<br /> '''145''' - Hound Dog&lt;br&gt;<br /> '''146''' - Hustler's Hallmark&lt;br&gt;<br /> '''147''' - Magistrate's Mullet&lt;br&gt;<br /> '''148''' - Hotrod&lt;br&gt;<br /> '''150''' - Troublemaker's Tossle Cap&lt;br&gt;<br /> '''151''' - Triboniophorus Tyrannus&lt;br&gt;<br /> '''152''' - Killer's Kabuto&lt;br&gt;<br /> '''158''' - Shooter's Sola Topi&lt;br&gt;<br /> '''162''' - Max's Severed Head&lt;br&gt;<br /> '''164''' - Grizzled Veteran&lt;br&gt;<br /> '''165''' - Soldier of Fortune&lt;br&gt;<br /> '''166''' - Mercenary&lt;br&gt;<br /> '''170''' - Primeval Warrior&lt;br&gt;<br /> '''174''' - Whoopee Cap&lt;br&gt;<br /> '''175''' - Whiskered Gentleman&lt;br&gt;<br /> '''177''' - Ze Goggles&lt;br&gt;<br /> '''178''' - Safe'n'Sound&lt;br&gt;<br /> '''179''' - Tippler's Tricorne&lt;br&gt;<br /> '''180''' - Frenchman's Beret&lt;br&gt;<br /> '''181''' - Bloke's Bucket Hat&lt;br&gt;<br /> '''182''' - Vintage Merryweather&lt;br&gt;<br /> '''183''' - Sergeant's Drill Hat&lt;br&gt;<br /> '''184''' - Gentleman's Gatsby&lt;br&gt;<br /> '''185''' - Heavy Duty Rag&lt;br&gt;<br /> <br /> == Craft Items ==<br /> <br /> These are the items obtained and used primarily through crafting.<br /> <br /> '''5000''' - Scrap Metal&lt;br&gt;<br /> '''5001''' - Reclaimed Metal&lt;br&gt;<br /> '''5002''' - Refined Metal&lt;br&gt;<br /> '''5003''' - Scout Class Token&lt;br&gt;<br /> '''5004''' - Sniper Class Token&lt;br&gt;<br /> '''5005''' - Soldier Class Token&lt;br&gt;<br /> '''5006''' - Demoman Class Token&lt;br&gt;<br /> '''5007''' - Heavy Class Token&lt;br&gt;<br /> '''5008''' - Medic Class Token&lt;br&gt;<br /> '''5009''' - Pyro Class Token&lt;br&gt;<br /> '''5010''' - Spy Class Token&lt;br&gt;<br /> '''5011''' - Engineer Class Token&lt;br&gt;<br /> '''5012''' - Primary Slot Token&lt;br&gt;<br /> '''5013''' - Secondary Slot Token&lt;br&gt;<br /> '''5014''' - Melee Slot Token&lt;br&gt;<br /> '''5015''' - Grenade Slot Token&lt;br&gt;<br /> '''5016''' - Building Slot Token&lt;br&gt;<br /> '''5017''' - PDA Slot Token&lt;br&gt;<br /> '''5018''' - PDA2 Slot Token&lt;br&gt;<br /> '''5019''' - Head Slot Token&lt;br&gt;</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Team_Fortress_2_Item_Definition_Indexes&diff=7766 2010-07-11T01:53:10Z

<p>Pheadxdll: Engineer weaps</p> <hr /> <div>This is a list of the item definition indexes in TF2, these are useful for distinguishing an unlockable weapon from its original (for example: The Backburner from an ordinary Flamethrower.)<br /> <br /> This list is divided in to Weapons, Hats and Crafting Items.<br /> <br /> Usage: &lt;pawn&gt;SetEntProp(edict, Prop_Send, &quot;m_iItemDefinitionIndex&quot;, index);&lt;/pawn&gt;<br /> <br /> == Weapons ==<br /> <br /> These are all of the weapons currently in TF2 and their item definition indexes.<br /> <br /> '''0''' - Bat&lt;br&gt;<br /> '''1''' - Bottle&lt;br&gt;<br /> '''2''' - Fire Axe&lt;br&gt;<br /> '''3''' - Kukri&lt;br&gt;<br /> '''4''' - Knife&lt;br&gt;<br /> '''5''' - Fists&lt;br&gt;<br /> '''6''' - Shovel&lt;br&gt;<br /> '''7''' - Wrench&lt;br&gt;<br /> '''8''' - Bonesaw&lt;br&gt;<br /> '''9''' - Engineer's Shotgun&lt;br&gt;<br /> '''10''' - Soldier's Shotgun&lt;br&gt;<br /> '''11''' - Heavy's Shotgun&lt;br&gt;<br /> '''12''' - Pyro's Shotgun&lt;br&gt;<br /> '''13''' - Scattergun&lt;br&gt;<br /> '''14''' - Sniper Rifle&lt;br&gt;<br /> '''15''' - Minigun&lt;br&gt;<br /> '''16''' - SMG&lt;br&gt;<br /> '''17''' - Syringe Gun&lt;br&gt;<br /> '''18''' - Rocket Launcher&lt;br&gt;<br /> '''19''' - Pipe Grenade Launcher&lt;br&gt;<br /> '''20''' - Sticky Bomb Launcher&lt;br&gt;<br /> '''21''' - Flamethrower&lt;br&gt;<br /> '''22''' - Engineer's Pistol&lt;br&gt;<br /> '''23''' - Scout's Pistol&lt;br&gt;<br /> '''24''' - Spy's Pistol&lt;br&gt;<br /> '''25''' - Builder PDA&lt;br&gt;<br /> '''26''' - Demolisher PDA&lt;br&gt;<br /> '''27''' - Disguise Kit PDA&lt;br&gt;<br /> '''29''' - Medigun&lt;br&gt;<br /> '''30''' - Cloak Watch&lt;br&gt;<br /> '''35''' - The Kritzkrieg&lt;br&gt;<br /> '''36''' - The Blutsauger&lt;br&gt;<br /> '''37''' - The Ubersaw&lt;br&gt;<br /> '''38''' - The Axtinguisher&lt;br&gt;<br /> '''39''' - The Flaregun&lt;br&gt;<br /> '''40''' - The Backburner&lt;br&gt;<br /> '''41''' - Natascha&lt;br&gt;<br /> '''42''' - Sandvich&lt;br&gt;<br /> '''43''' - The Killer Gloves Of Boxing&lt;br&gt;<br /> '''44''' - Sandman (Wooden Bat)&lt;br&gt;<br /> '''45''' - Force-A-Nature&lt;br&gt;<br /> '''46''' - Bonk! Atomic Punch&lt;br&gt;<br /> '''56''' - Huntsman&lt;br&gt;<br /> '''57''' - Razorback&lt;br&gt;<br /> '''58''' - Jarate&lt;br&gt;<br /> '''59''' - Dead Ringer&lt;br&gt;<br /> '''60''' - Cloak And Dagger&lt;br&gt;<br /> '''61''' - The Ambassador&lt;br&gt;<br /> '''127''' - The Direct Hit&lt;br&gt;<br /> '''128''' - The Equalizer&lt;br&gt;<br /> '''129''' - The Buff Banner&lt;br&gt;<br /> '''130''' - The Scottish Resistance&lt;br&gt;<br /> '''131''' - Chargin' Targe&lt;br&gt;<br /> '''132''' - The Eyelander&lt;br&gt;<br /> '''133''' - The Gunboats&lt;br&gt;<br /> '''140''' - The Wrangler&lt;br&gt;<br /> '''141''' - The Frontier Justice&lt;br&gt;<br /> '''142''' - The Gunslinger<br /> '''153''' - Homewrecker&lt;br&gt;<br /> '''154''' - Pain Train&lt;br&gt;<br /> '''155''' - The Southern Hospitality&lt;br&gt;<br /> '''159''' - Dalokohs Bar&lt;br&gt;<br /> '''160''' - Lugermorph&lt;br&gt;<br /> '''161''' - Big Kill&lt;br&gt;<br /> '''163''' - Crit-a-Cola&lt;br&gt;<br /> '''169''' - Golden Wrench&lt;br&gt;<br /> '''171''' - Tribalman's Shiv&lt;br&gt;<br /> '''172''' - Scotsman's Skullcutter&lt;br&gt;<br /> <br /> == Hats ==<br /> <br /> These are all of the hats and wearables available in the game.<br /> <br /> '''47''' - Demoman's 'Fro&lt;br&gt;<br /> '''48''' - Mining Light&lt;br&gt;<br /> '''49''' - Football Helmet&lt;br&gt;<br /> '''50''' - Prussian Pickelhaube&lt;br&gt;<br /> '''51''' - Pyro's Beanie&lt;br&gt;<br /> '''52''' - Batter's Helmet&lt;br&gt;<br /> '''53''' - Trophy Hat&lt;br&gt;<br /> '''54''' - Soldier's Stash&lt;br&gt;<br /> '''55''' - Fancy Fedora&lt;br&gt;<br /> '''94''' - Texas Ten Gallon&lt;br&gt;<br /> '''95''' - Engineer's Cap&lt;br&gt;<br /> '''96''' - Officer's Ushanka&lt;br&gt;<br /> '''97''' - Tough Guy's Tuque&lt;br&gt;<br /> '''98''' - Stainless Pot&lt;br&gt;<br /> '''99''' - Tyrant's Helm&lt;br&gt;<br /> '''100''' - Glengarry Bonnet&lt;br&gt;<br /> '''101''' - Vintage Tyrolean&lt;br&gt;<br /> '''102''' - Respectless Rubber Glove&lt;br&gt;<br /> '''103''' - Camera Beard&lt;br&gt;<br /> '''104''' - Otolaryngologist's Mirror&lt;br&gt;<br /> '''105''' - Brigade Helm&lt;br&gt;<br /> '''106''' - Bonk Helm&lt;br&gt;<br /> '''107''' - Ye Olde Baker Boy&lt;br&gt;<br /> '''108''' - Backbiter's Billycock&lt;br&gt;<br /> '''109''' - Professional's Panama&lt;br&gt;<br /> '''110''' - Master's Yellow Belt&lt;br&gt;<br /> '''111''' - Baseball Bill's Sports Shine (Hatless Scout)&lt;br&gt;<br /> '''115''' - Halloween Hat (Only appears on Halloween)&lt;br&gt;<br /> '''116''' - Ghastly Gibus&lt;br&gt;<br /> '''117''' - Ritzy Rick's Hair Fixative (Hatless Sniper)&lt;br&gt;<br /> '''118''' - Texas Slim's Dome Shine (Hatless Engineer)&lt;br&gt;<br /> '''120''' - Scottsman's Stove Pipe&lt;br&gt;<br /> '''121''' - Service Medal&lt;br&gt;<br /> '''125''' - Cheater's Lament&lt;br&gt;<br /> '''126''' - Bill's Hat&lt;br&gt;<br /> '''134''' - J.Axer's Dapper Topper&lt;br&gt;<br /> '''135''' - Towering Pillar of Hats&lt;br&gt;<br /> '''136''' - Amber's Rad As All Hell Hat&lt;br&gt;<br /> '''137''' - Noble Amassment of Hats&lt;br&gt;<br /> '''138''' - Uncle Sam&lt;br&gt;<br /> '''139''' - Modest Pile of Hat&lt;br&gt;<br /> '''143''' - Earbuds&lt;br&gt;<br /> '''144''' - Physician's Procedure Mask&lt;br&gt;<br /> '''145''' - Hound Dog&lt;br&gt;<br /> '''146''' - Hustler's Hallmark&lt;br&gt;<br /> '''147''' - Magistrate's Mullet&lt;br&gt;<br /> '''148''' - Hotrod&lt;br&gt;<br /> '''150''' - Troublemaker's Tossle Cap&lt;br&gt;<br /> '''151''' - Triboniophorus Tyrannus&lt;br&gt;<br /> '''152''' - Killer's Kabuto&lt;br&gt;<br /> '''158''' - Shooter's Sola Topi&lt;br&gt;<br /> '''162''' - Max's Severed Head&lt;br&gt;<br /> '''164''' - Grizzled Veteran&lt;br&gt;<br /> '''165''' - Soldier of Fortune&lt;br&gt;<br /> '''166''' - Mercenary&lt;br&gt;<br /> '''170''' - Primeval Warrior&lt;br&gt;<br /> '''174''' - Whoopee Cap&lt;br&gt;<br /> '''175''' - Whiskered Gentleman&lt;br&gt;<br /> '''177''' - Ze Goggles&lt;br&gt;<br /> '''178''' - Safe'n'Sound&lt;br&gt;<br /> '''179''' - Tippler's Tricorne&lt;br&gt;<br /> '''180''' - Frenchman's Beret&lt;br&gt;<br /> '''181''' - Bloke's Bucket Hat&lt;br&gt;<br /> '''182''' - Vintage Merryweather&lt;br&gt;<br /> '''183''' - Sergeant's Drill Hat&lt;br&gt;<br /> '''184''' - Gentleman's Gatsby&lt;br&gt;<br /> '''185''' - Heavy Duty Rag&lt;br&gt;<br /> <br /> == Craft Items ==<br /> <br /> These are the items obtained and used primarily through crafting.<br /> <br /> '''5000''' - Scrap Metal&lt;br&gt;<br /> '''5001''' - Reclaimed Metal&lt;br&gt;<br /> '''5002''' - Refined Metal&lt;br&gt;<br /> '''5003''' - Scout Class Token&lt;br&gt;<br /> '''5004''' - Sniper Class Token&lt;br&gt;<br /> '''5005''' - Soldier Class Token&lt;br&gt;<br /> '''5006''' - Demoman Class Token&lt;br&gt;<br /> '''5007''' - Heavy Class Token&lt;br&gt;<br /> '''5008''' - Medic Class Token&lt;br&gt;<br /> '''5009''' - Pyro Class Token&lt;br&gt;<br /> '''5010''' - Spy Class Token&lt;br&gt;<br /> '''5011''' - Engineer Class Token&lt;br&gt;<br /> '''5012''' - Primary Slot Token&lt;br&gt;<br /> '''5013''' - Secondary Slot Token&lt;br&gt;<br /> '''5014''' - Melee Slot Token&lt;br&gt;<br /> '''5015''' - Grenade Slot Token&lt;br&gt;<br /> '''5016''' - Building Slot Token&lt;br&gt;<br /> '''5017''' - PDA Slot Token&lt;br&gt;<br /> '''5018''' - PDA2 Slot Token&lt;br&gt;<br /> '''5019''' - Head Slot Token&lt;br&gt;</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Achievement_IDs&diff=7459 2009-12-18T08:14:24Z

<p>Pheadxdll: </p> <hr /> <div>== Achievement Identification Numbers ==<br /> <br /> VALVe uses :<br /> <br /> '''CTFPlayer::AwardAchievement(int iAchievementID, int iIterator)''' <br /> <br /> in order to award a player an achievement. Each achievement has a specific ID number. The list below is a (hopefully) complete list of ID numbers.<br /> <br /> Format: &lt;ID Number&gt;: &lt;Name&gt;<br /> <br /> Special Thanks to '''CShadowRun''' and '''predcrab''' for all their help!<br /> <br /> ----<br /> <br /> === General Achievements ===<br /> <br /> &lt;pre&gt;127: Sentry Gunner<br /> 128: Nemesis<br /> 129: Hard To Kill<br /> 130: Master of Disguise<br /> 131: With Friends Like These<br /> 132: Dynasty<br /> 133: Hardcore<br /> 134: Powerhouse Offense<br /> 135: Lightning Offense<br /> 136: Relentless Offense<br /> 137: Impenetrable Defense<br /> 138: Impossible Defense<br /> 139: Head of the Class<br /> 140: World Traveler<br /> 141: Team Doctor<br /> 142: Flamethrower<br /> 145: Grey Matter<br /> &lt;/pre&gt;<br /> <br /> === Medic Achievements ===<br /> &lt;pre&gt;1401: First Do No Harm<br /> 1402: Quadruple Bypass<br /> 1403: Group Health<br /> 1404: Surgical Prep<br /> 1405: Trauma Queen<br /> 1406: Double Blind Trial<br /> 1407: Play Doctor<br /> 1408: Triage<br /> 1409: Preventative Medicine<br /> 1410: Consultation<br /> 1411: Does It Hurt When I Do This?<br /> 1412: Peer Review<br /> 1413: Big Pharma<br /> 1414: You'll Feel a Little Prick<br /> 1415: Autoclave<br /> 1416: Blunt Trauma<br /> 1417: Medical Breakthrough<br /> 1418: Blast Assist<br /> 1419: Midwife Crisis<br /> 1420: Ubi concordia, ibi victoria<br /> 1421: Grand Rounds<br /> 1422: Infernal Medicine<br /> 1423: Doctor Assisted Homicide<br /> 1424: Placebo Effect<br /> 1425: Sawbones<br /> 1426: Intern<br /> 1427: Specialist<br /> 1428: Chief of Staff<br /> 1429: Hypocritical Oath<br /> 1430: Medical Intervention<br /> 1431: Second Opinion<br /> 1432: Autopsy Report<br /> 1433: FYI I am A Medic<br /> 1434: Family Practice<br /> 1435: House Call<br /> 1436: Bedside Manner<br /> 1437: Milestone 1<br /> 1438: Milestone 2<br /> 1439: Milestone 3&lt;/pre&gt;<br /> <br /> === Pyro Achievements ===<br /> &lt;pre&gt;1601: Combined Fire<br /> 1602: Weenie Roast<br /> 1603: Baptism By Fire<br /> 1604: Fire and Forget<br /> 1605: Firewall<br /> 1606: Cooking the Books<br /> 1607: Spontaneous Combustion<br /> 1608: Trailblazer<br /> 1609: Camp Fire<br /> 1610: Lumberjack<br /> 1611: Clearcutter<br /> 1612: Hot on Your Heels<br /> 1613: I Fry<br /> 1614: Firewatch<br /> 1615: Burn Ward<br /> 1616: Hot Potato<br /> 1617: Makin' Bacon<br /> 1618: Plan B<br /> 1619: Pyrotechnics<br /> 1620: Arsonist<br /> 1621: Controlled Burn<br /> 1622: Firefighter<br /> 1623: Pyromancer<br /> 1624: Next of Kindling<br /> 1625: OMGWTFBBQ<br /> 1626: Second Degree Burn<br /> 1627: Got A Light?<br /> 1628: BarbeQueQ<br /> 1629: Hotshot<br /> 1630: Dance Dance Immolation<br /> 1631: Dead Heat<br /> 1632: Pilot Light<br /> 1633: Freezer Burn<br /> 1634: Fire Chief<br /> 1635: Attention Getter<br /> 1637: Milestone 1<br /> 1638: Milestone 2<br /> 1639: Milestone 3&lt;/pre&gt;<br /> <br /> ===Heavy Achievements===<br /> &lt;pre&gt;1501: Iron Kurtain<br /> 1502: Party Loyalty<br /> 1503: Division of Labor<br /> 1504: Red Oktoberfest<br /> 1505: Show Trial<br /> 1506: Crime and Punishment<br /> 1507: Class Struggle<br /> 1508: Soviet Block<br /> 1509: Stalin the Kart<br /> 1510: Supreme Soviet<br /> 1511: Factory Worker<br /> 1512: Soviet Union<br /> 1513: Own the Means of Production<br /> 1514: Krazy Ivan<br /> 1515: Rasputin<br /> 1516: Icing on the Cake<br /> 1517: Crock Block<br /> 1518: Kollectivization<br /> 1519: Spyalectical Materialism<br /> 1520: Permanent Revolution<br /> 1521: Heavy Industry<br /> 1522: Communist Mani-Fisto<br /> 1523: Redistribution of Health<br /> 1524: Rationing<br /> 1525: Vanguard Party<br /> 1527: Pushkin the Kart<br /> 1528: Marxman<br /> 1529: Gorky Parked<br /> 1530: Purge<br /> 1531: Lenin A Hand<br /> 1532: Five Second Plan<br /> 1533: Photostroika<br /> 1534: Konspicuous Konsumption<br /> 1535: Don't Touch Sandvich<br /> 1536: Borscht Belt<br /> 1537: Milestone 1<br /> 1538: Milestone 2<br /> 1539: Milestone 3<br /> &lt;/pre&gt;<br /> <br /> ===Scout Achievements===<br /> &lt;pre&gt;1001: First Blood<br /> 1002: First Blood, Part 2<br /> 1003: Quick Hook<br /> 1004: A Year to Remember<br /> 1005: The Cycle<br /> 1006: Closer<br /> 1007: If You Build it<br /> 1008: Gun Down<br /> 1009: Butter Up<br /> 1010: Doctoring the ball<br /> 1011: Dodgers 1, Giants 0<br /> 1012: Batting the Doctor<br /> 1013: I'm Bat Man<br /> 1014: Triple Steal<br /> 1015: Pop Fly<br /> 1016: Round-Tripper<br /> 1017: Artful Dodger<br /> 1018: Fall Classic<br /> 1019: Strike Zone<br /> 1020: Foul Territory<br /> 1021: The Big Hurt<br /> 1022: Brushback<br /> 1023: Moon Shot<br /> 1024: Beanball<br /> 1025: Retire the Runner<br /> 1026: Caught Napping<br /> 1027: Side Retired<br /> 1028: Triple Play<br /> 1029: Stealing Home<br /> 1030: Set the Table<br /> 1031: Block the Plate<br /> 1032: Belittled Beleaguer<br /> 1033: No-Hitter<br /> 1034: Race for the Pennant<br /> 1035: Out of the Park<br /> 1036: Milestone 1<br /> 1037: Milestone 2<br /> 1038: Milestone 3<br /> &lt;/pre&gt;<br /> <br /> ===Sniper Achievements===<br /> &lt;pre&gt;<br /> 1101: Rode Hard, Put Away Wet<br /> 1102: Be polite<br /> 1103: Be Efficient<br /> 1104: Have a Plan<br /> 1105: Kill Everyone You Meet<br /> 1106: Triple Prey<br /> 1107: Self-Destruct Sequence<br /> 1108: De-sentry-lized<br /> 1109: Shoot the Breeze<br /> 1110: Dropped Dead<br /> 1111: the last wave<br /> 1112: australian rules<br /> 1113: Kook the Spook<br /> 1114: Socket to Him<br /> 1115: Jumper Stumper<br /> 1116: Not a Crazed Gunman, Dad<br /> 1117: Trust Your Feelings<br /> 1118: Überectomy<br /> 1119: Consolation Prize<br /> 1120: Enemy at the Gate<br /> 1121: Parting Shot<br /> 1122: My Brilliant Career<br /> 1123: Shock Treatment<br /> 1124: Saturation Bombing<br /> 1125: Rain on Their Parade<br /> 1126: Jarring Transition<br /> 1127: Friendship is Golden<br /> 1128: William Tell Overkill<br /> 1129: Beaux and Arrows<br /> 1130: Robbin’ Hood<br /> 1131: Pincushion<br /> 1132: Number One Assistant<br /> 1133: Jarate Chop<br /> 1134: Shafted<br /> 1135: Dead Reckoning<br /> &lt;/pre&gt;<br /> <br /> ===Spy Achievements===<br /> &lt;pre&gt;<br /> 1701: Triplecrossed<br /> 1702: For Your Eyes Only<br /> 1703: Counter Espionage<br /> 1704: Identity Theft<br /> 1705: The Man from P.U.N.C.T.U.R.E.<br /> 1706: FYI I am a Spy<br /> 1707: The Man with the Broken Guns<br /> 1708: Sapsucker<br /> 1709: May I Cut In?<br /> 1710: Agent Provocateur<br /> 1711: The Melbourne Supremacy<br /> 1712: Spies Like Us<br /> 1713: A Cut Above<br /> 1714: Burn Notice<br /> 1715: Die Another Way<br /> 1716: Constructus Interruptus<br /> 1717: On Her Majesty’s Secret Surface<br /> 1718: Insurance Fraud<br /> 1719: Point Breaker<br /> 1720: High Value Target<br /> 1721: Come in From the Cold<br /> 1722: Wetwork<br /> 1723: You Only Shiv Thrice<br /> 1724: Spymaster<br /> 1725: Sap Auteur<br /> 1726: Joint Operation<br /> 1727: Dr. Nooooo<br /> 1728: Is It Safe?<br /> 1729: Slash and Burn<br /> 1730: Biplomacy<br /> 1731: Skullpluggery<br /> 1732: Sleeper Agent<br /> 1733: Who's Your Daddy?<br /> 1734: Deep Undercover<br /> &lt;/pre&gt;<br /> <br /> ===Halloween Event Achievements===<br /> &lt;pre&gt;<br /> 1901: Candy Cornoner<br /> 1902: Ghastly Gibus Grab<br /> 1903: Scared Stiff<br /> 1904: Attack 'o Latern<br /> 1905: Costume Contest<br /> &lt;/pre&gt;<br /> <br /> ===Soldier Achievements===<br /> &lt;pre&gt;<br /> 1201: Duty Bound<br /> 1202: The Boostie Boys<br /> 1203: Out, Damned Scot!<br /> 1204: Engineer to Eternity<br /> 1205: Backdraft Dodger<br /> 1206: Trench Warfare<br /> 1207: Bomb Squaddie<br /> 1208: Where Eagles Dare<br /> 1209: Ain't Got Time to Bleed<br /> 1210: Banner of Brothers<br /> 1211: Tri-Splatteral Damage<br /> 1212: Death from Above<br /> 1213: Spray of Defeat<br /> 1214: War Crime and Punishment<br /> 1215: Near Death Experience<br /> 1216: Wings of Glory<br /> 1217: For Whom the Shell Trolls<br /> 1218: Death From Below<br /> 1219: Mutually Assured Destruction<br /> 1220: Guns of the Navar0wned<br /> 1221: Brothers in Harms<br /> 1222: Medals of Honor<br /> 1223: S*M*A*S*H<br /> 1224: Crockets Are Such B.S.<br /> 1225: Geneva Contravention<br /> 1226: Semper Fry<br /> 1227: Worth a Thousand Words<br /> 1228: Gore-a! Gore-a! Gore-a!<br /> 1229: War Crime Spybunal<br /> 1230: Frags of our Fathers<br /> 1231: Dominator<br /> 1232: Ride of the Valkartie<br /> 1233: Screamin' Eagle<br /> 1234: The Longest Daze<br /> 1235: Hamburger Hill<br /> 1236: Soldier Milestone 1<br /> 1237: Soldier Milestone 2<br /> 1238: Soldier Milestone 3<br /> &lt;/pre&gt;<br /> <br /> ===Demoman Achievements===<br /> &lt;pre&gt;<br /> 1301: Kilt in Action<br /> 1302: Tam O'Shatter<br /> 1303: Shorn Connery<br /> 1304: Laddy Macdeth<br /> 1305: Caber Toss<br /> 1306: Double Mauled Scotch<br /> 1307: Loch Ness Bombster<br /> 1308: Three Times a Laddy<br /> 1309: Blind Fire<br /> 1310: Brainspotting<br /> 1311: Left 4 Heads<br /> 1312: Well Plaid!<br /> 1313: The Scottish Play<br /> 1314: The Argyle Sap<br /> 1315: Slammy Slayvis Woundya<br /> 1316: There Can Be Only One<br /> 1317: Tartan Spartan<br /> 1318: Scotch Guard<br /> 1319: Bravehurt<br /> 1320: Cry Some Moor!<br /> 1321: The Stickening<br /> 1322: Glasg0wned<br /> 1323: Scotch Tap<br /> 1324: The Targe Charge<br /> 1325: Beat Me Up, Scotty<br /> 1326: Something Stickied This Way Comes<br /> 1327: The High Road<br /> 1328: Bloody Merry<br /> 1329: Second Eye<br /> 1330: He Who Celt It<br /> 1331: Robbed Royal<br /> 1332: Highland Fling<br /> 1333: Pipebagger<br /> 1334: Spynal Tap<br /> 1335: Sticky Thump<br /> 1336: Demoman Milestone 1<br /> 1337: Demoman Milestone 2<br /> 1338: Demoman Milestone 3<br /> &lt;/pre&gt;</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Achievement_IDs&diff=7440 2009-10-30T15:27:08Z

<p>Pheadxdll: Fixed incorrect IDs</p> <hr /> <div>== Achievement Identification Numbers ==<br /> <br /> VALVe uses :<br /> <br /> '''CTFPlayer::AwardAchievement(int iAchievementID)''' <br /> <br /> in order to award a player an achievement. Each achievement has a specific ID number. The list below is a (hopefully) complete list of ID numbers.<br /> <br /> Format: &lt;ID Number&gt;: &lt;Name&gt;<br /> <br /> Special Thanks to '''CShadowRun''' and '''predcrab''' for all their help!<br /> <br /> ----<br /> <br /> === General Achievements ===<br /> <br /> &lt;pre&gt;127: Sentry Gunner<br /> 128: Nemesis<br /> 129: Hard To Kill<br /> 130: Master of Disguise<br /> 131: With Friends Like These<br /> 132: Dynasty<br /> 133: Hardcore<br /> 134: Powerhouse Offense<br /> 135: Lightning Offense<br /> 136: Relentless Offense<br /> 137: Impenetrable Defense<br /> 138: Impossible Defense<br /> 139: Head of the Class<br /> 140: World Traveler<br /> 141: Team Doctor<br /> 142: Flamethrower<br /> 145: Grey Matter<br /> &lt;/pre&gt;<br /> <br /> === Medic Achievements ===<br /> &lt;pre&gt;1401: First Do No Harm<br /> 1402: Quadruple Bypass<br /> 1403: Group Health<br /> 1404: Surgical Prep<br /> 1405: Trauma Queen<br /> 1406: Double Blind Trial<br /> 1407: Play Doctor<br /> 1408: Triage<br /> 1409: Preventative Medicine<br /> 1410: Consultation<br /> 1411: Does It Hurt When I Do This?<br /> 1412: Peer Review<br /> 1413: Big Pharma<br /> 1414: You'll Feel a Little Prick<br /> 1415: Autoclave<br /> 1416: Blunt Trauma<br /> 1417: Medical Breakthrough<br /> 1418: Blast Assist<br /> 1419: Midwife Crisis<br /> 1420: Ubi concordia, ibi victoria<br /> 1421: Grand Rounds<br /> 1422: Infernal Medicine<br /> 1423: Doctor Assisted Homicide<br /> 1424: Placebo Effect<br /> 1425: Sawbones<br /> 1426: Intern<br /> 1427: Specialist<br /> 1428: Chief of Staff<br /> 1429: Hypocritical Oath<br /> 1430: Medical Intervention<br /> 1431: Second Opinion<br /> 1432: Autopsy Report<br /> 1433: FYI I am A Medic<br /> 1434: Family Practice<br /> 1435: House Call<br /> 1436: Bedside Manner<br /> 1437: Milestone 1<br /> 1438: Milestone 2<br /> 1439: Milestone 3&lt;/pre&gt;<br /> <br /> === Pyro Achievements ===<br /> &lt;pre&gt;1601: Combined Fire<br /> 1602: Weenie Roast<br /> 1603: Baptism By Fire<br /> 1604: Fire and Forget<br /> 1605: Firewall<br /> 1606: Cooking the Books<br /> 1607: Spontaneous Combustion<br /> 1608: Trailblazer<br /> 1609: Camp Fire<br /> 1610: Lumberjack<br /> 1611: Clearcutter<br /> 1612: Hot on Your Heels<br /> 1613: I Fry<br /> 1614: Firewatch<br /> 1615: Burn Ward<br /> 1616: Hot Potato<br /> 1617: Makin' Bacon<br /> 1618: Plan B<br /> 1619: Pyrotechnics<br /> 1620: Arsonist<br /> 1621: Controlled Burn<br /> 1622: Firefighter<br /> 1623: Pyromancer<br /> 1624: Next of Kindling<br /> 1625: OMGWTFBBQ<br /> 1626: Second Degree Burn<br /> 1627: Got A Light?<br /> 1628: BarbeQueQ<br /> 1629: Hotshot<br /> 1630: Dance Dance Immolation<br /> 1631: Dead Heat<br /> 1632: Pilot Light<br /> 1633: Freezer Burn<br /> 1634: Fire Chief<br /> 1635: Attention Getter<br /> 1637: Milestone 1<br /> 1638: Milestone 2<br /> 1639: Milestone 3&lt;/pre&gt;<br /> <br /> ===Heavy Achievements===<br /> &lt;pre&gt;1501: Iron Kurtain<br /> 1502: Party Loyalty<br /> 1503: Division of Labor<br /> 1504: Red Oktoberfest<br /> 1505: Show Trial<br /> 1506: Crime and Punishment<br /> 1507: Class Struggle<br /> 1508: Soviet Block<br /> 1509: Stalin the Kart<br /> 1510: Supreme Soviet<br /> 1511: Factory Worker<br /> 1512: Soviet Union<br /> 1513: Own the Means of Production<br /> 1514: Krazy Ivan<br /> 1515: Rasputin<br /> 1516: Icing on the Cake<br /> 1517: Crock Block<br /> 1518: Kollectivization<br /> 1519: Spyalectical Materialism<br /> 1520: Permanent Revolution<br /> 1521: Heavy Industry<br /> 1522: Communist Mani-Fisto<br /> 1523: Redistribution of Health<br /> 1524: Rationing<br /> 1525: Vanguard Party<br /> 1527: Pushkin the Kart<br /> 1528: Marxman<br /> 1529: Gorky Parked<br /> 1530: Purge<br /> 1531: Lenin A Hand<br /> 1532: Five Second Plan<br /> 1533: Photostroika<br /> 1534: Konspicuous Konsumption<br /> 1535: Don't Touch Sandvich<br /> 1536: Borscht Belt<br /> 1537: Milestone 1<br /> 1538: Milestone 2<br /> 1539: Milestone 3<br /> &lt;/pre&gt;<br /> <br /> ===Scout Achievements===<br /> &lt;pre&gt;1001: First Blood<br /> 1002: First Blood, Part 2<br /> 1003: Quick Hook<br /> 1004: A Year to Remember<br /> 1005: The Cycle<br /> 1006: Closer<br /> 1007: If You Build it<br /> 1008: Gun Down<br /> 1009: Butter Up<br /> 1010: Doctoring the ball<br /> 1011: Dodgers 1, Giants 0<br /> 1012: Batting the Doctor<br /> 1013: I'm Bat Man<br /> 1014: Triple Steal<br /> 1015: Pop Fly<br /> 1016: Round-Tripper<br /> 1017: Artful Dodger<br /> 1018: Fall Classic<br /> 1019: Strike Zone<br /> 1020: Foul Territory<br /> 1021: The Big Hurt<br /> 1022: Brushback<br /> 1023: Moon Shot<br /> 1024: Beanball<br /> 1025: Retire the Runner<br /> 1026: Caught Napping<br /> 1027: Side Retired<br /> 1028: Triple Play<br /> 1029: Stealing Home<br /> 1030: Set the Table<br /> 1031: Block the Plate<br /> 1032: Belittled Beleaguer<br /> 1033: No-Hitter<br /> 1034: Race for the Pennant<br /> 1035: Out of the Park<br /> 1036: Milestone 1<br /> 1037: Milestone 2<br /> 1038: Milestone 3<br /> &lt;/pre&gt;<br /> <br /> ===Sniper Achievements===<br /> &lt;pre&gt;<br /> 1101: Rode Hard, Put Away Wet<br /> 1102: Be polite<br /> 1103: Be Efficient<br /> 1104: Have a Plan<br /> 1105: Kill Everyone You Meet<br /> 1106: Triple Prey<br /> 1107: Self-Destruct Sequence<br /> 1108: De-sentry-lized<br /> 1109: Shoot the Breeze<br /> 1110: Dropped Dead<br /> 1111: the last wave<br /> 1112: australian rules<br /> 1113: Kook the Spook<br /> 1114: Socket to Him<br /> 1115: Jumper Stumper<br /> 1116: Not a Crazed Gunman, Dad<br /> 1117: Trust Your Feelings<br /> 1118: Überectomy<br /> 1119: Consolation Prize<br /> 1120: Enemy at the Gate<br /> 1121: Parting Shot<br /> 1122: My Brilliant Career<br /> 1123: Shock Treatment<br /> 1124: Saturation Bombing<br /> 1125: Rain on Their Parade<br /> 1126: Jarring Transition<br /> 1127: Friendship is Golden<br /> 1128: William Tell Overkill<br /> 1129: Beaux and Arrows<br /> 1130: Robbin’ Hood<br /> 1131: Pincushion<br /> 1132: Number One Assistant<br /> 1133: Jarate Chop<br /> 1134: Shafted<br /> 1135: Dead Reckoning<br /> &lt;/pre&gt;<br /> <br /> ===Spy Achievements===<br /> &lt;pre&gt;<br /> 1701: Triplecrossed<br /> 1702: For Your Eyes Only<br /> 1703: Counter Espionage<br /> 1704: Identity Theft<br /> 1705: The Man from P.U.N.C.T.U.R.E.<br /> 1706: FYI I am a Spy<br /> 1707: The Man with the Broken Guns<br /> 1708: Sapsucker<br /> 1709: May I Cut In?<br /> 1710: Agent Provocateur<br /> 1711: The Melbourne Supremacy<br /> 1712: Spies Like Us<br /> 1713: A Cut Above<br /> 1714: Burn Notice<br /> 1715: Die Another Way<br /> 1716: Constructus Interruptus<br /> 1717: On Her Majesty’s Secret Surface<br /> 1718: Insurance Fraud<br /> 1719: Point Breaker<br /> 1720: High Value Target<br /> 1721: Come in From the Cold<br /> 1722: Wetwork<br /> 1723: You Only Shiv Thrice<br /> 1724: Spymaster<br /> 1725: Sap Auteur<br /> 1726: Joint Operation<br /> 1727: Dr. Nooooo<br /> 1728: Is It Safe?<br /> 1729: Slash and Burn<br /> 1730: Biplomacy<br /> 1731: Skullpluggery<br /> 1732: Sleeper Agent<br /> 1733: Who's Your Daddy?<br /> 1734: Deep Undercover<br /> &lt;/pre&gt;<br /> <br /> ===Halloween Event Achievements===<br /> &lt;pre&gt;<br /> 1901: Candy Cornoner<br /> 1902: Ghastly Gibus Grab<br /> 1903: Scared Stiff<br /> 1904: Attack 'o Latern<br /> 1905: Costume Contest<br /> &lt;/pre&gt;</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Writing_Extensions&diff=7320 2009-07-14T17:31:14Z

<p>Pheadxdll: </p> <hr /> <div>SourceMod's Extension System is a powerful way to greatly enhance the flexibility of your SourceMod plugins. You can take full advantage of SourceMod's Core, using the interfaces it provides, to create C++ plugins, plugin events, plugin native functions, and shared interfaces. Extensions can also hook into Metamod:Source.<br /> <br /> This article goes into the details of creating a SourceMod Extension. Knowledge of C++ is required.<br /> <br /> =SDK Structure=<br /> First, download the [[SourceMod SDK]] from the [[SourceMod]] website. The directory structure looks like this:<br /> *&lt;tt&gt;extensions&lt;/tt&gt;<br /> **&lt;tt&gt;geoip/&lt;/tt&gt; - Source code to the GeoIP extension<br /> **&lt;tt&gt;mysql/&lt;/tt&gt; - Source code to the MySQL extension<br /> **&lt;tt&gt;threader/&lt;/tt&gt; - Source code to the Threader extension<br /> *&lt;tt&gt;plugins/&lt;/tt&gt; - Source code to all of SourceMod's plugins<br /> **&lt;tt&gt;include/&lt;/tt&gt; - The include files which document plugin API<br /> *&lt;tt&gt;public/&lt;/tt&gt; - Interface files for SourceMod's Core Interfaces<br /> **&lt;tt&gt;extensions/&lt;/tt&gt; - Interfaces that are provided by extensions<br /> **&lt;tt&gt;sample_ext/&lt;/tt&gt; - The Sample Extension SDK<br /> **&lt;tt&gt;sourcepawn&lt;/tt&gt; - The include/interface files for SourcePawn<br /> *&lt;tt&gt;sourcepawn/&lt;/tt&gt;<br /> **&lt;tt&gt;compiler/&lt;/tt&gt; - The SourcePawn Compiler<br /> <br /> <br /> =Starting an Extension=<br /> For simplicity, this article will assume you are using the SDK base files. These are:<br /> *&lt;tt&gt;sdk/smsdk_config.h&lt;/tt&gt; - Configuration settings (we will be editing this)<br /> *&lt;tt&gt;sdk/smsdk_ext.h&lt;/tt&gt; - Header for SDK wrappers (usually never needs to be edited)<br /> **''Note: Sometimes, this may be updated by the SourceMod Dev Team. Using a newest version is recommended.'<br /> *&lt;tt&gt;sdk/smsdk_ext.cpp&lt;/tt&gt; - Source for SDK wrappers (usually never needs to be edited)<br /> **''Note: Sometimes, this may be updated by the SourceMod Dev Team. Using a newest version is recommended.'<br /> *&lt;tt&gt;extension.h&lt;/tt&gt; - User file for main extension header<br /> *&lt;tt&gt;extension.cpp&lt;/tt&gt; - User file for main extension code<br /> <br /> ''The &lt;tt&gt;extension.*&lt;/tt&gt; files are not technically part of the SDK. However, they are provided to give users a starting point and some documentation.''<br /> <br /> <br /> '''Note:''' For help setting up Visual Studio, please see [[#Setting up Visual Studio|Setting up Visual Studio]].<br /> <br /> <br /> The first step of creating your extension is to configure it. Open the &lt;tt&gt;smsdk_config.h&lt;/tt&gt; file and edit each of the following defines. Use the information below to guide you.<br /> *&lt;tt&gt;SMEXT_CONF_NAME&lt;/tt&gt; - The general name for your Extension (should be short).<br /> *&lt;tt&gt;SMEXT_CONF_DESCRIPTION&lt;/tt&gt; - A short description of what your extension does.<br /> *&lt;tt&gt;SMEXT_CONF_VERSION&lt;/tt&gt; - A version number string. By convention, SourceMod uses the four set build number notation. I.e. for 1.2.3.4:<br /> **&lt;tt&gt;1&lt;/tt&gt; is the &quot;Major&quot; release version.<br /> **&lt;tt&gt;2&lt;/tt&gt; is the &quot;Minor&quot; release version.<br /> **&lt;tt&gt;3&lt;/tt&gt; is the &quot;Maintenance&quot; or &quot;Revision&quot; version.<br /> **&lt;tt&gt;4&lt;/tt&gt; is the &quot;Build,&quot; usually an internal source control number.<br /> *&lt;tt&gt;SMEXT_CONF_AUTHOR&lt;/tt&gt; - Your name (or whoever/whatever authored the plugin).<br /> *&lt;tt&gt;SMEXT_CONF_URL&lt;/tt&gt; - The URL/homepage of this extension.<br /> *&lt;tt&gt;SMEXT_CONF_LOGTAG&lt;/tt&gt; - The logtag your extension will use for SourceMod logging. By convention, try to keep this under ten characters or so, and to make it all caps.<br /> *&lt;tt&gt;SMEXT_CONF_LICENSE&lt;/tt&gt; - Right now, the SourceMod Dev Team mandates that 3rd party extensions must be under an Open Source license. Putting a license abbreviation or very short message here is appropriate. For more information, see [[SourceMod License]].<br /> *&lt;tt&gt;SMEXT_CONF_DATESTRING&lt;/tt&gt; - You do not need to modify this.<br /> *&lt;tt&gt;SMEXT_CONF_METAMOD&lt;/tt&gt; - If your plugin requires using SourceHook or Metamod:Source, uncomment this line.<br /> <br /> <br /> Next, you may want to change the name of the default class that &lt;tt&gt;extension.h&lt;/tt&gt; declares. To do this...<br /> &lt;ul&gt;&lt;li&gt;Open &lt;tt&gt;extension.h&lt;/tt&gt; and change &quot;Sample&quot; in this line:<br /> &lt;cpp&gt;class Sample : public SDKExtension&lt;/cpp&gt;&lt;/li&gt;<br /> &lt;li&gt;Open &lt;tt&gt;extension.cpp&lt;/tt&gt; and change the two lines to correspond to your new class name. You can also change the global singleton that's declared, although you cannot remove the &lt;tt&gt;SMEXT_LINK&lt;/tt&gt; line (this lets SourceMod load your extension).&lt;/li&gt;<br /> &lt;/ul&gt;<br /> <br /> <br /> ==Visual Studio Users==<br /> Make sure you change the name of your &lt;tt&gt;.dll&lt;/tt&gt; file. The naming convention for SourceMod extensions is &lt;tt&gt;name.ext.dll&lt;/tt&gt;, where &lt;tt&gt;name&lt;/tt&gt; is a short name for your extension. You are free to change this, but it is highly recommended that you keep the &lt;tt&gt;.ext.dll&lt;/tt&gt; intact.<br /> <br /> You can do this by going to &lt;tt&gt;Project&lt;/tt&gt; -&gt; &lt;tt&gt;Properties&lt;/tt&gt; -&gt; &lt;tt&gt;Configuration Properties&lt;/tt&gt; -&gt; &lt;tt&gt;Linker&lt;/tt&gt; -&gt; &lt;tt&gt;General&lt;/tt&gt;. Set the &lt;tt&gt;Output File&lt;/tt&gt; option appropriately.<br /> <br /> ==Linux Users==<br /> Simply edit the &lt;tt&gt;Makefile&lt;/tt&gt; and change the &lt;tt&gt;BINARY&lt;/tt&gt; line near the top. Make sure you do not add any trailing spaces at the end of the name, or the build won't come out right.<br /> <br /> You should now be able to compile a blank extension!<br /> <br /> <br /> =Creating Native Functions=<br /> ''Main article: [[Natives (SourceMod Development)]]''<br /> <br /> Most of the time, an extension exists to add &quot;native functions&quot; to the plugin system. Native functions are simply the functions that plugins can use in SourceMod. They are coded in C++ and have a short prototype declaration in an include file.<br /> <br /> ==Prototyping==<br /> The first step to creating a native is to &lt;tt&gt;spec it&lt;/tt&gt;, or &lt;tt&gt;prototype&lt;/tt&gt; it. This is a simple but often time consuming process, but if you get in the habit of it, your documentation will be much better. Let's first create a very simply native. Here is a prototype for it, which we will place in &lt;tt&gt;sample.inc&lt;/tt&gt;:<br /> &lt;pawn&gt;/**<br /> * Returns the square of a number.<br /> *<br /> * @param num Number to square.<br /> * @return The square of num.<br /> */<br /> native SquareNumber(num);&lt;/pawn&gt;<br /> <br /> The &lt;tt&gt;native&lt;/tt&gt; keyword tells the compiler that this function exists in an outside source. The comment style is similar to [http://www.stack.nl/~dimitri/doxygen/ doxygen] or [http://java.sun.com/j2se/javadoc/ Javadoc], and is preferred by the SourceMod Development Team.<br /> <br /> ==Implementing==<br /> Now that our function is documented, it's time to create it! Each native function is bound to a C++ function. The prototype for this function looks like:<br /> &lt;cpp&gt;cell_t Function(IPluginContext *pContext, const cell_t *params);&lt;/cpp&gt;<br /> <br /> A quick explanation of these types:<br /> *&lt;tt&gt;cell_t&lt;/tt&gt; - This is a 32bit signed integer, the generic data type for Pawn.<br /> *&lt;tt&gt;IPluginContext&lt;/tt&gt; - This interface provides Virtual Machine functions for retrieving or modifying memory in the plugin.<br /> *&lt;tt&gt;params&lt;/tt&gt; - This is the &quot;stack&quot; of parameters that the plugin passed. It is an array from [0..N] where 0 contains N. <br /> **For example, if one parameter was passed, and the parameter is 25:<br /> ***&lt;tt&gt;params[0]&lt;/tt&gt; == 1<br /> ***&lt;tt&gt;params[1]&lt;/tt&gt; == 25<br /> **Even though it tells you how many parameters are passed, you do not need to verify this number. The compiler will always pass the correct number of parameters in. The only time you need to verify it is for backwards compatibility or variable parameter lists, which will be discussed later.<br /> <br /> Now, let's write our native function:<br /> &lt;cpp&gt;cell_t SquareNumber(IPluginContext *pContext, const cell_t *params)<br /> {<br /> cell_t number = params[1];<br /> return number * number;<br /> }&lt;/cpp&gt;<br /> <br /> ==Binding==<br /> Now, the final step is to bind our native. Natives are bound in ''native lists''. Each list must be terminated by a &lt;tt&gt;NULL&lt;/tt&gt; bind. Example:<br /> &lt;cpp&gt;const sp_nativeinfo_t MyNatives[] = <br /> {<br /> {&quot;SquareNumber&quot;, SquareNumber},<br /> {NULL, NULL},<br /> };&lt;/cpp&gt;<br /> <br /> The first column/member is a string containing the name you've assigned to the native. The second column/member is the C++ function you're binding to. Here, both contain the same name, but it is certainly possible to bind a function to any valid Pawn function name, and likewise, you can bind one function to more than one name.<br /> <br /> Lastly, you must tell Core about your native list. There are two places that are good to do this. Whichever you choose, you must uncomment the function in &lt;tt&gt;extension.h&lt;/tt&gt; and implement it in &lt;tt&gt;extension.cpp&lt;/tt&gt;.<br /> *&lt;tt&gt;SDK_OnLoad&lt;/tt&gt; - This is called when your extension is first loaded. If you do not require any outside interfaces, it is safe to add natives here.<br /> *&lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt; - This is called when all extensions have been loaded. This is generally a better place to add natives.<br /> <br /> Let's say we choose &lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt;, we'd then have code like this:<br /> &lt;cpp&gt;void Sample::SDK_OnAllLoaded()<br /> {<br /> sharesys-&gt;AddNatives(myself, MyNatives);<br /> }&lt;/cpp&gt;<br /> ''Note: &lt;tt&gt;myself&lt;/tt&gt; is a global variable declared in the SDK. It is a pointer that identifies your extension.''<br /> <br /> For more information on writing natives, see [[Natives (SourceMod Development)]].<br /> <br /> <br /> =Creating Events/Forwards=<br /> Events are an integral part to SourceMod. An Event is formally called a ''Forward''. Forwards are functions inside a plugin which are not called by the plugin itself, but are triggered from an external source. For example, &lt;tt&gt;OnClientConnect&lt;/tt&gt; is a forward which is triggered when a player connects to a server.<br /> <br /> There are two major types of forwards:<br /> *'''Managed''': This forward is global and has a name. To use this forward, the function must be declared as &lt;tt&gt;public&lt;/tt&gt; inside the user's script. Any plugin having this public function will receive the event.<br /> *'''Unmanaged''': This forward is private in nature. For example, the &lt;tt&gt;HookUserMessage&lt;/tt&gt; native lets users specify a function to be called when a specific user message is sent. This is done with an unmanaged forward, and adding functions to this forward is not automatic. In general, function calls for unmanaged forwards are not public, although they can be.<br /> <br /> ''Note: To enable the Forward interface, you must uncomment the definition &lt;tt&gt;SMEXT_ENABLE_FORWARDSYS&lt;/tt&gt; in smsdk_config.h.''<br /> ==Managed Forwards==<br /> Let's say we want to create a forward that will be called when a player uses say chat. For simplicity, let's assume you already have a function that tells you when a player says say chat. We will just be creating the forward for it.<br /> <br /> As we did before, first let's prototype our global forward. In our include file, we add this:<br /> &lt;pawn&gt;/**<br /> * @brief Called whenever a client says something in chat.<br /> *<br /> * @param client Index of the client.<br /> * @param text String containing the say text.<br /> * @return Pl_Handled to block text from printing, Pl_Continue otherwise.<br /> */<br /> forward ResultType:OnPlayerSayChat(client, const String:text[]);&lt;/pawn&gt;<br /> <br /> The &lt;tt&gt;forward&lt;/tt&gt; keyword tells the compiler that any function having this name must be declared exactly the same. In a plugin, this would<br /> <br /> The next step is to declare your forward somewhere at the top of your &lt;tt&gt;extension.cpp&lt;/tt&gt; file. This will look like:<br /> &lt;cpp&gt;IForward *g_pSayChat = NULL&lt;/cpp&gt;<br /> <br /> Next, re-using our code from above, let's create this forward in &lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt;:<br /> &lt;cpp&gt;void Sample::SDK_OnAllLoaded()<br /> {<br /> sharesys-&gt;AddNatives(myself, MyNatives);<br /> g_pSayChat = forwards-&gt;CreateForward(&quot;OnPlayerSayChat&quot;, ET_Event, 2, NULL, Param_Cell, Param_String);<br /> }&lt;/cpp&gt;<br /> <br /> Explanation of parameters:<br /> *&lt;tt&gt;&quot;OnPlayerSayChat&quot;&lt;/tt&gt; - The name of our forward.<br /> *&lt;tt&gt;ET_Event&lt;/tt&gt; - Since forwards can execute multiple functions in multiple scripts, this is one of the ways of specifying what to do with the return value of each function. &lt;tt&gt;ET_Event&lt;/tt&gt; means &quot;return the highest value, do not allow stops.&quot; A stop refers to &lt;tt&gt;Pl_Stop&lt;/tt&gt;, which lets a plugin block the rest of the event chain.<br /> *&lt;tt&gt;2&lt;/tt&gt; - This is the number of parameters our forward will have.<br /> *&lt;tt&gt;NULL&lt;/tt&gt; - Not used in our example. This lets you pass parameters by array rather than variable arguments.<br /> *&lt;tt&gt;Param_Cell&lt;/tt&gt; - The first parameter is a cell (integer).<br /> *&lt;tt&gt;Param_String&lt;/tt&gt; - The second parameter is a string.<br /> <br /> Now, we write a quick function in our module to call this forward:<br /> &lt;cpp&gt;/** Fires the say chat event in plugins. Returns true to allow the text, false to block. */<br /> bool FireChatEvent(int client, const char *text)<br /> {<br /> if (!g_pSayChat)<br /> {<br /> return true;<br /> }<br /> <br /> cell_t result = 0;<br /> g_pSayChat-&gt;PushCell(client);<br /> g_pSayChat-&gt;PushString(text);<br /> g_pSayChat-&gt;Execute(&amp;result);<br /> <br /> if (result == Pl_Handled)<br /> {<br /> return false;<br /> }<br /> <br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> As you can see, this was pretty simple. Each parameter is &quot;pushed&quot; one at a time, in ascending order. First we push the client index as a cell, then the text as a string. Once done, we execute, and the value will be returned by reference.<br /> <br /> Lastly, there is a caveat. Unlike natives, SourceMod does not automatically clean up forwards for us when are done. We have to make sure we destroy them. Uncomment &lt;tt&gt;SDK_OnUnload&lt;/tt&gt; from &lt;tt&gt;extension.h&lt;/tt&gt; and implement it like so:<br /> &lt;cpp&gt;void Sample::SDK_OnUnload()<br /> {<br /> forwards-&gt;ReleaseForward(g_pSayChat);<br /> }&lt;/cpp&gt;<br /> <br /> ==Unmanaged Forwards==<br /> Now things get a bit more complicated. However, unmanaged forwards are essentially the same -- they just give you more flexibility. Let's consider the managed example with a new twist. We want to let users add and remove hooks from their plugins, rather than having one global forward. The standard way to do this is with ''function IDs''. <br /> <br /> Example prototype:<br /> &lt;pawn&gt;funcenum SayChatHook<br /> {<br /> forward(client, const String:text[]);<br /> }<br /> <br /> native AddSayChatHook(SayChatHook:hook);<br /> native RemoveSayChatHook(SayChatHook:hook);&lt;/pawn&gt;<br /> <br /> The &lt;tt&gt;funcenum&lt;/tt&gt; syntax lets you define all the valid prototypes for your hook. In this example, the only valid method is a function declared like this (only MyHook can be changed):<br /> &lt;pawn&gt;MyHook(client, const String:text[])&lt;/pawn&gt;<br /> <br /> How do we make such a beast? The first step is setting up our forward.<br /> &lt;cpp&gt;IChangeableForward *g_pSayChat = NULL;<br /> /* ... */<br /> void Sample::SDK_OnAllLoaded()<br /> {<br /> g_pSayChat = forwards-&gt;CreateForwardEx(NULL, ET_Hook, 2, NULL, Param_Cell, Param_String); <br /> }&lt;/cpp&gt;<br /> <br /> Notice two big differences. We now use &lt;tt&gt;IChangeableForward&lt;/tt&gt; instead of &lt;tt&gt;IForward&lt;/tt&gt;, and we use &lt;tt&gt;CreateForwardEx&lt;/tt&gt; instead. The initial first parameter specifies a name for our forward - we're going to ignore this.<br /> <br /> Now, we need to create our natives. These will be fairly simple:<br /> &lt;cpp&gt;cell_t AddSayChatHook(IPluginContext *pContext, const cell_t *params)<br /> {<br /> g_pSayChat-&gt;AddFunction(pContext, static_cast&lt;funcid_t&gt;(params[1]));<br /> return 1;<br /> }<br /> <br /> cell_t RemoveSayChatHook(IPluginContext *pContext, const cell_t *params)<br /> {<br /> IPluginFunction *pFunction = pContext-&gt;GetFunctionById(static_cast&lt;funcid_t&gt;(params[1]));<br /> g_pSayChat-&gt;RemoveFunction(pFunction);<br /> return 1;<br /> }&lt;/cpp&gt;<br /> ''Note: These natives must be added -- that step is removed here and explained earlier.''<br /> <br /> You do not need to worry about a plugin unloading - Core will automatically remove the functions for you. Since an &lt;tt&gt;IChangeableForward&lt;/tt&gt; is also an &lt;tt&gt;IForward&lt;/tt&gt;, the &lt;tt&gt;FireChatEvent&lt;/tt&gt; function from earlier does not need to change. We're done!<br /> <br /> ==Creating Interfaces==<br /> Do you want your extension to share an interface? If so, first you should create an ''interface file''. This file should contain everything your interface needs - this way other authors can easily reference it. Your interface must inherit the &lt;tt&gt;SMInterface&lt;/tt&gt; class. It must also declare two global macros that uniquely identify your interface. It must also implement two functions: &lt;tt&gt;GetInterfaceName&lt;/tt&gt; and &lt;tt&gt;GetInterfaceVersion&lt;/tt&gt;.<br /> <br /> The two defines must start with &lt;tt&gt;SMINTERFACE_&lt;/tt&gt; and end with &lt;tt&gt;_NAME&lt;/tt&gt; and &lt;tt&gt;_VERSION&lt;/tt&gt; respectively. The first must be a string and the second must be an unsigned integer. This integer represents your interface's version number. While you are free to use it however you please, by default it should be linearly increased. If you make breaking changes or change the versioning scheme, you must overload the &lt;tt&gt;IsVersionCompat&lt;/tt&gt; function in &lt;tt&gt;SMInterface&lt;/tt&gt;.<br /> <br /> Example:<br /> &lt;cpp&gt;#ifndef _INCLUDE_MYINTERFACE_FILE_H_<br /> #define _INCLUDE_MYINTERFACE_FILE_H_<br /> <br /> #include &lt;IShareSys.h&gt;<br /> <br /> #define SMINTERFACE_MYINTERFACE_NAME &quot;IMyInterface&quot;<br /> #define SMINTERFACE_MYINTERFACE_VERSION 1<br /> <br /> class IMyInterface : public SourceMod::SMInterface<br /> {<br /> public:<br /> virtual const char *GetInterfaceName()<br /> {<br /> return SMINTERFACE_MYINTERFACE_NAME;<br /> }<br /> virtual unsigned int GetInterfaceVersion()<br /> {<br /> return SMINTERFACE_MYINTERFACE_VERSION;<br /> }<br /> public:<br /> /**<br /> * @brief This function does nothing.<br /> */<br /> virtual void DoNothingAtAll() =0;<br /> };<br /> <br /> #endif //_INCLUDE_MYINTERFACE_FILE_H_&lt;/cpp&gt;<br /> <br /> Notice, of course, that our interface is ''pure virtual''. This means it must be implemented in the extension. Assuming you know C++, this should be fairly straight forward, so let's skip right to how to add this interface to the SourceMod shared system:<br /> &lt;cpp&gt;bool Sample::SDK_OnLoad(char *error, size_t err_max, bool late)<br /> {<br /> sharesys-&gt;AddInterface(myself, &amp;g_MyInterface);<br /> return true;<br /> }&lt;/cpp&gt;<br /> ''Note: We do this in &lt;tt&gt;SDK_OnLoad()&lt;/tT&gt; instead of &lt;tt&gt;SDK_OnAllLoaded()&lt;/tt&gt;. Otherwise, an extension might try to search for your interface during &lt;tt&gt;SDK_OnAllLoaded()&lt;/tt&gt;, and it might fail depending on the load order.''<br /> <br /> That simple? Yup! Now other extensions can use your interface. <br /> <br /> <br /> =Using Interfaces/Other Extensions=<br /> There are a variety of interfaces that are available, but not loaded by default in the Extension SDK. These interfaces can be retrieved and used in your extension.<br /> <br /> ==Core Interfaces==<br /> If they are provided by Core, getting them is very simple. Many interfaces can simply be uncommented in &lt;tt&gt;smsdk_config.h&lt;/tt&gt; and they will become usable. See the &quot;Available Interfaces&quot; list below for the exposure list.<br /> <br /> Otherwise, most of the &lt;tt&gt;.h&lt;/tt&gt; interface files in the root of the &lt;tt&gt;public&lt;/tt&gt; folder in the SDK are Core interfaces. For example, code to use the IPluginManager interface might look like this:<br /> &lt;cpp&gt;#include &lt;IPluginSys.h&gt;<br /> <br /> IPluginManager *g_pPlugins = NULL;<br /> <br /> bool Sample::SDK_OnLoad(char *error, size_t err_max, bool late)<br /> {<br /> SM_GET_IFACE(PLUGINSYSTEM, g_pPlugins);<br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> Where did we get &lt;tt&gt;PLUGINSYSTEM&lt;/tt&gt; from? Observe the two lines in &lt;tt&gt;IPluginSys.h&lt;/tt&gt;:<br /> &lt;cpp&gt;#define SMINTERFACE_PLUGINSYSTEM_NAME &quot;IPluginManager&quot;<br /> #define SMINTERFACE_PLUGINSYSTEM_VERSION 1&lt;/cpp&gt;<br /> <br /> The &lt;tt&gt;SM_GET_IFACE&lt;/tt&gt; macro uses the text in between the &lt;tt&gt;SMINTERFACE_&lt;/tt&gt; and the &lt;tt&gt;_NAME&lt;/tt&gt; characters. It also uses the version for compatibility checking. If it can't find the interface, it automatically prints to the error buffer and returns false.<br /> <br /> ===Default Interfaces===<br /> There are interfaces which are grabbed by the Extension SDK by default. You do not need to query for them on load, or even check if they are valid or not. They are:<br /> *&lt;tt&gt;IShareSys&lt;/tt&gt; - Exposed as &lt;tt&gt;sharesys&lt;/tt&gt;, found in &lt;tt&gt;IShareSys.h&lt;/tt&gt;<br /> *&lt;tt&gt;HANDLESYSTEM&lt;/tt&gt; - Exposed as &lt;tt&gt;handlesys&lt;/tt&gt;, found in &lt;tt&gt;IHandleSys.h&lt;/tt&gt;<br /> *&lt;tt&gt;SOURCEMOD&lt;/tt&gt; - Exposed as &lt;tt&gt;g_pSM&lt;/tt&gt;, found in &lt;tt&gt;ISourceMod.h&lt;/tt&gt;<br /> *&lt;tt&gt;FORWARDMANAGER&lt;/tt&gt; - Exposed as &lt;tt&gt;forwards&lt;/tt&gt;, found in &lt;tt&gt;IForwardSys.h&lt;/tt&gt;<br /> <br /> ===Available Interfaces===<br /> *&lt;tt&gt;SMEXT_ENABLE_FORWARDSYS&lt;/tt&gt;: &lt;tt&gt;forwards&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_HANDLESYS&lt;/tt&gt;: &lt;tt&gt;handlesys&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_PLAYERHELPERS&lt;/tt&gt;: &lt;tt&gt;playerhelpers&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_DBMANAGER&lt;/tt&gt;: &lt;tt&gt;dbi&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_GAMECONF&lt;/tt&gt;: &lt;tt&gt;gameconfs&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_MEMUTILS&lt;/tt&gt;: &lt;tt&gt;memutils&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_GAMEHELPERS&lt;/tt&gt;: &lt;tt&gt;gamehelpers&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_TIMERSYS&lt;/tt&gt;: &lt;tt&gt;timersys&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_THREADER&lt;/tt&gt;: &lt;tt&gt;threader&lt;/tt&gt;<br /> <br /> ==External Interfaces==<br /> The situation changes if your extension requires ''another extension'', since extensions may load in a completely random order. The first step is to mark the other extension as a dependency. Let's say you want to use the &lt;tt&gt;IThreader.h&lt;/tt&gt; interfaces from &lt;tt&gt;threader.ext.dll&lt;/tt&gt;. First, we declare it as such:<br /> <br /> &lt;cpp&gt;bool Sample::SDK_OnLoad(char *error, size_t err_max, bool late)<br /> {<br /> sharesys-&gt;AddDependency(myself, &quot;thread.ext&quot;, true, true);<br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> The two boolean parameters to &lt;tt&gt;AddDependency&lt;/tt&gt; mean, respectively: &quot;try to automatically load this extension&quot; and &quot;this extension cannot work without the dependency.&quot;<br /> <br /> Second, we query for the interface in &lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt;. Since we don't know when &lt;tt&gt;thread.ext&lt;/tt&gt; will actually be loaded, we have to wait until everything is definitely loaded.<br /> &lt;cpp&gt;IThreader *g_pThreader = NULL;<br /> /* ... */<br /> void Sample::SDK_OnAllLoaded()<br /> {<br /> SM_GET_LATE_IFACE(THREADER, g_pThreader);<br /> }&lt;/cpp&gt;<br /> <br /> Third, we need to find a way to fail if this interface was never found. The way to do this is by uncommenting &lt;tt&gt;QueryRunning&lt;/tt&gt; from &lt;tt&gt;extension.h&lt;/tt&gt; and implementing it:<br /> &lt;cpp&gt;bool Sample::QueryRunning(char *error, size_t err_max)<br /> {<br /> SM_CHECK_IFACE(THREADER, g_pThreader);<br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> When SourceMod queries your extension, the macro above will either validate the pointer or return false. If it returns false, SourceMod marks your extension as failed.<br /> <br /> ==Caveats==<br /> ===NULL Interfaces===<br /> There are a few ways that external interfaces can make your code complicated. The first is simple but a common oversight. Don't assume interfaces will be okay. For example, say we want to create a thread once we get the &lt;tt&gt;IThreader&lt;/tt&gt; interface. Our code should something like this:<br /> <br /> &lt;cpp&gt;void Sample::SDK_OnAllLoaded()<br /> {<br /> SM_GET_IFACE(THREADER, g_pThreader);<br /> <br /> if (QueryRunning(NULL, 0))<br /> {<br /> g_pThreader-&gt;MakeThread(/* stuff */);<br /> }<br /> }&lt;/cpp&gt;<br /> <br /> Note that we ''query ourself'' in order to find if it's safe to continue executing code. We could also have simply checked if &lt;tt&gt;g_pThreader&lt;/tt&gt; is &lt;tt&gt;NULL&lt;/tt&gt;, but self-querying has a bonus: if your extension continues to do things like hook events or add listeners, you will be preventing your extension from entirely initializing itself while one interface is bad. Always make sure you have sanity checks like this where needed.<br /> <br /> ===Dynamic Unloading===<br /> The second major caveat is that extensions can be dynamically unloaded. If you specified yourself as having a dependency and that each dependency is required, you will have no problem. Your extension will be unloaded before the interface is removed, and you can clean up memory/hooks in your &lt;tt&gt;SDK_OnUnload()&lt;/tt&gt; code. There are two situations where this is a different story.<br /> <br /> ====Optional Interfaces====<br /> The first situation is if you are not requiring an extension that contains an interface. Now, when the extension unloads, your extension will not be unloaded first. This creates a small problem, as you must clean up without being unloaded. There are two functions you can implement in your extension class to resolve this, both documented in &lt;tt&gt;IExtensionSys.h&lt;/tt&gt;:<br /> *&lt;tt&gt;QueryInterfaceDrop&lt;/tt&gt; - Allows you to request unloading when a specific interface is unloaded. This is the default behavior for all interfaces. If you want to block this functionality, continue reading.<br /> *&lt;tt&gt;NotifyInterfaceDrop&lt;/tt&gt; - This is called when an interface is dropped. If your plugin will not be unloaded, you can use this to clean up any resources on a specific interface being removed.<br /> <br /> ====Circular Dependencies====<br /> The second situation is a bit more complicated. It is possible for two extensions to have circular dependencies. For example:<br /> *Extension &quot;A&quot; requires extension &quot;B.&quot;<br /> *Extension &quot;B&quot; requires extension &quot;A.&quot;<br /> <br /> If either extension is unloaded, the opposite extension is unloaded normally. The first extension then receives the interface drop callbacks. In this situation, it is essential that the &lt;tt&gt;NotifyInterfaceDrop&lt;/tt&gt; function be implemented and used with the circular interface. Otherwise, you risk crashing when your extension unloads (or at the very least, leaking memory). Since the actual drop order is undefined, it means both extensions must implement this function to be safe.<br /> <br /> <br /> =Automatic Loading=<br /> There are two types of automatic loading: Dynamic and Global. Dynamic loading means your extension is only loaded when a plugin requires it. Global loading means your extension loads no matter what.<br /> <br /> ==Dynamic Autoloading==<br /> Dynamic loading requires that you create an include file for plugins. Plugins that include your file will automatically load your extension. This requires implementing the &lt;tt&gt;Extension&lt;/tt&gt; structure found in &lt;tt&gt;core.inc&lt;/tt&gt;. You must expose the structure as &lt;tt&gt;public&lt;/tt&gt;, and the name must start with &quot;&lt;tt&gt;__ext_&lt;/tt&gt;&quot;.<br /> <br /> &lt;pawn&gt;/**<br /> * Do not edit below this line!<br /> */<br /> public Extension:__ext_geoip = <br /> {<br /> name = &quot;GeoIP&quot;,<br /> file = &quot;geoip.ext&quot;,<br /> #if defined AUTOLOAD_EXTENSIONS<br /> autoload = 1,<br /> #else<br /> autoload = 0,<br /> #endif<br /> #if defined REQUIRE_EXTENSIONS<br /> required = 1,<br /> #else<br /> required = 0,<br /> #endif<br /> };<br /> &lt;/pawn&gt;<br /> <br /> Explanations:<br /> *&lt;b&gt;name&lt;/b&gt;: The name of your module as written in &lt;tt&gt;SMEXT_CONF_NAME&lt;/tt&gt;.<br /> *&lt;b&gt;file&lt;/b&gt;: The platform-inspecific portion of your extension's file name.<br /> *&lt;b&gt;autoload&lt;/b&gt;: Specifies that your module should always dynamically autoload by default. You can tweak this to either never autoload or always autoload (without letting the user toggle).<br /> *&lt;b&gt;required&lt;/b&gt;: Specifies whether or not this extension is '''required''' by your plugin. If for some reason your extension fails to load (or is not found), the plugin will also fail to load. This is changeable if you wish to override the default behavior.<br /> <br /> You can copy and paste this example, but remember to modify the following portions:<br /> *&lt;b&gt;__ext_geoip&lt;/b&gt;: Change the &quot;geoip&quot; portion to your own unique variable name.<br /> *&lt;b&gt;&quot;GeoIP&lt;/b&gt;: Change the GeoIP portion to your extension's name. This should match the name you chose as &lt;tt&gt;SMEXT_CONF_NAME&lt;/tt&gt;.<br /> *&lt;b&gt;&quot;geoip.ext&quot;&lt;/b&gt;: Change this to your extension's file name, without the .dll/.so portion.<br /> <br /> <br /> ==Global Autoloading==<br /> To have your extension always autoload, you must create a ''.autoload'' file in the &lt;tt&gt;extensions&lt;/tt&gt; folder. For example, to have the &lt;tt&gt;threader.ext.dll&lt;/tt&gt; or &lt;tt&gt;threader.ext.so&lt;/tt&gt; extensions autoload, you'd create the following file in &lt;tt&gt;extensions&lt;/tt&gt;: &lt;tt&gt;threader.autoload&lt;/tt&gt;.<br /> <br /> A few notes:<br /> *This only works for extensions using the .ext.&lt;platform&gt; convention. SourceMod cuts off the &quot;.autoload&quot; portion of the file, then adds on &quot;.ext.dll&quot; or &quot;.ext.so&quot; which will not work on custom files.<br /> *The file does not need to contain anything, it simply needs to exist.<br /> <br /> <br /> =Conventions=<br /> <br /> ==Designing API/Natives==<br /> *Start interface names with the capital letter 'I'.<br /> *Use a consistent naming convention. SourceMod uses [http://msdn2.microsoft.com/en-us/library/ms229002.aspx Microsoft/Pascal] naming. Avoid Java/Camel casing for both API and natives.<br /> *When exposing interfaces, make sure your exposure defines start with &lt;tt&gt;SMINTERFACE_&lt;/tt&gt; and end with &lt;tt&gt;_NAME&lt;/tt&gt; and &lt;tt&gt;_VERSION&lt;/tt&gt;<br /> <br /> ==External Naming==<br /> *Logtags (&lt;tt&gt;SMEXT_CONF_LOGTAG&lt;/tt&gt;) should be short names (under 10 characters or so) in all capital letters.<br /> *Your extension file name should never have &lt;tt&gt;_i486&lt;/tt&gt; or other unnecessary platform-specific notations in its name.<br /> *Your extension file name should always end in &lt;tt&gt;.ext.so&lt;/tt&gt; or &lt;tt&gt;.ext.dll&lt;/tt&gt; depending on the platform. The &lt;tt&gt;.ext.&lt;/tt&gt; is SourceMod convention.<br /> <br /> <br /> =Setting up Visual Studio=<br /> ==Paths==<br /> '''Visual Studio 2003''': Tools -&gt; Options -&gt; Projects, VC++ Directories<br /> <br /> '''Visual Studio 2005''': Tools -&gt; Options -&gt; Projects and Solutions -&gt; VC++ Directories<br /> <br /> ===Include Paths===<br /> *SourceMod only:<br /> **sdk\public\extensions<br /> **sdk\public\sourcepawn<br /> **sdk\public<br /> *SourceMM (Note that sourcemm might be 'trunk' for you):<br /> **sourcemm\sourcemm<br /> **sourcemm\sourcehook<br /> **sourcemm<br /> *HL2SDK:<br /> **game_shared<br /> **public\vstdlib<br /> **public\tier1<br /> **public\tier0<br /> **public\engine<br /> **public\dlls<br /> **public<br /> **dlls<br /> <br /> ===Link Paths===<br /> *HL2SDK:<br /> **lib\public for version 2005<br /> **lib-vc7\public for version 2003<br /> <br /> ==Compiler Options==<br /> &lt;b&gt;Note:&lt;/b&gt; These options are set by default in the sample Extension SDK.&lt;br&gt;<br /> &lt;b&gt;Note:&lt;/b&gt; These options should be set for every build (Release/Debug/others).<br /> <br /> For VS 2005, goto Project-&gt;Properties.<br /> <br /> *General<br /> **&lt;tt&gt;Character Set&lt;/tt&gt;: '''Use Multi-Byte Character Set'''<br /> *C/C++<br /> **General<br /> ***&lt;tt&gt;Detect 64-bit Portability Issues&lt;/tt&gt;: '''No'''<br /> **Preprocessor<br /> ***&lt;tt&gt;Preprocessor Defines&lt;/tt&gt;: Add &lt;tt&gt;_CRT_SECURE_NO_DEPRECATE&lt;/tt&gt;, &lt;tt&gt;_CRT_NONSTDC_NO_DEPRECATE&lt;/tt&gt;, &lt;tt&gt;SOURCEMOD_BUILD&lt;/tt&gt; and &lt;tt&gt;WIN32&lt;/tt&gt;<br /> **Code Generation<br /> ***&lt;tt&gt;Runtime Library&lt;/tt&gt;: Multi-threaded or /MT (for Release), Multi-threaded Debug or /MTd (for Debug)<br /> *Linker<br /> **General<br /> ***&lt;tt&gt;Output File&lt;/tt&gt;: Change &lt;tt&gt;$(ProjectName)&lt;/tt&gt; to &lt;tt&gt;$(ProjectName).ext&lt;/tt&gt;, or use your own custom string.<br /> **Input<br /> ***&lt;tt&gt;Additional Dependencies&lt;/tt&gt;: &lt;tt&gt;tier0.lib tier1.lib vstdlib.lib&lt;/tt&gt; (for SourceMM attached extensions only)<br /> <br /> [[Category:SourceMod]]<br /> [[Category:SourceMod Development]]</div>

Pheadxdll https://wiki.alliedmods.net/index.php?title=Writing_Extensions&diff=6999 2009-03-06T03:54:47Z

<p>Pheadxdll: /* Compiler Options */</p> <hr /> <div>SourceMod's Extension System is a powerful way to greatly enhance the flexibility of your SourceMod plugins. You can take full advantage of SourceMod's Core, using the interfaces it provides, to create C++ plugins, plugin events, plugin native functions, and shared interfaces. Extensions can also hook into Metamod:Source.<br /> <br /> This article goes into the details of creating a SourceMod Extension. Knowledge of C++ is required.<br /> <br /> =SDK Structure=<br /> First, download the [[SourceMod SDK]] from the [[SourceMod]] website. The directory structure looks like this:<br /> *&lt;tt&gt;extensions&lt;/tt&gt;<br /> **&lt;tt&gt;geoip/&lt;/tt&gt; - Source code to the GeoIP extension<br /> **&lt;tt&gt;mysql/&lt;/tt&gt; - Source code to the MySQL extension<br /> **&lt;tt&gt;threader/&lt;/tt&gt; - Source code to the Threader extension<br /> *&lt;tt&gt;plugins/&lt;/tt&gt; - Source code to all of SourceMod's plugins<br /> **&lt;tt&gt;include/&lt;/tt&gt; - The include files which document plugin API<br /> *&lt;tt&gt;public/&lt;/tt&gt; - Interface files for SourceMod's Core Interfaces<br /> **&lt;tt&gt;extensions/&lt;/tt&gt; - Interfaces that are provided by extensions<br /> **&lt;tt&gt;sample_ext/&lt;/tt&gt; - The Sample Extension SDK<br /> **&lt;tt&gt;sourcepawn&lt;/tt&gt; - The include/interface files for SourcePawn<br /> *&lt;tt&gt;sourcepawn/&lt;/tt&gt;<br /> **&lt;tt&gt;compiler/&lt;/tt&gt; - The SourcePawn Compiler<br /> <br /> <br /> =Starting an Extension=<br /> For simplicity, this article will assume you are using the SDK base files. These are:<br /> *&lt;tt&gt;sdk/smsdk_config.h&lt;/tt&gt; - Configuration settings (we will be editing this)<br /> *&lt;tt&gt;sdk/smsdk_ext.h&lt;/tt&gt; - Header for SDK wrappers (usually never needs to be edited)<br /> **''Note: Sometimes, this may be updated by the SourceMod Dev Team. Using a newest version is recommended.'<br /> *&lt;tt&gt;sdk/smsdk_ext.cpp&lt;/tt&gt; - Source for SDK wrappers (usually never needs to be edited)<br /> **''Note: Sometimes, this may be updated by the SourceMod Dev Team. Using a newest version is recommended.'<br /> *&lt;tt&gt;extension.h&lt;/tt&gt; - User file for main extension header<br /> *&lt;tt&gt;extension.cpp&lt;/tt&gt; - User file for main extension code<br /> <br /> ''The &lt;tt&gt;extension.*&lt;/tt&gt; files are not technically part of the SDK. However, they are provided to give users a starting point and some documentation.''<br /> <br /> <br /> '''Note:''' For help setting up Visual Studio, please see [[#Setting up Visual Studio|Setting up Visual Studio]].<br /> <br /> <br /> The first step of creating your extension is to configure it. Open the &lt;tt&gt;smsdk_config.h&lt;/tt&gt; file and edit each of the following defines. Use the information below to guide you.<br /> *&lt;tt&gt;SMEXT_CONF_NAME&lt;/tt&gt; - The general name for your Extension (should be short).<br /> *&lt;tt&gt;SMEXT_CONF_DESCRIPTION&lt;/tt&gt; - A short description of what your extension does.<br /> *&lt;tt&gt;SMEXT_CONF_VERSION&lt;/tt&gt; - A version number string. By convention, SourceMod uses the four set build number notation. I.e. for 1.2.3.4:<br /> **&lt;tt&gt;1&lt;/tt&gt; is the &quot;Major&quot; release version.<br /> **&lt;tt&gt;2&lt;/tt&gt; is the &quot;Minor&quot; release version.<br /> **&lt;tt&gt;3&lt;/tt&gt; is the &quot;Maintenance&quot; or &quot;Revision&quot; version.<br /> **&lt;tt&gt;4&lt;/tt&gt; is the &quot;Build,&quot; usually an internal source control number.<br /> *&lt;tt&gt;SMEXT_CONF_AUTHOR&lt;/tt&gt; - Your name (or whoever/whatever authored the plugin).<br /> *&lt;tt&gt;SMEXT_CONF_URL&lt;/tt&gt; - The URL/homepage of this extension.<br /> *&lt;tt&gt;SMEXT_CONF_LOGTAG&lt;/tt&gt; - The logtag your extension will use for SourceMod logging. By convention, try to keep this under ten characters or so, and to make it all caps.<br /> *&lt;tt&gt;SMEXT_CONF_LICENSE&lt;/tt&gt; - Right now, the SourceMod Dev Team mandates that 3rd party extensions must be under an Open Source license. Putting a license abbreviation or very short message here is appropriate. For more information, see [[SourceMod License]].<br /> *&lt;tt&gt;SMEXT_CONF_DATESTRING&lt;/tt&gt; - You do not need to modify this.<br /> *&lt;tt&gt;SMEXT_CONF_METAMOD&lt;/tt&gt; - If your plugin requires using SourceHook or Metamod:Source, uncomment this line.<br /> <br /> <br /> Next, you may want to change the name of the default class that &lt;tt&gt;extension.h&lt;/tt&gt; declares. To do this...<br /> &lt;ul&gt;&lt;li&gt;Open &lt;tt&gt;extension.h&lt;/tt&gt; and change &quot;Sample&quot; in this line:<br /> &lt;cpp&gt;class Sample : public SDKExtension&lt;/cpp&gt;&lt;/li&gt;<br /> &lt;li&gt;Open &lt;tt&gt;extension.cpp&lt;/tt&gt; and change the two lines to correspond to your new class name. You can also change the global singleton that's declared, although you cannot remove the &lt;tt&gt;SMEXT_LINK&lt;/tt&gt; line (this lets SourceMod load your extension).&lt;/li&gt;<br /> &lt;/ul&gt;<br /> <br /> <br /> ==Visual Studio Users==<br /> Make sure you change the name of your &lt;tt&gt;.dll&lt;/tt&gt; file. The naming convention for SourceMod extensions is &lt;tt&gt;name.ext.dll&lt;/tt&gt;, where &lt;tt&gt;name&lt;/tt&gt; is a short name for your extension. You are free to change this, but it is highly recommended that you keep the &lt;tt&gt;.ext.dll&lt;/tt&gt; intact.<br /> <br /> You can do this by going to &lt;tt&gt;Project&lt;/tt&gt; -&gt; &lt;tt&gt;Properties&lt;/tt&gt; -&gt; &lt;tt&gt;Configuration Properties&lt;/tt&gt; -&gt; &lt;tt&gt;Linker&lt;/tt&gt; -&gt; &lt;tt&gt;General&lt;/tt&gt;. Set the &lt;tt&gt;Output File&lt;/tt&gt; option appropriately.<br /> <br /> ==Linux Users==<br /> Simply edit the &lt;tt&gt;Makefile&lt;/tt&gt; and change the &lt;tt&gt;BINARY&lt;/tt&gt; line near the top. Make sure you do not add any trailing spaces at the end of the name, or the build won't come out right.<br /> <br /> You should now be able to compile a blank extension!<br /> <br /> <br /> =Creating Native Functions=<br /> ''Main article: [[Natives (SourceMod Development)]]''<br /> <br /> Most of the time, an extension exists to add &quot;native functions&quot; to the plugin system. Native functions are simply the functions that plugins can use in SourceMod. They are coded in C++ and have a short prototype declaration in an include file.<br /> <br /> ==Prototyping==<br /> The first step to creating a native is to &lt;tt&gt;spec it&lt;/tt&gt;, or &lt;tt&gt;prototype&lt;/tt&gt; it. This is a simple but often time consuming process, but if you get in the habit of it, your documentation will be much better. Let's first create a very simply native. Here is a prototype for it, which we will place in &lt;tt&gt;sample.inc&lt;/tt&gt;:<br /> &lt;pawn&gt;/**<br /> * Returns the square of a number.<br /> *<br /> * @param num Number to square.<br /> * @return The square of num.<br /> */<br /> native SquareNumber(num);&lt;/pawn&gt;<br /> <br /> The &lt;tt&gt;native&lt;/tt&gt; keyword tells the compiler that this function exists in an outside source. The comment style is similar to [http://www.stack.nl/~dimitri/doxygen/ doxygen] or [http://java.sun.com/j2se/javadoc/ Javadoc], and is preferred by the SourceMod Development Team.<br /> <br /> ==Implementing==<br /> Now that our function is documented, it's time to create it! Each native function is bound to a C++ function. The prototype for this function looks like:<br /> &lt;cpp&gt;cell_t Function(IPluginContext *pContext, const cell_t *params);&lt;/cpp&gt;<br /> <br /> A quick explanation of these types:<br /> *&lt;tt&gt;cell_t&lt;/tt&gt; - This is a 32bit signed integer, the generic data type for Pawn.<br /> *&lt;tt&gt;IPluginContext&lt;/tt&gt; - This interface provides Virtual Machine functions for retrieving or modifying memory in the plugin.<br /> *&lt;tt&gt;params&lt;/tt&gt; - This is the &quot;stack&quot; of parameters that the plugin passed. It is an array from [0..N] where 0 contains N. <br /> **For example, if one parameter was passed, and the parameter is 25:<br /> ***&lt;tt&gt;params[0]&lt;/tt&gt; == 1<br /> ***&lt;tt&gt;params[1]&lt;/tt&gt; == 25<br /> **Even though it tells you how many parameters are passed, you do not need to verify this number. The compiler will always pass the correct number of parameters in. The only time you need to verify it is for backwards compatibility or variable parameter lists, which will be discussed later.<br /> <br /> Now, let's write our native function:<br /> &lt;cpp&gt;cell_t SquareNumber(IPluginContext *pContext, const cell_t *params)<br /> {<br /> cell_t number = params[1];<br /> return number * number;<br /> }&lt;/cpp&gt;<br /> <br /> ==Binding==<br /> Now, the final step is to bind our native. Natives are bound in ''native lists''. Each list must be terminated by a &lt;tt&gt;NULL&lt;/tt&gt; bind. Example:<br /> &lt;cpp&gt;const sp_nativeinfo_t MyNatives[] = <br /> {<br /> {&quot;SquareNumber&quot;, SquareNumber},<br /> {NULL, NULL},<br /> };&lt;/cpp&gt;<br /> <br /> The first column/member is a string containing the name you've assigned to the native. The second column/member is the C++ function you're binding to. Here, both contain the same name, but it is certainly possible to bind a function to any valid Pawn function name, and likewise, you can bind one function to more than one name.<br /> <br /> Lastly, you must tell Core about your native list. There are two places that are good to do this. Whichever you choose, you must uncomment the function in &lt;tt&gt;extension.h&lt;/tt&gt; and implement it in &lt;tt&gt;extension.cpp&lt;/tt&gt;.<br /> *&lt;tt&gt;SDK_OnLoad&lt;/tt&gt; - This is called when your extension is first loaded. If you do not require any outside interfaces, it is safe to add natives here.<br /> *&lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt; - This is called when all extensions have been loaded. This is generally a better place to add natives.<br /> <br /> Let's say we choose &lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt;, we'd then have code like this:<br /> &lt;cpp&gt;void Sample::SDK_OnAllLoaded()<br /> {<br /> sharesys-&gt;AddNatives(myself, MyNatives);<br /> }&lt;/cpp&gt;<br /> ''Note: &lt;tt&gt;myself&lt;/tt&gt; is a global variable declared in the SDK. It is a pointer that identifies your extension.''<br /> <br /> For more information on writing natives, see [[Natives (SourceMod Development)]].<br /> <br /> <br /> =Creating Events/Forwards=<br /> Events are an integral part to SourceMod. An Event is formally called a ''Forward''. Forwards are functions inside a plugin which are not called by the plugin itself, but are triggered from an external source. For example, &lt;tt&gt;OnClientConnect&lt;/tt&gt; is a forward which is triggered when a player connects to a server.<br /> <br /> There are two major types of forwards:<br /> *'''Managed''': This forward is global and has a name. To use this forward, the function must be declared as &lt;tt&gt;public&lt;/tt&gt; inside the user's script. Any plugin having this public function will receive the event.<br /> *'''Unmanaged''': This forward is private in nature. For example, the &lt;tt&gt;HookUserMessage&lt;/tt&gt; native lets users specify a function to be called when a specific user message is sent. This is done with an unmanaged forward, and adding functions to this forward is not automatic. In general, function calls for unmanaged forwards are not public, although they can be.<br /> <br /> ==Managed Forwards==<br /> Let's say we want to create a forward that will be called when a player uses say chat. For simplicity, let's assume you already have a function that tells you when a player says say chat. We will just be creating the forward for it.<br /> <br /> As we did before, first let's prototype our global forward. In our include file, we add this:<br /> &lt;pawn&gt;/**<br /> * @brief Called whenever a client says something in chat.<br /> *<br /> * @param client Index of the client.<br /> * @param text String containing the say text.<br /> * @return Pl_Handled to block text from printing, Pl_Continue otherwise.<br /> */<br /> forward ResultType:OnPlayerSayChat(client, const String:text[]);&lt;/pawn&gt;<br /> <br /> The &lt;tt&gt;forward&lt;/tt&gt; keyword tells the compiler that any function having this name must be declared exactly the same. In a plugin, this would<br /> <br /> The next step is to declare your forward somewhere at the top of your &lt;tt&gt;extension.cpp&lt;/tt&gt; file. This will look like:<br /> &lt;cpp&gt;IForward *g_pSayChat = NULL&lt;/cpp&gt;<br /> <br /> Next, re-using our code from above, let's create this forward in &lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt;:<br /> &lt;cpp&gt;void Sample::SDK_OnAllLoaded()<br /> {<br /> sharesys-&gt;AddNatives(myself, MyNatives);<br /> g_pSayChat = forwards-&gt;CreateForward(&quot;OnPlayerSayChat&quot;, ET_Event, 2, NULL, Param_Cell, Param_String);<br /> }&lt;/cpp&gt;<br /> <br /> Explanation of parameters:<br /> *&lt;tt&gt;&quot;OnPlayerSayChat&quot;&lt;/tt&gt; - The name of our forward.<br /> *&lt;tt&gt;ET_Event&lt;/tt&gt; - Since forwards can execute multiple functions in multiple scripts, this is one of the ways of specifying what to do with the return value of each function. &lt;tt&gt;ET_Event&lt;/tt&gt; means &quot;return the highest value, do not allow stops.&quot; A stop refers to &lt;tt&gt;Pl_Stop&lt;/tt&gt;, which lets a plugin block the rest of the event chain.<br /> *&lt;tt&gt;2&lt;/tt&gt; - This is the number of parameters our forward will have.<br /> *&lt;tt&gt;NULL&lt;/tt&gt; - Not used in our example. This lets you pass parameters by array rather than variable arguments.<br /> *&lt;tt&gt;Param_Cell&lt;/tt&gt; - The first parameter is a cell (integer).<br /> *&lt;tt&gt;Param_String&lt;/tt&gt; - The second parameter is a string.<br /> <br /> Now, we write a quick function in our module to call this forward:<br /> &lt;cpp&gt;/** Fires the say chat event in plugins. Returns true to allow the text, false to block. */<br /> bool FireChatEvent(int client, const char *text)<br /> {<br /> if (!g_pSayChat)<br /> {<br /> return true;<br /> }<br /> <br /> cell_t result = 0;<br /> g_pSayChat-&gt;PushCell(client);<br /> g_pSayChat-&gt;PushString(text);<br /> g_pSayChat-&gt;Execute(&amp;result);<br /> <br /> if (result == Pl_Handled)<br /> {<br /> return false;<br /> }<br /> <br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> As you can see, this was pretty simple. Each parameter is &quot;pushed&quot; one at a time, in ascending order. First we push the client index as a cell, then the text as a string. Once done, we execute, and the value will be returned by reference.<br /> <br /> Lastly, there is a caveat. Unlike natives, SourceMod does not automatically clean up forwards for us when are done. We have to make sure we destroy them. Uncomment &lt;tt&gt;SDK_OnUnload&lt;/tt&gt; from &lt;tt&gt;extension.h&lt;/tt&gt; and implement it like so:<br /> &lt;cpp&gt;void Sample::SDK_OnUnload()<br /> {<br /> forwards-&gt;ReleaseForward(g_pSayChat);<br /> }&lt;/cpp&gt;<br /> <br /> ==Unmanaged Forwards==<br /> Now things get a bit more complicated. However, unmanaged forwards are essentially the same -- they just give you more flexibility. Let's consider the managed example with a new twist. We want to let users add and remove hooks from their plugins, rather than having one global forward. The standard way to do this is with ''function IDs''. <br /> <br /> Example prototype:<br /> &lt;pawn&gt;funcenum SayChatHook<br /> {<br /> forward(client, const String:text[]);<br /> }<br /> <br /> native AddSayChatHook(SayChatHook:hook);<br /> native RemoveSayChatHook(SayChatHook:hook);&lt;/pawn&gt;<br /> <br /> The &lt;tt&gt;funcenum&lt;/tt&gt; syntax lets you define all the valid prototypes for your hook. In this example, the only valid method is a function declared like this (only MyHook can be changed):<br /> &lt;pawn&gt;MyHook(client, const String:text[])&lt;/pawn&gt;<br /> <br /> How do we make such a beast? The first step is setting up our forward.<br /> &lt;cpp&gt;IChangeableForward *g_pSayChat = NULL;<br /> /* ... */<br /> void Sample::SDK_OnAllLoaded()<br /> {<br /> g_pSayChat = forwards-&gt;CreateForwardEx(NULL, ET_Hook, 2, NULL, Param_Cell, Param_String); <br /> }&lt;/cpp&gt;<br /> <br /> Notice two big differences. We now use &lt;tt&gt;IChangeableForward&lt;/tt&gt; instead of &lt;tt&gt;IForward&lt;/tt&gt;, and we use &lt;tt&gt;CreateForwardEx&lt;/tt&gt; instead. The initial first parameter specifies a name for our forward - we're going to ignore this.<br /> <br /> Now, we need to create our natives. These will be fairly simple:<br /> &lt;cpp&gt;cell_t AddSayChatHook(IPluginContext *pContext, const cell_t *params)<br /> {<br /> g_pSayChat-&gt;AddFunction(pContext, static_cast&lt;funcid_t&gt;(params[1]));<br /> return 1;<br /> }<br /> <br /> cell_t RemoveSayChatHook(IPluginContext *pContext, const cell_t *params)<br /> {<br /> IPluginFunction *pFunction = pContext-&gt;GetFunctionById(static_cast&lt;funcid_t&gt;(params[1]));<br /> g_pSayChat-&gt;RemoveFunction(pFunction);<br /> return 1;<br /> }&lt;/cpp&gt;<br /> ''Note: These natives must be added -- that step is removed here and explained earlier.''<br /> <br /> You do not need to worry about a plugin unloading - Core will automatically remove the functions for you. Since an &lt;tt&gt;IChangeableForward&lt;/tt&gt; is also an &lt;tt&gt;IForward&lt;/tt&gt;, the &lt;tt&gt;FireChatEvent&lt;/tt&gt; function from earlier does not need to change. We're done!<br /> <br /> ==Creating Interfaces==<br /> Do you want your extension to share an interface? If so, first you should create an ''interface file''. This file should contain everything your interface needs - this way other authors can easily reference it. Your interface must inherit the &lt;tt&gt;SMInterface&lt;/tt&gt; class. It must also declare two global macros that uniquely identify your interface. It must also implement two functions: &lt;tt&gt;GetInterfaceName&lt;/tt&gt; and &lt;tt&gt;GetInterfaceVersion&lt;/tt&gt;.<br /> <br /> The two defines must start with &lt;tt&gt;SMINTERFACE_&lt;/tt&gt; and end with &lt;tt&gt;_NAME&lt;/tt&gt; and &lt;tt&gt;_VERSION&lt;/tt&gt; respectively. The first must be a string and the second must be an unsigned integer. This integer represents your interface's version number. While you are free to use it however you please, by default it should be linearly increased. If you make breaking changes or change the versioning scheme, you must overload the &lt;tt&gt;IsVersionCompat&lt;/tt&gt; function in &lt;tt&gt;SMInterface&lt;/tt&gt;.<br /> <br /> Example:<br /> &lt;cpp&gt;#ifndef _INCLUDE_MYINTERFACE_FILE_H_<br /> #define _INCLUDE_MYINTERFACE_FILE_H_<br /> <br /> #include &lt;IShareSys.h&gt;<br /> <br /> #define SMINTERFACE_MYINTERFACE_NAME &quot;IMyInterface&quot;<br /> #define SMINTERFACE_MYINTERFACE_VERSION 1<br /> <br /> class IMyInterface : public SourceMod::SMInterface<br /> {<br /> public:<br /> virtual const char *GetInterfaceName()<br /> {<br /> return SMINTERFACE_MYINTERFACE_NAME;<br /> }<br /> virtual unsigned int GetInterfaceVersion()<br /> {<br /> return SMINTERFACE_MYINTERFACE_VERSION;<br /> }<br /> public:<br /> /**<br /> * @brief This function does nothing.<br /> */<br /> virtual void DoNothingAtAll() =0;<br /> };<br /> <br /> #endif //_INCLUDE_MYINTERFACE_FILE_H_&lt;/cpp&gt;<br /> <br /> Notice, of course, that our interface is ''pure virtual''. This means it must be implemented in the extension. Assuming you know C++, this should be fairly straight forward, so let's skip right to how to add this interface to the SourceMod shared system:<br /> &lt;cpp&gt;bool Sample::SDK_OnLoad(char *error, size_t err_max, bool late)<br /> {<br /> sharesys-&gt;AddInterface(myself, &amp;g_MyInterface);<br /> return true;<br /> }&lt;/cpp&gt;<br /> ''Note: We do this in &lt;tt&gt;SDK_OnLoad()&lt;/tT&gt; instead of &lt;tt&gt;SDK_OnAllLoaded()&lt;/tt&gt;. Otherwise, an extension might try to search for your interface during &lt;tt&gt;SDK_OnAllLoaded()&lt;/tt&gt;, and it might fail depending on the load order.''<br /> <br /> That simple? Yup! Now other extensions can use your interface. <br /> <br /> <br /> =Using Interfaces/Other Extensions=<br /> There are a variety of interfaces that are available, but not loaded by default in the Extension SDK. These interfaces can be retrieved and used in your extension.<br /> <br /> ==Core Interfaces==<br /> If they are provided by Core, getting them is very simple. Many interfaces can simply be uncommented in &lt;tt&gt;smsdk_config.h&lt;/tt&gt; and they will become usable. See the &quot;Available Interfaces&quot; list below for the exposure list.<br /> <br /> Otherwise, most of the &lt;tt&gt;.h&lt;/tt&gt; interface files in the root of the &lt;tt&gt;public&lt;/tt&gt; folder in the SDK are Core interfaces. For example, code to use the IPluginManager interface might look like this:<br /> &lt;cpp&gt;#include &lt;IPluginSys.h&gt;<br /> <br /> IPluginManager *g_pPlugins = NULL;<br /> <br /> bool Sample::SDK_OnLoad(char *error, size_t err_max, bool late)<br /> {<br /> SM_GET_IFACE(PLUGINSYSTEM, g_pPlugins);<br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> Where did we get &lt;tt&gt;PLUGINSYSTEM&lt;/tt&gt; from? Observe the two lines in &lt;tt&gt;IPluginSys.h&lt;/tt&gt;:<br /> &lt;cpp&gt;#define SMINTERFACE_PLUGINSYSTEM_NAME &quot;IPluginManager&quot;<br /> #define SMINTERFACE_PLUGINSYSTEM_VERSION 1&lt;/cpp&gt;<br /> <br /> The &lt;tt&gt;SM_GET_IFACE&lt;/tt&gt; macro uses the text in between the &lt;tt&gt;SMINTERFACE_&lt;/tt&gt; and the &lt;tt&gt;_NAME&lt;/tt&gt; characters. It also uses the version for compatibility checking. If it can't find the interface, it automatically prints to the error buffer and returns false.<br /> <br /> ===Default Interfaces===<br /> There are interfaces which are grabbed by the Extension SDK by default. You do not need to query for them on load, or even check if they are valid or not. They are:<br /> *&lt;tt&gt;IShareSys&lt;/tt&gt; - Exposed as &lt;tt&gt;sharesys&lt;/tt&gt;, found in &lt;tt&gt;IShareSys.h&lt;/tt&gt;<br /> *&lt;tt&gt;HANDLESYSTEM&lt;/tt&gt; - Exposed as &lt;tt&gt;handlesys&lt;/tt&gt;, found in &lt;tt&gt;IHandleSys.h&lt;/tt&gt;<br /> *&lt;tt&gt;SOURCEMOD&lt;/tt&gt; - Exposed as &lt;tt&gt;g_pSM&lt;/tt&gt;, found in &lt;tt&gt;ISourceMod.h&lt;/tt&gt;<br /> *&lt;tt&gt;FORWARDMANAGER&lt;/tt&gt; - Exposed as &lt;tt&gt;forwards&lt;/tt&gt;, found in &lt;tt&gt;IForwardSys.h&lt;/tt&gt;<br /> <br /> ===Available Interfaces===<br /> *&lt;tt&gt;SMEXT_ENABLE_FORWARDSYS&lt;/tt&gt;: &lt;tt&gt;forwards&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_HANDLESYS&lt;/tt&gt;: &lt;tt&gt;handlesys&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_PLAYERHELPERS&lt;/tt&gt;: &lt;tt&gt;playerhelpers&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_DBMANAGER&lt;/tt&gt;: &lt;tt&gt;dbi&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_GAMECONF&lt;/tt&gt;: &lt;tt&gt;gameconfs&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_MEMUTILS&lt;/tt&gt;: &lt;tt&gt;memutils&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_GAMEHELPERS&lt;/tt&gt;: &lt;tt&gt;gamehelpers&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_TIMERSYS&lt;/tt&gt;: &lt;tt&gt;timersys&lt;/tt&gt;<br /> *&lt;tt&gt;SMEXT_ENABLE_THREADER&lt;/tt&gt;: &lt;tt&gt;threader&lt;/tt&gt;<br /> <br /> ==External Interfaces==<br /> The situation changes if your extension requires ''another extension'', since extensions may load in a completely random order. The first step is to mark the other extension as a dependency. Let's say you want to use the &lt;tt&gt;IThreader.h&lt;/tt&gt; interfaces from &lt;tt&gt;threader.ext.dll&lt;/tt&gt;. First, we declare it as such:<br /> <br /> &lt;cpp&gt;bool Sample::SDK_OnLoad(char *error, size_t err_max, bool late)<br /> {<br /> sharesys-&gt;AddDependency(myself, &quot;thread.ext&quot;, true, true);<br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> The two boolean parameters to &lt;tt&gt;AddDependency&lt;/tt&gt; mean, respectively: &quot;try to automatically load this extension&quot; and &quot;this extension cannot work without the dependency.&quot;<br /> <br /> Second, we query for the interface in &lt;tt&gt;SDK_OnAllLoaded&lt;/tt&gt;. Since we don't know when &lt;tt&gt;thread.ext&lt;/tt&gt; will actually be loaded, we have to wait until everything is definitely loaded.<br /> &lt;cpp&gt;IThreader *g_pThreader = NULL;<br /> /* ... */<br /> void Sample::SDK_OnAllLoaded()<br /> {<br /> SM_GET_LATE_IFACE(THREADER, g_pThreader);<br /> }&lt;/cpp&gt;<br /> <br /> Third, we need to find a way to fail if this interface was never found. The way to do this is by uncommenting &lt;tt&gt;QueryRunning&lt;/tt&gt; from &lt;tt&gt;extension.h&lt;/tt&gt; and implementing it:<br /> &lt;cpp&gt;bool Sample::QueryRunning(char *error, size_t err_max)<br /> {<br /> SM_CHECK_IFACE(THREADER, g_pThreader);<br /> return true;<br /> }&lt;/cpp&gt;<br /> <br /> When SourceMod queries your extension, the macro above will either validate the pointer or return false. If it returns false, SourceMod marks your extension as failed.<br /> <br /> ==Caveats==<br /> ===NULL Interfaces===<br /> There are a few ways that external interfaces can make your code complicated. The first is simple but a common oversight. Don't assume interfaces will be okay. For example, say we want to create a thread once we get the &lt;tt&gt;IThreader&lt;/tt&gt; interface. Our code should something like this:<br /> <br /> &lt;cpp&gt;void Sample::SDK_OnAllLoaded()<br /> {<br /> SM_GET_IFACE(THREADER, g_pThreader);<br /> <br /> if (QueryRunning(NULL, 0))<br /> {<br /> g_pThreader-&gt;MakeThread(/* stuff */);<br /> }<br /> }&lt;/cpp&gt;<br /> <br /> Note that we ''query ourself'' in order to find if it's safe to continue executing code. We could also have simply checked if &lt;tt&gt;g_pThreader&lt;/tt&gt; is &lt;tt&gt;NULL&lt;/tt&gt;, but self-querying has a bonus: if your extension continues to do things like hook events or add listeners, you will be preventing your extension from entirely initializing itself while one interface is bad. Always make sure you have sanity checks like this where needed.<br /> <br /> ===Dynamic Unloading===<br /> The second major caveat is that extensions can be dynamically unloaded. If you specified yourself as having a dependency and that each dependency is required, you will have no problem. Your extension will be unloaded before the interface is removed, and you can clean up memory/hooks in your &lt;tt&gt;SDK_OnUnload()&lt;/tt&gt; code. There are two situations where this is a different story.<br /> <br /> ====Optional Interfaces====<br /> The first situation is if you are not requiring an extension that contains an interface. Now, when the extension unloads, your extension will not be unloaded first. This creates a small problem, as you must clean up without being unloaded. There are two functions you can implement in your extension class to resolve this, both documented in &lt;tt&gt;IExtensionSys.h&lt;/tt&gt;:<br /> *&lt;tt&gt;QueryInterfaceDrop&lt;/tt&gt; - Allows you to request unloading when a specific interface is unloaded. This is the default behavior for all interfaces. If you want to block this functionality, continue reading.<br /> *&lt;tt&gt;NotifyInterfaceDrop&lt;/tt&gt; - This is called when an interface is dropped. If your plugin will not be unloaded, you can use this to clean up any resources on a specific interface being removed.<br /> <br /> ====Circular Dependencies====<br /> The second situation is a bit more complicated. It is possible for two extensions to have circular dependencies. For example:<br /> *Extension &quot;A&quot; requires extension &quot;B.&quot;<br /> *Extension &quot;B&quot; requires extension &quot;A.&quot;<br /> <br /> If either extension is unloaded, the opposite extension is unloaded normally. The first extension then receives the interface drop callbacks. In this situation, it is essential that the &lt;tt&gt;NotifyInterfaceDrop&lt;/tt&gt; function be implemented and used with the circular interface. Otherwise, you risk crashing when your extension unloads (or at the very least, leaking memory). Since the actual drop order is undefined, it means both extensions must implement this function to be safe.<br /> <br /> <br /> =Automatic Loading=<br /> There are two types of automatic loading: Dynamic and Global. Dynamic loading means your extension is only loaded when a plugin requires it. Global loading means your extension loads no matter what.<br /> <br /> ==Dynamic Autoloading==<br /> Dynamic loading requires that you create an include file for plugins. Plugins that include your file will automatically load your extension. This requires implementing the &lt;tt&gt;Extension&lt;/tt&gt; structure found in &lt;tt&gt;core.inc&lt;/tt&gt;. You must expose the structure as &lt;tt&gt;public&lt;/tt&gt;, and the name must start with &quot;&lt;tt&gt;__ext_&lt;/tt&gt;&quot;.<br /> <br /> &lt;pawn&gt;/**<br /> * Do not edit below this line!<br /> */<br /> public Extension:__ext_geoip = <br /> {<br /> name = &quot;GeoIP&quot;,<br /> file = &quot;geoip.ext&quot;,<br /> #if defined AUTOLOAD_EXTENSIONS<br /> autoload = 1,<br /> #else<br /> autoload = 0,<br /> #endif<br /> #if defined REQUIRE_EXTENSIONS<br /> required = 1,<br /> #else<br /> required = 0,<br /> #endif<br /> };<br /> &lt;/pawn&gt;<br /> <br /> Explanations:<br /> *&lt;b&gt;name&lt;/b&gt;: The name of your module as written in &lt;tt&gt;SMEXT_CONF_NAME&lt;/tt&gt;.<br /> *&lt;b&gt;file&lt;/b&gt;: The platform-inspecific portion of your extension's file name.<br /> *&lt;b&gt;autoload&lt;/b&gt;: Specifies that your module should always dynamically autoload by default. You can tweak this to either never autoload or always autoload (without letting the user toggle).<br /> *&lt;b&gt;required&lt;/b&gt;: Specifies whether or not this extension is '''required''' by your plugin. If for some reason your extension fails to load (or is not found), the plugin will also fail to load. This is changeable if you wish to override the default behavior.<br /> <br /> You can copy and paste this example, but remember to modify the following portions:<br /> *&lt;b&gt;__ext_geoip&lt;/b&gt;: Change the &quot;geoip&quot; portion to your own unique variable name.<br /> *&lt;b&gt;&quot;GeoIP&lt;/b&gt;: Change the GeoIP portion to your extension's name. This should match the name you chose as &lt;tt&gt;SMEXT_CONF_NAME&lt;/tt&gt;.<br /> *&lt;b&gt;&quot;geoip.ext&quot;&lt;/b&gt;: Change this to your extension's file name, without the .dll/.so portion.<br /> <br /> <br /> ==Global Autoloading==<br /> To have your extension always autoload, you must create a ''.autoload'' file in the &lt;tt&gt;extensions&lt;/tt&gt; folder. For example, to have the &lt;tt&gt;threader.ext.dll&lt;/tt&gt; or &lt;tt&gt;threader.ext.so&lt;/tt&gt; extensions autoload, you'd create the following file in &lt;tt&gt;extensions&lt;/tt&gt;: &lt;tt&gt;threader.autoload&lt;/tt&gt;.<br /> <br /> A few notes:<br /> *This only works for extensions using the .ext.&lt;platform&gt; convention. SourceMod cuts off the &quot;.autoload&quot; portion of the file, then adds on &quot;.ext.dll&quot; or &quot;.ext.so&quot; which will not work on custom files.<br /> *The file does not need to contain anything, it simply needs to exist.<br /> <br /> <br /> =Conventions=<br /> <br /> ==Designing API/Natives==<br /> *Start interface names with the capital letter 'I'.<br /> *Use a consistent naming convention. SourceMod uses [http://msdn2.microsoft.com/en-us/library/ms229002.aspx Microsoft/Pascal] naming. Avoid Java/Camel casing for both API and natives.<br /> *When exposing interfaces, make sure your exposure defines start with &lt;tt&gt;SMINTERFACE_&lt;/tt&gt; and end with &lt;tt&gt;_NAME&lt;/tt&gt; and &lt;tt&gt;_VERSION&lt;/tt&gt;<br /> <br /> ==External Naming==<br /> *Logtags (&lt;tt&gt;SMEXT_CONF_LOGTAG&lt;/tt&gt;) should be short names (under 10 characters or so) in all capital letters.<br /> *Your extension file name should never have &lt;tt&gt;_i486&lt;/tt&gt; or other unnecessary platform-specific notations in its name.<br /> *Your extension file name should always end in &lt;tt&gt;.ext.so&lt;/tt&gt; or &lt;tt&gt;.ext.dll&lt;/tt&gt; depending on the platform. The &lt;tt&gt;.ext.&lt;/tt&gt; is SourceMod convention.<br /> <br /> <br /> =Setting up Visual Studio=<br /> ==Paths==<br /> '''Visual Studio 2003''': Tools -&gt; Options -&gt; Projects, VC++ Directories<br /> <br /> '''Visual Studio 2005''': Tools -&gt; Options -&gt; Projects and Solutions -&gt; VC++ Directories<br /> <br /> ===Include Paths===<br /> *SourceMod only:<br /> **sdk\public\extensions<br /> **sdk\public\sourcepawn<br /> **sdk\public<br /> *SourceMM (Note that sourcemm might be 'trunk' for you):<br /> **sourcemm\sourcemm<br /> **sourcemm\sourcehook<br /> **sourcemm<br /> *HL2SDK:<br /> **game_shared<br /> **public\vstdlib<br /> **public\tier1<br /> **public\tier0<br /> **public\engine<br /> **public\dlls<br /> **public<br /> **dlls<br /> <br /> ===Link Paths===<br /> *HL2SDK:<br /> **lib\public for version 2005<br /> **lib-vc7\public for version 2003<br /> <br /> ==Compiler Options==<br /> &lt;b&gt;Note:&lt;/b&gt; These options are set by default in the sample Extension SDK.&lt;br&gt;<br /> &lt;b&gt;Note:&lt;/b&gt; These options should be set for every build (Release/Debug/others).<br /> <br /> For VS 2005, goto Project-&gt;Properties.<br /> <br /> *General<br /> **&lt;tt&gt;Character Set&lt;/tt&gt;: '''Use Multi-Byte Character Set'''<br /> *C/C++<br /> **General<br /> ***&lt;tt&gt;Detect 64-bit Portability Issues&lt;/tt&gt;: '''No'''<br /> **Preprocessor<br /> ***&lt;tt&gt;Preprocessor Defines&lt;/tt&gt;: Add &lt;tt&gt;_CRT_SECURE_NO_DEPRECATE&lt;/tt&gt; and &lt;tt&gt;_CRT_NONSTDC_NO_DEPRECATE&lt;/tt&gt; and &lt;tt&gt;SOURCEMOD_BUILD&lt;/tt&gt;<br /> **Code Generation<br /> ***&lt;tt&gt;Runtime Library&lt;/tt&gt;: Multi-threaded or /MT (for Release), Multi-threaded Debug or /MTd (for Debug)<br /> *Linker<br /> **General<br /> ***&lt;tt&gt;Output File&lt;/tt&gt;: Change &lt;tt&gt;$(ProjectName)&lt;/tt&gt; to &lt;tt&gt;$(ProjectName).ext&lt;/tt&gt;, or use your own custom string.<br /> **Input<br /> ***&lt;tt&gt;Additional Dependencies&lt;/tt&gt;: &lt;tt&gt;tier0.lib tier1.lib vstdlib.lib&lt;/tt&gt; (for SourceMM attached extensions only)<br /> <br /> [[Category:SourceMod]]<br /> [[Category:SourceMod Development]]</div>

Pheadxdll