Template:SourceMod API - Revision history

Nosoop: Add support for linking to include file roots

2022-10-23T15:13:05Z

Add support for linking to include file roots

Nosoop: Avoid breaking lines after the end of the template

2020-10-15T16:16:53Z

Avoid breaking lines after the end of the template

Nosoop: Update template with docs

2020-10-15T16:11:16Z

Update template with docs

Nosoop at 15:50, 15 October 2020

2020-10-15T15:50:19Z

Nosoop at 15:48, 15 October 2020

2020-10-15T15:48:16Z

Nosoop: Create reference template for SourceMod docs

2020-10-15T15:44:33Z

Create reference template for SourceMod docs

New page

[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if: {{{class|}}} | {{{class}}}/ | }}{{function}}} {{#if: {{{class|}}} | {{{class}}}./ | }}{{{function}}}]

@@ Line 1: / Line 1: @@
-<code>[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class|}}}|{{{class}}}/|}}{{{function}}} {{#if:{{{class|}}}|{{{class}}}.|}}{{{function}}}]</code><noinclude>
+<code>[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class|}}}|{{{class}}}/|}}{{#if:{{{function|}}}|{{{function}}}|}} {{#if:{{{function|}}}|{{#if:{{{class|}}}|{{{class}}}.|}}{{{function}}}|<{{{file}}}>}}]</code><noinclude>
 This generates a link to the [https://sm.alliedmods.net/new-api/ SourceMod Scripting API reference] entry.
 == Usage ==
   <nowiki>{{SourceMod API|file=datapack|class=DataPack|function=Reset}}</nowiki>
 produces
@@ Line 10: / Line 19: @@
 === Parameters ===
 ; file
-: the source file that contains the function.
+: the source file that contains the function.  If no other parameters are provided, the link will be displayed as <code><file></code>.
 ; class
 : optional. The methodmap class associated with a method. If this is present, the link will be displayed as <code>Class.Method</code>.
-; function
+; identifier
-: the function / method / other identifier.
+: optional. The function / method / other identifier that is part of the file.
 </noinclude>

← Older revision		Revision as of 16:16, 15 October 2020
Line 1:		Line 1:
−	<code>[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}} {{#if:{{{class\|}}}\|{{{class}}}.\|}}{{{function}}}]</code>	+	<code>[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}} {{#if:{{{class\|}}}\|{{{class}}}.\|}}{{{function}}}]</code><noinclude>

−	~~<noinclude>~~
	This generates a link to the [https://sm.alliedmods.net/new-api/ SourceMod Scripting API reference] entry.		This generates a link to the [https://sm.alliedmods.net/new-api/ SourceMod Scripting API reference] entry.

← Older revision		Revision as of 16:11, 15 October 2020
Line 1:		Line 1:
−	<code>[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}} {{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}}]</code>	+	<code>[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}} {{#if:{{{class\|}}}\|{{{class}}}.\|}}{{{function}}}]</code>
		+
		+	<noinclude>
		+	This generates a link to the [https://sm.alliedmods.net/new-api/ SourceMod Scripting API reference] entry.
		+
		+	== Usage ==
		+	<nowiki>{{SourceMod API\|file=datapack\|class=DataPack\|function=Reset}}</nowiki>
		+	produces
		+	:{{SourceMod API\|file=datapack\|class=DataPack\|function=Reset}}
		+
		+	=== Parameters ===
		+	; file
		+	: the source file that contains the function.
		+
		+	; class
		+	: optional. The methodmap class associated with a method. If this is present, the link will be displayed as <code>Class.Method</code>.
		+
		+	; function
		+	: the function / method / other identifier.
		+
		+	</noinclude>

← Older revision		Revision as of 15:50, 15 October 2020
Line 1:		Line 1:
−	[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}} {{#if:{{{class\|}}}\|{{{class}}}/\| }}{{{function}}}]	+	<code>[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}} {{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}}]</code>

← Older revision		Revision as of 15:48, 15 October 2020
Line 1:		Line 1:
−	[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if: {{{class\|}}} \| {{{class}}}/ \| }}{{function}}} {{#if: {{{class\|}}} \| {{{class}}}./ \| }}{{{function}}}]	+	[https://sm.alliedmods.net/new-api/{{{file}}}/{{#if:{{{class\|}}}\|{{{class}}}/\|}}{{{function}}} {{#if:{{{class\|}}}\|{{{class}}}/\| }}{{{function}}}]