summaryrefslogtreecommitdiff
path: root/scripts/README.md
blob: 1da04b7b415c6892567568dc3e2f7a91a2a2bcff (plain)
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
# Lua Scripts

Scripts packaged with Tremulous. This folder will likely fill up with
not so useful examples.

Even more likely this will be the only source of documentation in the
short term. Likely documentation will happen after the first large API
re-organization.


Available APIs 
==============

HTTP Client
-----------
   - `http.del()`
   - `http.get()`
   - `http.post()`
   - `http.put()`

   Returns a `HttpResponse` object.

```lua
   HttpResponse::code -- HTTP status code from server
   HttpResponse::body -- Raw response body
```

### Example 
```lua
    print(http.get('www.google.com/search?q=' .. 'Hello World').body)
```

JSON
----

  - `rapidjson.encode()`
  - `rapidjson.decode()`

Cvar
----

  - `cvar.new(a, b, c)`
  - `cvar.new(a, b)`
  - `cvar.new(a)`

Nettle
------
TBD

Client
------
TBD