Difference between revisions of "User:Philmasterplus/Sandbox"

From Kolmafia
Jump to navigation Jump to search
(Created page with "{{#explode:And if you tolerate this| |2}}")
 
Line 1: Line 1:
{{#explode:And if you tolerate this| |2}}
+
{{{{{format|User:Philmasterplus/TemplateSandbox2}}}
 +
|name=visit_url
 +
|function1.return_type=buffer
 +
|function1.short_description=Returns the original HTML source of the page being overridden inside a relay override script.
 +
|function1.description=Returns the original HTML source of the page being overridden. ''This function works only inside a relay override script.''
 +
|function2.return_type=buffer
 +
|function2.short_description=Visits a web page and returns its HTML source.
 +
|function2.description=Makes an HTTP request to a web page and returns its HTML source.
 +
|function2.param1=url
 +
|function2.param1.type=string
 +
|function2.param1.optional=yes
 +
|function2.param1.default=""
 +
|function2.param1.description=URL of the page to visit. If a relative URL is provided, it is treated as an in-game page.
 +
|function2.param2=use_POST
 +
|function2.param2.type=boolean
 +
|function2.param2.optional=yes
 +
|function2.param2.default=true
 +
|function2.param2.description=If <code>true</code>, makes an HTTP POST request when visiting the URL. Otherwise, makes a GET request.
 +
|function2.param3=encoded
 +
|function2.param3.type=boolean
 +
|function2.param3.optional=yes
 +
|function2.param3.default=false
 +
|function2.param3.description=If <code>true</code>, KoLmafia assumes that <code>url</code> has already been [[wikipedia:Percent-encoding|URL-encoded]] and will not encode it.
 +
|{{{1|}}}
 +
}}

Revision as of 18:20, 18 December 2020

Function Syntax

buffer visit_url()

Returns the original HTML source of the page being overridden inside a relay override script.

buffer visit_urlstring url, boolean? use_POST = true, boolean? encoded = false )

Visits a web page and returns its HTML source.
  • url: URL of the page to visit. If a relative URL is provided, it is treated as an in-game page.
  • use_POST: If true, makes an HTTP POST request when visiting the URL. Otherwise, makes a GET request.
  • encoded: If true, KoLmafia assumes that url has already been URL-encoded and will not encode it.

{{{description}}}