flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDoc: Corrected a few links

Browse Source
This commit is contained in:
Lukas Pioch 2017-04-07 14:31:44 +02:00
parent 36dea62662
commit 7960d142ca
5 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Server/Plugins/APIDump/APIDesc.lua
View File

@ -11451,7 +11451,7 @@ a_Player:OpenWindow(Window);
Type = "number",
},
},
Notes = "Returns the player's current set of skin part flags. This is a bitwise OR of various {{eSkinPart}} constants. Note that HasSkinPart may be easier to use in most situations.",
Notes = "Returns the player's current set of skin part flags. This is a bitwise OR of various {{Globals#eSkinPart|eSkinPart}} constants. Note that HasSkinPart may be easier to use in most situations.",
},
GetStance =
{
@ -12175,7 +12175,7 @@ a_Player:OpenWindow(Window);
Type = "number",
},
},
Notes = "Sets the skin part flags of the player. The value should be a bitwise OR of several {{eSkinPart}} constants.",
Notes = "Sets the skin part flags of the player. The value should be a bitwise OR of several {{Globals#eSkinPart|eSkinPart}} constants.",
},
SetSprintingMaxSpeed =
{
@ -17197,7 +17197,7 @@ end
These constants represent the main and off hand. Currently, these constants are not used, but
are provided for future use when dual-wielding is functional. An action or item can be in the
main hand or the off hand. The main hand can be either the left or the right hand - use
{{cPlayer}}:GetMainHand() to determine which (see {{eMainHand}}).
{{cPlayer}}:GetMainHand() to determine which (see {{Globals#eMainHand|eMainHand}}).
]],
},
eMainHand =

2
Server/Plugins/APIDump/Classes/WebAdmin.lua
View File

@ -23,7 +23,7 @@ return
Type = "function",
},
},
Notes = "Adds a new web tab to webadmin. The tab uses \"Title\" as its display string and is identified in the URL using the UrlPath (https://server.domain.com/webadmin/{PluginName}/{UrlPath}). The HandlerFn is the callback function that is called when the admin accesses the page, it has the following signature:<br/><pre class=\"prettyprint lang-lua\">function ({{a_Request|HTTPRequest}}, a_UrlPath)<br/> return Content, ContentType<br/>end</pre> URLPath must not contain a '/', the recommendation is to use only 7-bit-clean ASCII character set.",
Notes = "Adds a new web tab to webadmin. The tab uses \"Title\" as its display string and is identified in the URL using the UrlPath (https://server.domain.com/webadmin/{PluginName}/{UrlPath}). The HandlerFn is the callback function that is called when the admin accesses the page, it has the following signature:<br/><pre class=\"prettyprint lang-lua\">function ({{HTTPRequest|a_Request}}, a_UrlPath)<br/> return Content, ContentType<br/>end</pre> URLPath must not contain a '/', the recommendation is to use only 7-bit-clean ASCII character set.",
},
GetAllWebTabs =
{

4
Server/Plugins/APIDump/Hooks/OnBrewingCompleted.lua
View File

@ -5,14 +5,14 @@ return
CalledWhen = "A brewing process is completed.",
DefaultFnName = "OnBrewingCompleted", -- also used as pagename
Desc = [[
This hook is called whenever a {{cBrewingstand|brewing stand}} has completed the brewing process.
This hook is called whenever a {{cBrewingstandEntity|brewing stand}} has completed the brewing process.
See also the {{OnBrewingCompleting|HOOK_BREWING_COMPLETING}} hook for a similar hook, is called when a
brewing process is completing.
]],
Params =
{
{ Name = "World", Type = "{{cWorld}}", Notes = "World where the brewing stand resides." },
{ Name = "Brewingstand", Type = "{{cBrewingstand}}", Notes = "The brewing stand that completed the brewing process." },
{ Name = "Brewingstand", Type = "{{cBrewingstandEntity}}", Notes = "The brewing stand that completed the brewing process." },
},
Returns = [[
If the function returns false or no value, Cuberite calls other plugins with this event. If the

4
Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua
View File

@ -5,7 +5,7 @@ return
CalledWhen = "A brewing process is completing.",
DefaultFnName = "OnBrewingCompleting", -- also used as pagename
Desc = [[
This hook is called whenever a {{cBrewingstand|brewing stand}} is completing the brewing process. Plugins may
This hook is called whenever a {{cBrewingstandEntity|brewing stand}} is completing the brewing process. Plugins may
refuse the completing of the brewing process.<p>
See also the {{OnBrewingCompleted|HOOK_BREWING_COMPLETED}} hook for a similar hook, is called after the
brewing process has been completed.
@ -13,7 +13,7 @@ return
Params =
{
{ Name = "World", Type = "{{cWorld}}", Notes = "World where the brewing stand resides." },
{ Name = "Brewingstand", Type = "{{cBrewingstand}}", Notes = "The brewing stand that completes the brewing process." },
{ Name = "Brewingstand", Type = "{{cBrewingstandEntity}}", Notes = "The brewing stand that completes the brewing process." },
},
Returns = [[
If the function returns false or no value, Cuberite calls other plugins with this event. If the function returns true,

2
Server/Plugins/APIDump/main_APIDump.lua
View File

@ -219,7 +219,7 @@ local function LinkifyString(a_String, a_Referrer)
--- Creates the HTML for the specified link and title
local function CreateLink(Link, Title)
if (Link:sub(1, 7) == "http://") then
if ((Link:sub(1, 7) == "http://") or (Link:sub(1, 8) == "https://")) then
-- The link is a full absolute URL, do not modify, do not track:
return "<a href=\"" .. Link .. "\">" .. Title .. "</a>";
end