SourceMod 1.4.0 API Changes - Revision history

Psychonic at 06:25, 29 October 2011

2011-10-29T06:25:49Z

Psychonic at 01:26, 29 October 2011

2011-10-29T01:26:26Z

Psychonic: /* Other Changes */

2011-10-29T01:20:08Z

‎Other Changes

Psychonic: /* Core */

2011-10-28T18:15:51Z

‎Core

Dr!fter: /* CStrike */

2011-10-26T13:34:53Z

‎CStrike

Dr!fter: /* CStrike */

2011-10-26T13:32:21Z

‎CStrike

Dr!fter: /* CStrike */

2011-10-26T13:27:12Z

‎CStrike

Dr!fter: /* CStrike */

2011-10-26T02:15:44Z

‎CStrike

Psychonic at 20:41, 25 October 2011

2011-10-25T20:41:57Z

Psychonic: /* SourceMod */

2011-10-25T20:38:25Z

‎SourceMod

← Older revision		Revision as of 06:25, 29 October 2011
Line 1:		Line 1:
		+	''These are just the API changes from SourceMod 1.3.8 to SourceMod 1.4.0. Click here for the full [http://wiki.alliedmods.net/SourceMod_1.4.0_Release_Notes SourceMod 1.4.0 Release Notes].''
	__FORCETOC__		__FORCETOC__

← Older revision		Revision as of 01:26, 29 October 2011
Line 1:		Line 1:
−	~~''This page is a work-in-progress as SourceMod 1.4.0 is not yet released.''~~
	__FORCETOC__		__FORCETOC__

← Older revision		Revision as of 01:20, 29 October 2011
Line 517:		Line 517:

	This change was made because 1) forcing edict indexes can be unsafe ("crashy") if misused, and 2) it allows <tt>CreateEntityByName</tt> to now be automatically supported by all ep2 and later games and mods, without requiring gamedata.		This change was made because 1) forcing edict indexes can be unsafe ("crashy") if misused, and 2) it allows <tt>CreateEntityByName</tt> to now be automatically supported by all ep2 and later games and mods, without requiring gamedata.
		+
		+	==TF2==
		+
		+	The TF2 holiday functions have changed, breaking our former <tt>TF2_OnGetHoliday</tt> forward that was able to be used for altering the active TF2 holiday.
		+
		+	While that forward is now deprecated, a new one, <tt>TF2_OnIsHolidayActive</tt> has emerged in its place. As a bonus, this effectively let's you have effects for multiple holidays active at once (now that the game supports it).
		+
		+	<pawn>/**
		+	* Called at various times when the game checks to see if the given holiday is active.
		+	* Return Plugin_Continue to let the original calculation or return a higher
		+	* action to override the decision with the value of 'result'
		+	*
		+	* @param holiday Holiday being checked.
		+	* @param result Buffer param for the result of the decision.
		+	* @return Plugin_Continue for original calculation, higher value to use 'result'.
		+	*/
		+	forward Action:TF2_OnIsHolidayActive(TFHoliday:holiday, &bool:result);</pawn>

← Older revision		Revision as of 18:15, 28 October 2011
Line 477:		Line 477:

	The <tt>MENUFLAG_BUTTON_NOVOTE</tt> menu option flag has been added to allow creation of an automatic "No Vote" option at the start of the menu.		The <tt>MENUFLAG_BUTTON_NOVOTE</tt> menu option flag has been added to allow creation of an automatic "No Vote" option at the start of the menu.
		+
		+	===String===
		+
		+	<tt>ExplodeString</tt> behavior has changed slightly to fix a long-standing bug with the return value in some cases and to allow more flexibility and more defined behavior.
		+
		+	A new copyRemainder boolean has been added as part of this change.
		+
		+	<pawn>/**
		+	* Breaks a string into pieces and stores each piece into an array of buffers.
		+	*
		+	* @param text The string to split.
		+	* @param split The string to use as a split delimiter.
		+	* @param buffers An array of string buffers (2D array).
		+	* @param maxStrings Number of string buffers (first dimension size).
		+	* @param maxStringLength Maximum length of each string buffer.
		+	* @param copyRemainder False (default) discard excess pieces, true to ignore
		+	* delimiters after last piece.
		+	* @return Number of strings retrieved.
		+	*/
		+	stock ExplodeString(const String:text[], const String:split[], String:buffers[][], maxStrings,
		+	maxStringLength, bool:copyRemainder = false)</pawn>
		+
		+	Key points in change:
		+	*Return value now always matches the actual number of strings written
		+	*If the string being exploded ends with one or more of the delimiter, the string will be split at all delimiters, even resulting in empty strings at the end
		+	*If all allocated strings buffers have been copied to and there is another delimiter remaining, you can opt in (with the copyRemainder bool) to have the remaining text appended to the last string written.

	==DBI==		==DBI==

