User:Nosoop/Guide/How to X - Revision history

Nosoop: /* Proper Unicode handling in MySQL */ Add note on converting existing data

2023-03-04T16:53:27Z

‎Proper Unicode handling in MySQL: Add note on converting existing data

Nosoop: Add section on Unicode handling

2023-03-04T12:17:51Z

Add section on Unicode handling

Nosoop: Add mention of CS:GO-specific chat line breaks

2022-12-19T03:38:46Z

Add mention of CS:GO-specific chat line breaks

Nosoop: /* Pass enum structs through natives */ Use API reference template for types

2022-11-19T17:48:55Z

‎Pass enum structs through natives: Use API reference template for types

Nosoop: /* Declare methodmap natives */ Wrap 'this' in code tags instead of teletype

2022-11-19T17:47:31Z

‎Declare methodmap natives: Wrap 'this' in code tags instead of teletype

Nosoop: Add info on declaring methodmap natives

2022-11-19T17:46:04Z

Add info on declaring methodmap natives

Nosoop: /* Pass enum structs through natives */ Add practice of using opaque handle

2021-11-24T17:48:08Z

‎Pass enum structs through natives: Add practice of using opaque handle

Nosoop: Add short section on enum structs across natives

2021-03-06T10:42:18Z

Add short section on enum structs across natives

Nosoop: Good practice to provide a command string for override purposes

2021-02-02T09:10:46Z

Good practice to provide a command string for override purposes

Nosoop: Add reference to overrides

2020-12-19T11:31:28Z

Add reference to overrides

New page

This is a page on how to do things that are common in plugins.
These are intended to be best practices.

= Determine if a client has access to something =

Use the admin overrides system with the {{SourceMod API|file=console|function=CheckCommandAccess}} function.
For example, if you want to determine if a client has access to the <code>sm_ban</code> command:

<pre class="sourcepawn">
if (CheckCommandAccess(client, "sm_ban", ADMFLAG_BAN)) {
// client has access to the "sm_ban" command
}
</pre>

The <code>command</code> parameter can be an arbitrary string; it does not have to point to a valid command:

<pre class="sourcepawn">
if (CheckCommandAccess(client, "has_fancy_color_trails", ADMFLAG_CUSTOM1, true)) {
// client has access to the "has_fancy_color_trails" override;
// if an override entry isn't set it falls back to ADMFLAG_CUSTOM1.
// ignores the privileges set on a command of that name if it exists
}
</pre>

To assign access levels for specific strings, modify <tt>configs/admin_overrides.cfg</tt>.

For more detailed information, see [[Overriding_Command_Access_(SourceMod)|this page on overriding command access]].

@@ Line 45: / Line 45: @@
 = Proper Unicode handling in MySQL =
-MySQL defaults to using the latin1 character encoding, which isn't good if you need to store non-ASCII text.
+MySQL defaults to using the <tt>latin1</tt> character encoding, which isn't good if you need to store non-ASCII text.
 * Ensure columns are created with the <tt>utf8mb4</tt> collation, ''not'' <tt>utf8</tt> (which aliases to <tt>utf8mb3</tt>).
 * After connecting to the database, call {{SourceMod API|file=dbi|class=Database|function=SetCharset}} with <tt>utf8</tt>.

← Older revision		Revision as of 12:17, 4 March 2023
Line 42:		Line 42:

	CS:GO uses the newline character <code>\n</code> as a text color. Use the paragraph separator character instead: <code>\xE2\x80\xA9</code>		CS:GO uses the newline character <code>\n</code> as a text color. Use the paragraph separator character instead: <code>\xE2\x80\xA9</code>
		+
		+	= Proper Unicode handling in MySQL =
		+
		+	MySQL defaults to using the latin1 character encoding, which isn't good if you need to store non-ASCII text.
		+
		+	* Ensure columns are created with the <tt>utf8mb4</tt> collation, ''not'' <tt>utf8</tt> (which aliases to <tt>utf8mb3</tt>).
		+	* After connecting to the database, call {{SourceMod API\|file=dbi\|class=Database\|function=SetCharset}} with <tt>utf8</tt>.

