Documentation for modders.

All functions are accessed through the global object "bjg_mp_sync"
Example:

This function adds an event to the sync queue which will be sent to all players.
It will not send the event immediately, by itself the sync runs every 10 seconds, if you want to send immediately use bjg_sync_now() after adding the event.
The numeric id to identify the event by.
1000-10000 reserved for internal use.
Example: 123
The string to send to every player.
This usually contains the information you need to send to all players.
Example: "lots of interesting information bla bla whatever"
This is the header by which you can identify events from your mod.
Should be a short string to avoid overhead.
You don't have to include this parameter, in that case it will send the msg as is, and you can use the id to identify your event.
It is however recommended to include it to avoid overlap with other mods using the same id.
Example: "my_modname" OR nil
Returns a boolean indicating success or failure
Example: true
Returns a string giving additional information about the outcome
Example: "table is not blocked, adding event to queue"
Add event to queue:
Add and send immediately:
Read the listener part at the end on how to receive these messages.

This function adds a global lua table to the list of tables to keep in sync.
Global lua tables included in the list will be kept in sync across all players.
Sync interval is every 10 seconds.
Calling this function triggers an initial sync immediately.
!Your table_name and keys CANNOT include-> # <-this character otherwise bad things will happen!
!Other character sequences to avoid in general are-> #|# #;# #=# <-these three are used as control codes!
The name of the global table as a string.
Example: "bjg_test_table"
A boolean indicating whether the table should be excluded from automatic sync.
You will have to sync it manually with bjg_sync_table_now(table_name) every time you make changes.
Example: true
If this boolean is true any values which have the local players faction name somewhere in their key path, will not be written to the global table.
For example in table:
If ignore_local is true and an update event for value_1 is sent then in player As game instance the global table will NOT be updated, but in player Bs game instance it will.
This is because in the key path for value_1 (player_A_faction_name => value_1) the faction_name of player A is included.
Example: true
If this boolean is true, after every sync a cco script object with the tables name and the entire table included as TableValue will be set.
This is useful, if info from the table is used in ui elements.
Example: true
Returns a boolean indicating success or failure
Example: false
Returns a string giving additional information about the outcome
Example: "table already exists: bjg_test_table"
Basic

Advanced:

This function removes a table from the list of tables to keep in sync.
The name of the global table as a string.
Example: "bjg_test_table"
Returns a boolean indicating success or failure
Example: true
Returns a string giving additional information about the outcome
Example: "removed table: bjg_test_table"

This function triggers a sync and resets the next automatic sync event to occur in 10 seconds.
Returns a boolean indicating success or failure
Example: false
Returns a string giving additional information about the outcome
Example: "sync is blocked"

This function triggers a sync event for a specific table and resets the next automatic sync event to occur in 10 seconds.
This function is needed to sync tables that have automatic sync disabled.
The name of the global table as a string.
Example: "bjg_test_table"
Returns a boolean indicating success or failure
Example: false
Returns a string giving additional information about the outcome
Example: "table does not exist: bjg_test_table"

This function is used to block the sync globally.
Returns a boolean indicating success or failure
Example: true
Returns a string giving additional information about the outcome
Example: "sync stopped"

This function is used to unblock the sync globally.
Returns a boolean indicating success or failure
Example: true
Returns a string giving additional information about the outcome
Example: "sync resumed"

This listener can be used to receive the events added via bjg_add_sync_event()
Use context:id() to get the id you sent with the event.
The string is accessd with context:msg()
!The header is added at the front of the msg, you have to parse it out like in the example below!

The mod has an mct option to enable logging.
Logs will be written to bjg_mp_sync.txt in the games main folder.