@@ Line 247: / Line 247: @@
 forward Action:CS_OnTerminateRound(&Float:delay, &CSRoundEndReason:reason);</pawn>
-Calls CSWeaponDrop without having to create separate gamedata
+Adds the commonly used CSWeaponDrop SDKCall as a new native.
 <pawn>/**
   * Forces a player to drop or toss their weapon

@@ Line 272: / Line 272: @@
   */
   native CS_TerminateRound(Float:delay, CSRoundEndReason:reason, bool:blockhook = false);</pawn>
 Allows passing buy aliases and retrieving the actual name for the weapon.
   * Gets a weapon name from a weapon alias
+  *
@@ Line 285: / Line 285: @@
   */
   native CS_GetTranslatedWeaponAlias(const String:alias[], String:weapon[], size);</pawn>
 Allows getting a weapons price, while still obeying the forward call to get price if modified.
   * Gets a weapon's price
+  *
@@ Line 299: / Line 299: @@
   */
   native CS_GetWeaponPrice(client, CSWeaponID:id, bool:defaultprice = false);</pawn>
 Adds the ability to get a clients clan tag.
   * Gets a clients clan tag
   * @param client	Client index to get clan tag for.

@@ Line 197: / Line 197: @@
 ==CStrike==
 <pawn>/**
   * Called when a player attempts to purchase an item.
@@ Line 206: / Line 207: @@
   */
 forward Action:CS_OnBuyCommand(client, const String:weapon[]);</pawn>
 <pawn>/**
   * Called when CSWeaponDrop is called
@@ Line 215: / Line 218: @@
   */
 forward Action:CS_OnCSWeaponDrop(client, weaponIndex);</pawn>
 <pawn>/**
   * Called when game retrieves a weapon's price for a player.
@@ Line 229: / Line 234: @@
   */
 forward Action:CS_OnGetWeaponPrice(client, const String:weapon[], &price);</pawn>
 <pawn>/**
   * Called when TerminateRound is called.
@@ Line 303: / Line 310: @@
   */
   native CS_SetClientClanTag(client, const String:tag[]);</pawn>
 ==MapChooser==

@@ Line 2: / Line 2: @@
 __FORCETOC__
-=Sourcepawn API Changes=
+=Additions=
-==Additions==
+==BaseComm==
 The BaseComm base plugin now has a brand new API to fully interact with it, without conflict.
@@ Line 43: / Line 41: @@
-===ClientPrefs===
+==ClientPrefs==
 ClientPrefs now allows altering cookie values for clients that are not presently in-game.
@@ Line 59: / Line 57: @@
-===Core===
+==Core==
-====Clients====
+===Clients===
 Clients can now be easily identified as being the SourceTV or replay bot, regardless of when they are checked, what they were renamed to, or when they were enabled.
@@ Line 80: / Line 78: @@
 native bool:IsClientReplay(client);</pawn>
-====CommandFilters====
+===CommandFilters===
 Command filters are no longer limited to extensions. Multi-target filters can now be dynamically created, evaluated, and removed natively in Sourcepawn.
@@ Line 115: / Line 113: @@
-====Console====
+===Console===
 Server command output is now retrievable with the new <tt>ServerCommandEx</tt> native..
@@ Line 161: / Line 159: @@
 				bool:override_only=false);</pawn>
