File: web.md

package info (click to toggle)
surgescript 0.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,200 kB
  • sloc: ansic: 15,748; sh: 61; javascript: 38; makefile: 13
file content (72 lines) | stat: -rw-r--r-- 1,153 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
Web
===

Web routines.

Functions
---------

#### launchURL

`launchURL(url)`

Launches a URL using the default web browser. It's mandatory to specify a protocol. The following protocols are currently supported: *http://*, *https://*, *mailto:*

*Arguments*

* `url`: string. The URL to be launched.

*Example*
```cs
using SurgeEngine.Web;

object "Application"
{
    // Remember to change the state
    // after calling launchURL
    state "main"
    {
        Web.launchURL("http://opensurge2d.org");
        state = "done";
    }

    state "done"
    {
    }
}
```

#### encodeURIComponent

`encodeURIComponent(str)`

Encodes a component of a Universal Resource Identifier (URI). It escapes all characters of the input string, except:

```
A–Z a–z 0–9 - _ . ! ~ * ' ( )
```

*Arguments*

* `str`: string. The string to be escaped.

*Returns*

Returns the input string escaped as above.

*Example*

```cs
using SurgeEngine.Web;

// ...

user = "Jane Doe";
url = "https://my.website.name/?user=" + Web.encodeURIComponent(user);
Console.print(url);

// output:
// https://my.website.name/?user=Jane%20Doe
```

*Available since:* Open Surge 0.6.1