Difference between revisions of "To url"

Latest revision as of 15:42, 26 January 2015

Returns the short url (normally of the form "adventure.php?snarfblat=") used to visit the location place.

Following example shows basic to_url operations.

location first;
first = $location[The Poop Deck];
print(first+" gives "+to_url(first)+".", "blue");

It gives the following output.

The Poop Deck gives adventure.php?snarfblat=159.

Trying to use $location[none] will generate an "Unexpected error."

@@ Line 1: / Line 1: @@
 {{
 #vardefine:name|to_url}}{{
-#vardefine:return_type|buffer}}{{
+#vardefine:return_type|string}}{{
-#vardefine:aggregate|yes}}{{
-#vardefine:return_also|buffer}}{{
 FunctionPage|
 name={{#var:name}}|
-function_category=|
 function1={{Function|
@@ Line 14: / Line 11: @@
 return_type={{#var:return_type}}|
 return_also={{#var:return_also}}|
-parameter1={{Param|}}|
+parameter1={{Param|location|place}}|
-parameter2={{Param|}}|
+p1desc={{Pspan|place}} is an in-game location to parse|
-p1desc={{Pspan|}}|
-p2desc={{Pspan|}}|
 }}|
-function_description=|
+function_description=Returns the short url (normally of the form "adventure.php?snarfblat=") used to visit the location {{pspan|place}}.|
-needscode=yes|
+code1={{CodeSample|
+title=Code Samples|
+description=Following example shows basic to_url operations.||
+code=
+<syntaxhighlight>
+location first;
+first = $location[The Poop Deck];
+print(first+" gives "+to_url(first)+".", "blue");
+</syntaxhighlight>|
+moreinfo=
+It gives the following output.
+<pre>
+The Poop Deck gives adventure.php?snarfblat=159.
+</pre>
+}}|
-see_also={{SeeAlso|}}|
+see_also={{SeeAlso|visit_url}}|
-cli_equiv=The CLI command |
+special=Trying to use $location[none] will generate an "Unexpected error."|
-more_info= |
-special= |
 }}
+[[Category:String Handling Routines]]