blob: 726b54a9326e54f1f893abf74a4e9304b4616602 (
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
53
54
55
56
|
---Messaging API documentation
---Functions for passing messages and constructing URL objects.
---@class msg
msg = {}
---Post a message to a receiving URL. The most common case is to send messages
---to a component. If the component part of the receiver is omitted, the message
---is broadcast to all components in the game object.
---The following receiver shorthands are available:
---
---
--- * "." the current game object
---
--- * "#" the current component
---
--- There is a 2 kilobyte limit to the message parameter table size.
---@param receiver string|url|hash # The receiver must be a string in URL-format, a URL object or a hashed string.
---@param message_id string|hash # The id must be a string or a hashed string.
---@param message table|nil? # a lua table with message parameters to send.
function msg.post(receiver, message_id, message) end
---This is equivalent to msg.url(nil) or msg.url("#"), which creates an url to the current
---script component.
---@return url # a new URL
function msg.url() end
---The format of the string must be [socket:][path][#fragment], which is similar to a HTTP URL.
---When addressing instances:
---
---
--- * socket is the name of a valid world (a collection)
---
--- * path is the id of the instance, which can either be relative the instance of the calling script or global
---
--- * fragment would be the id of the desired component
---
---In addition, the following shorthands are available:
---
---
--- * "." the current game object
---
--- * "#" the current component
---@param urlstring string # string to create the url from
---@return url # a new URL
function msg.url(urlstring) end
---creates a new URL from separate arguments
---@param socket string|hash? # socket of the URL
---@param path string|hash? # path of the URL
---@param fragment string|hash? # fragment of the URL
---@return url # a new URL
function msg.url(socket, path, fragment) end
return msg
|
