as i am often talking with Kiki, the author of Guild Event Manager, and i know that some of you are probably working on a roster 2.0 addon for GEM and EventCalndar, i asked Kiki to publish the actual SV format of GEM3 here, so that you guys can allready have a look a what will come soon.
The Varialbles flagged QA are runtime variables and are not saved in the SV, i left them in the description foor better understanding.
The format is nearly definitive, but it is possible that some changes will happen during the beta test phase that will start soon.
Let me know if this kind of info is of interrest, then i will update this thread as soon as there are new informations available
so here it is.
- Code: Select all
Data structures
----------------------
GEM_QA_Channels = { -- Current character channels configuration
[index] = { -- array
["name"] = STR -- Channel name (internal channel name if this is special guild channel. You can use GUILD constant for display)
["password"] = STR -- Channel password (nil if not used)
["alias"] = STR -- Alias to be displayed (nil if not used)
["slash"] = STR -- Slash command to talk on the channel (nil if not used)
["notify"] = INT -- Notify join/leave (0/1)
["guild"] = BOOL -- True if this is special guild channel
}
}
GEM_ChannelPlayer = { -- Infos about a player in a channel
["guild"] = STR -- Your current guild's name
["location"] = STR --
["level"] = INT -- Your current level
["class"] = STR -- Your class
["role"] = STR -- My role
["officer"] = --
["grank_name"] = STR --
["grank_idx"] = --
["version"] = -- GEM version
["comment"] = STR --
["lastlog"] = INT -- Last time I got infos from this player - Used to purge old players
-- Runtime built values
["isLeader"] = BOOL -- If player is currently the GUILD channel leader
["connected"] = BOOL -- If player is currently in the channel
["lastleave"]
}
GEM_QA_Config = { -- Current character GEM configuration
-- CORE VALUES
["channels"] = GEM_QA_Channels
["BipOnChannel"] = BOOL -- If a sound must be played when "BipOnChannelValue" is seen in a GEM channel
["BipOnChannelValue"] = STR -- String value that will play a "bip" sound when seen in a GEM channel
["debug"] = INT -- Debug value
["role"] = STR -- My role
["next_event_id"] = INT -- Next event ID
-- Runtime built values
["my_bcast_offset"] = INT -- Delay to wait before broadcasting an event or a command, if not a channel leader
-- GUI VALUES
["FilterChannel"] = BOOL -- Only show events from this character's channel
["FilterEvents"] = BOOL -- Only show events in this character's level range
["DateFormat"] = STR -- Displayed dates format
["comment"] = STR -- Comment shown in player's window
["UseServerTime"] = BOOL -- If displayed dates use server time
["scale"] = INT -- GUI scale value
["MinimapArcOffset"] = INT --
["MinimapRadiusOffset"] = INT --
["MinimapTexture"] = STR --
["SeeOffline"] = BOOL -- If showing offline members
}
GEM_Config = { -- Saved structure for GEM configuration
[STR RealmName] = {
[STR CharacterName] = GEM_QA_Config
}
["version"] = STR -- GEM Version
}
GEM_QA_Events = { -- Events for this Realm (init in _GEM_StartupInitVars)
["events"] = array of GEM_Event -- Events data (indexed by EventId)
["commands"] = array of GEM_Commands -- (indexed by EventId)
["commands_to_process"] = array of Params (from GEM_PlayerCommand) to be process (if I don't know an event - leader only) -- (indexed by EventId)
["my_deleted_events"] = array of GEM_Event -- Events I deleted (indexed by EventId)
["ignored"] = array of BOOL -- Ignored events (indexed by EventId)
["subscribed"][] = array of array of GEM_Subscription -- My subscriptions (indexed by EventID then by Toon name)
["kicked"][] = array of array of STR -- Events I'm kicked from with reason (indexed by EventID then by Toon name)
["banned"][] = array of array of STR -- Events I'm banned from with reason (indexed by EventID then by Toon name)
["ignored_players"] = array of BOOL (or Nil) -- Player's in my ignore list (GEM list, not WoW list) (indexed by name)
["forward"] = array of STR -- Name of new leader for events I released to new leader (indexed by EventID)
["archived"] = array of GEM_Event -- Archived events
["assistant"] ???
}
GEM_Commands = { -- Commands struct for an Event (returned by GEM_CMD_GetCommandInfosForEvent)
["id"] = STR -- Event ID
["channel"] = STR -- Channel
["leader"] = STR -- Leader
["ev_date"] = INT -- Event Date
["cmds"][] = array of array GEM_PlayerCommand -- Indexed by PlayerName then sorted by stamp
}
GEM_PlayerCommand = { -- Commands struct for a player (src)
["cmd"] = INT -- Command
["id"] = STR -- Event ID
["channel"] = STR -- Channel
["stamp"] = INT -- Stamp the command was first issued
["params"] = array of XYZ -- The params associated this the command
}
GEM_Subscription = { -- Local subscription struct (init in GEM_SUB_SubscribeMyself) - Infos for events I've subscribed to. Use GEM_SUB_GetSubscribedInfos() to get infos for a player. Use GEM_SUB_SubscribeUpdate() to send updated subscription
["name"] = --
["class"] = --
["role"] = --
["guild"] = --
["level"] = --
["comment"] = --
["force_queue"] = -- (one of GEM_SUB_FORCE_QUEUE_xx)
["state"] = -- (one of GEM_SUB_STATE_xx)
["unsub_comment"] = STRING -- Unsubscription comment
}
GEM_Event = { -- Event struct
["id"] = STR --
["channel"] = STR --
["leader"] = STR --
["ev_date"] = INT -- UTC time of event
["deadline"] = INT or NIL -- UTC time of signup deadline (Nil if no deadline)
["ev_place"] = STR --
["ev_comment"] = STR --
["update_time"] = INT -- UTC time of last event modification
["max_count"] = INT --
["min_lvl"] = INT --
["max_lvl"] = INT --
["classes"] = array of GEM_Limit -- Classes limits (indexed by class name)
["roles"] = array of GEM_Limit -- Roles limits (indexed by role name)
["players"] = array of GEM_Player -- All subscriptions received (and rejects), indexed by name
["sorttype"] = INT -- Sorting plugin's unique id
["closed_comment"] = STR or NIL -- Closed reason if event is closed, nil otherwise
-- Runtime built values
["tit_count"] = INT
["sub_count"] = INT
["repl_count"] = INT
["rej_count"] = INT
}
GEM_Limit = {
["min"] = INT or NIL -- Min requiered for this limit, or nil if no min requiered
["max"] = INT or NIL -- Max requiered for this limit, or nil if no max requiered
-- Runtime built values
["tit_count"] = INT -- Current subscribed titulars for this limit
["sub_count"] = INT -- Current subscribed substitutes for this limit
["repl_count"] = INT -- Current subscribed replacements for this limit
}
GEM_Player = { -- Subscriber struct (init in GEM_SUB_BuildSubscriberInfos) - Infos for players having subscribe to the event
["name"] = STR -- Player's name
["class"] = STR -- Player's class
["role"] = STR -- Player's role (one of GEM_ROLE_xx)
["level"] = INT -- Player's level
["guild"] = STR or NIL -- Guild name
["update_time"] = INT -- UTC time of player's subscription
["comment"] = STR or NIL -- Subscription comment
["force_queue"] = INT -- Queue the player should to be forced into (one of GEM_SUB_FORCE_QUEUE_xx)
-- Leader modified values
["current_queue"] = INT -- Queue the player is currently in (one of GEM_SUB_STATE_xx)
["queue_pos"] = INT -- Pos in queue
-- Leader not shared values (not sent to others, except during a leader change)
["lead_force_queue"] = INT -- Queue forced by the leader (one of GEM_SUB_FORCE_QUEUE_xx)
}
----------------------- QUICK ACCESS
GEM_QA_Events = GEM_Events[GEM_Realm]; -- Quick access to events
GEM_QA_Config = GEM_Config[GEM_Realm][GEM_PlayerName];
GEM_QA_Players = GEM_Players[GEM_Realm]; -- Setup quick access
GEM_QA_Channels = GEM_Config[GEM_Realm][pl_name].channels;