-====SourceMod====
+===SourceMod===
 Game config files now support looking up addresses calculated from other gamedata.
@@ Line 197: / Line 195: @@
 native StoreToAddress(Address:addr, data, NumberType:size);</pawn>
-===CStrike===
+==CStrike==
 <pawn>/**
@@ Line 305: / Line 303: @@
   */
   native CS_SetClientClanTag(client, const String:tag[]);</pawn>
 ==MapChooser==
 <pawn>/**
@@ Line 313: / Line 310: @@
 forward OnMapVoteStarted();</pawn>
-====Nominations====
+===Nominations===
 <pawn>/**
   * Attempt to remove a map from the mapchooser map list.
@@ Line 338: / Line 335: @@
-===SDKTools===
+==SDKTools==
 A new <tt>SDKCallType</tt>, <tt>SDKCall_Raw</tt> has been added. This is to be used with the new Address variables to make calls with custom |this| pointers.
-====Client====
+===Client===
 It is now possible to directly control some aspects of a client's netchannel in a way that, among other things, you can cause them to reconnect to the current server like at a map change.
@@ Line 361: / Line 358: @@
 native ReconnectClient(client);</pawn>
-====GameRules====
+===GameRules===
 Property values networked on the GameRulesProxy entity can now be looked up and set directly on the GameRules class. On the proxy, values read could be stale, and attempting to change values only resulted in them being changed on the client or not at all.
@@ Line 380: / Line 377: @@
 For more info on things that can be done with these, see http://forums.alliedmods.net/showthread.php?t=154217.
-====Sound====
+===Sound===
 You can now use the engine's function for sound gain calculation based on sound level and distance from listener.
@@ Line 393: / Line 390: @@
 native Float:GetDistGainFromSoundLevel(soundlevel, Float:distance);</pawn>
-===TF2===
+==TF2==
 Notification is now available when "WaitingForPlayers" both begins and ends (or current state can be queried as any time with the new GameRules natives).
@@ Line 430: / Line 427: @@
 forward TF2_OnConditionRemoved(client, TFCond:condition);</pawn>
-==Other Changes==
+=Other Changes=
-===Core===
+==Core==
-====Entities====
+===Entities===
 The following functions now have an optional last parameter of <tt>element</tt> to be used with props that are arrays (ie. <tt>m_iAmmo</tt>, <tt>m_hMyWeapons</tt>)
@@ Line 452: / Line 449: @@
 A <tt>GetEntPropArraySize</tt> native has also been added to retrieve the number of available indexes.
-====Lang====
+===Lang===
 <tt>GetClientLanguage</tt> and <tt>SetClientLanguage</tt> now only require a client to be connected, rather than in-game.
-====Menus====
+===Menus===
 The <tt>MENUFLAG_BUTTON_NOVOTE</tt> menu option flag has been added to allow creation of an automatic "No Vote" option at the start of the menu.
-===DBI===
+==DBI==
 <tt>SQL_GetAffectedRows</tt> now works properly with threaded query handles.
@@ Line 466: / Line 463: @@
 The handle passed to both <tt>SQL_GetInsertId</tt> and <tt>SQL_GetError</tt> can now be a query handle.
-===SDKTools===
+==SDKTools==
-====Functions====
+===Functions===
 The <tt>ForceEdictIndex</tt> parameter in <tt>CreateEntityByName</tt> is now always ignored on ep2 (orangebox) and later (resulting in the same behavior as keeping its default value of -1).
 This change was made because 1) forcing edict indexes can be unsafe ("crashy") if misused, and 2) it allows <tt>CreateEntityByName</tt> to now be automatically supported by all ep2 and later games and mods, without requiring gamedata.

@@ Line 177: / Line 177: @@
 native Address:GameConfGetAddress(Handle:gameconf, const String:name[]);</pawn>
-From pawn, you can now directly read and write values at these raw addresses.
+From pawn, you can now directly read and write values at these raw addresses. SDKTools also now supports calls using a raw address as a |this| pointer (see [[SourceMod_1.4.0_API_Changes#SDKTools]]).
 <pawn>/**