csm_com/README.md

25 lines
844 B
Markdown
Raw Permalink Normal View History

2017-06-05 06:37:55 -07:00
## This mod gives server- and client-mods the possibility to communicate.
### It should be installed on server and client.
## Added functions are:
### For client:
2017-07-24 07:18:47 -07:00
- `csm_com.register_on_receive(func(msg)[, prefix])`
`prefix` should be a string. Try not to use many different prefixes,
one per mod should be enough.
2017-06-05 06:37:55 -07:00
If function returns `true`, remaining functions are not called.
- `csm_com.send(msg)`
- `csm_com.server_has()`
returns `true` if server has this mod installed
2017-07-08 13:01:16 -07:00
- `csm_com.register_on_know(func())`
Called when `csm_com.server_has()` becomes `true`.
2017-06-05 06:37:55 -07:00
### For server:
2017-07-24 07:18:47 -07:00
- `csm_com.register_on_receive(func(player_name, msg)[, prefix])`
same as above.
2017-06-05 06:37:55 -07:00
- `csm_com.send(player_name, msg)`
- `csm_com.player_has(player_name)`
returns `true` if player has this mod installed
2017-07-08 13:01:16 -07:00
- `csm_com.register_on_know(func(player_name))`
2017-07-24 07:18:47 -07:00
same as above.