← Older revision		Revision as of 03:38, 19 December 2022
Line 38:		Line 38:

	The safest approach is to serialize / deserialize the data through a standard container ({{SourceMod API\|file=adt_trie\|function=StringMap}}, {{SourceMod API\|file=datapack\|function=DataPack}}). That is then exposed to other plugins as an [https://en.wikipedia.org/wiki/Opaque_pointer opaque handle] (the methodmap definition would inherit from <tt>Handle</tt>, and read / write operations are handled indirectly through natives registered by the originating plugin).		The safest approach is to serialize / deserialize the data through a standard container ({{SourceMod API\|file=adt_trie\|function=StringMap}}, {{SourceMod API\|file=datapack\|function=DataPack}}). That is then exposed to other plugins as an [https://en.wikipedia.org/wiki/Opaque_pointer opaque handle] (the methodmap definition would inherit from <tt>Handle</tt>, and read / write operations are handled indirectly through natives registered by the originating plugin).
		+
		+	= Add linebreaks in CS:GO chat messages =
		+
		+	CS:GO uses the newline character <code>\n</code> as a text color. Use the paragraph separator character instead: <code>\xE2\x80\xA9</code>

← Older revision		Revision as of 17:48, 19 November 2022
Line 37:		Line 37:
	In short, you don't. Enum structs do not (at the time of writing) have a standardized in-memory representation, so they should not be passed across plugin boundaries. There's also no way to guarantee that two plugins were compiled with the same definition, let alone implementation (though checking the offset / sizes of each member would lower the risk).		In short, you don't. Enum structs do not (at the time of writing) have a standardized in-memory representation, so they should not be passed across plugin boundaries. There's also no way to guarantee that two plugins were compiled with the same definition, let alone implementation (though checking the offset / sizes of each member would lower the risk).

−	The safest approach is to serialize / deserialize the data through a standard container (~~<tt>~~StringMap~~</tt>~~, ~~<tt>~~DataPack~~</tt>~~). That is then exposed to other plugins as an [https://en.wikipedia.org/wiki/Opaque_pointer opaque handle] (the methodmap definition would inherit from <tt>Handle</tt>, and read / write operations are handled indirectly through natives registered by the originating plugin).	+	The safest approach is to serialize / deserialize the data through a standard container ({{SourceMod API\|file=adt_trie\|function=StringMap}}, {{SourceMod API\|file=datapack\|function=DataPack}}). That is then exposed to other plugins as an [https://en.wikipedia.org/wiki/Opaque_pointer opaque handle] (the methodmap definition would inherit from <tt>Handle</tt>, and read / write operations are handled indirectly through natives registered by the originating plugin).

@@ Line 31: / Line 31: @@
 = Declare methodmap natives =
-Methodmap natives are the same as any other native, except that the <tt>this</tt> value is passed in as the first parameter, and any additional parameters follow it.
+Methodmap natives are the same as any other native, except that the <code>this</code> value is passed in as the first parameter, and any additional parameters follow it.
 = Pass enum structs through natives =

← Older revision		Revision as of 17:46, 19 November 2022
Line 28:		Line 28:

	For more detailed information, see [[Overriding_Command_Access_(SourceMod)\|this page on overriding command access]].		For more detailed information, see [[Overriding_Command_Access_(SourceMod)\|this page on overriding command access]].
		+
		+	= Declare methodmap natives =
		+
		+	Methodmap natives are the same as any other native, except that the <tt>this</tt> value is passed in as the first parameter, and any additional parameters follow it.

	= Pass enum structs through natives =		= Pass enum structs through natives =

← Older revision		Revision as of 17:48, 24 November 2021
Line 33:		Line 33:
	In short, you don't. Enum structs do not (at the time of writing) have a standardized in-memory representation, so they should not be passed across plugin boundaries. There's also no way to guarantee that two plugins were compiled with the same definition, let alone implementation (though checking the offset / sizes of each member would lower the risk).		In short, you don't. Enum structs do not (at the time of writing) have a standardized in-memory representation, so they should not be passed across plugin boundaries. There's also no way to guarantee that two plugins were compiled with the same definition, let alone implementation (though checking the offset / sizes of each member would lower the risk).

−	The safest approach is to serialize / deserialize the data through a standard container (<tt>StringMap</tt>, <tt>DataPack</tt>).	+	The safest approach is to serialize / deserialize the data through a standard container (<tt>StringMap</tt>, <tt>DataPack</tt>). That is then exposed to other plugins as an [https://en.wikipedia.org/wiki/Opaque_pointer opaque handle] (the methodmap definition would inherit from <tt>Handle</tt>, and read / write operations are handled indirectly through natives registered by the originating plugin).

← Older revision		Revision as of 10:42, 6 March 2021
Line 28:		Line 28:

	For more detailed information, see [[Overriding_Command_Access_(SourceMod)\|this page on overriding command access]].		For more detailed information, see [[Overriding_Command_Access_(SourceMod)\|this page on overriding command access]].
		+
		+	= Pass enum structs through natives =
		+
		+	In short, you don't. Enum structs do not (at the time of writing) have a standardized in-memory representation, so they should not be passed across plugin boundaries. There's also no way to guarantee that two plugins were compiled with the same definition, let alone implementation (though checking the offset / sizes of each member would lower the risk).
		+
		+	The safest approach is to serialize / deserialize the data through a standard container (<tt>StringMap</tt>, <tt>DataPack</tt>).

@@ Line 22: / Line 22: @@
+}
 </pre>
 To assign access levels for specific strings, modify <tt>configs/admin_overrides.cfg</tt>.
 For more detailed information, see [[Overriding_Command_Access_(SourceMod)|this page on overriding command access]].