File: platform.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 (67 lines) | stat: -rw-r--r-- 1,374 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
Platform
========

Routines specific to the platform the game engine is currently running on.

*Available since*: Open Surge 0.6.1

*Example*

```cs
// Let's find out which platform the game engine is currently running on
using SurgeEngine.Platform;

object "Application"
{
    state "main"
    {
        Console.print(platformName());
        state = "done";
    }

    state "done"
    {
    }

    fun platformName()
    {
        if(Platform.isAndroid)
            return "Android";
        else if(Platform.isWindows)
            return "Windows";
        else if(Platform.isMacOS)
            return "macOS";
        else if(Platform.isUnix)
            return "Unix";
        else
            return "Unknown";
    }
}
```

Properties
----------

#### isWindows

`isWindows`: boolean, read-only.

Will be `true` if the game engine is running on Microsoft Windows.

#### isUnix

`isUnix`: boolean, read-only.

Will be `true` if the game engine is running on a Unix-like operating system such as: Linux, BSD, macOS, Android, etc.

#### isMacOS

`isMacOS`: boolean, read-only.

Will be `true` if the game engine is running on macOS.

#### isAndroid

`isAndroid`: boolean, read-only.

Will be `true` if the game engine is running on Android. Check [SurgeEngine.mobile](/engine/surgeengine#mobile) instead if you want to know if the game engine is running on mobile mode.