UgCore.Gangs - UgCore

Server Client Optional module. Requires characters. Gangs work like jobs without duty. They are defined in config/gangs.lua, which only has none by default. none MUST exist.

config/gangs.lua

return {
    none = {
        label = 'None',
        grades = { { name = 'none', label = 'None', salary = 0 } },
    },
    ballas = {
        label = 'Ballas',
        grades = {
            { name = 'member', label = 'Member', salary = 0 },
            { name = 'leader', label = 'Leader', salary = 0, boss = true },
        },
    },
}

Server

UgCore.Gangs.Get(source) -> UgAssignment?
UgCore.Gangs.Set(source, name, grade?) -> ok, errorCode
UgCore.Gangs.SetGrade(source, grade) -> ok, errorCode
UgCore.Gangs.Exists(name, grade?) -> boolean
UgCore.Gangs.GetDefinition(name) -> { label, grades }?

Set and SetGrade MUST run in a thread. Gangs:BeforeSet MAY cancel. UgAssignment has the same fields as for jobs, without onDuty.

Client

UgCore.Gangs.Get() -> UgAssignment?

Read from the ug-core:Gang statebag.

Events

ug-core:Gangs:Changed with (source, gang, previous)

⌘I