Package citizen
AdvertisingModel #sleela 2.5 (lib/citizen/character/AdvertisingModel.sleela)
AdvertisingModel class extends BusinessModel
AdvertisingModel — the audience is not the customer; the audience is the product. Revenue is impressions priced per thousand (CPM), and the only cost that matters is keeping the audience entertained enough to stay. A concrete BusinessModel: revenue = (impressions / 1000) x CPM. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
impressions | int impressions | ad views this month |
cpmCents | int cpmCents | revenue per 1000 impressions |
contentCostCents | int contentCostCents | monthly cost of making the audience show up |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int views, int cpm, int contentCost) | No description in source. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
BankAccount #sleela 2.5 (lib/citizen/BankAccount.sleela)
BankAccount class
Defines BankAccount, the civic-finance Master Class — the quiet place a Citizen's money goes to be anxious. It models a single banking relationship: who you bank with, the routing + account numbers that get the money there, and the balance that is somehow always lower than you expect. BankAccount is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is a sidecar owned by Citizen and carries the real banking details: a 9-digit ABA routing number (the first two digits of which the Federal Reserve uses to decide which of its twelve Districts your money reports to) and an account number. It holds balance state in whole cents to keep the pennies honest. Family: citizen. Settlement crosses an explicit bridge to the ledger and the FederalReserveID clearing fabric.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
MODULE | static final String MODULE = "BankAccount" | No description in source. |
TYPE_CHECKING | static final int TYPE_CHECKING = 0 | Account flavors, ranked by how guilty each one makes you feel. where money passes through, briefly |
TYPE_SAVINGS | static final int TYPE_SAVINGS = 1 | where money goes to be forgotten |
TYPE_CREDIT | static final int TYPE_CREDIT = 2 | where money you don't have lives |
loadedFlag | int loadedFlag | No description in source. |
isOpen | boolean isOpen | No description in source. |
holder | String holder | whose signature is on the dotted line |
bankName | String bankName | the institution with the marble lobby |
routingNumber | String routingNumber | 9-digit ABA number: Fed District + bank + checkdigit |
accountNumber | String accountNumber | the long one you can never remember |
type | int type | one of TYPE_* |
balanceCents | int balanceCents | the truth, in cents |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
load | void load() | No description in source. |
loaded | boolean loaded() | No description in source. |
moduleName | String moduleName() | No description in source. |
openFor | void openFor(String accountHolder) | Open an account. Comes with a free pen on a chain you cannot steal. |
configure | void configure(String bank, String routing, String account, int acctType) | Point the account at a specific bank + numbers (the grown-up setup). |
deposit | void deposit(int cents) | Money arrives. A rare and beautiful event. |
withdraw | boolean withdraw(int cents) | Money departs. Returns false if the account politely declines. |
close | void close() | Close the account. The pen is yours to keep. It was always yours. |
open | boolean open() | No description in source. |
balance | int balance() | No description in source. |
routing | String routing() | No description in source. |
account | String account() | No description in source. |
institution | String institution() | No description in source. |
fedDistrict | int fedDistrict() | The Federal Reserve District is encoded in the first two routing digits (01..12). This is how your checking account quietly knows its home office. |
yn | String yn(boolean b) | No description in source. |
describe | String describe() | No description in source. |
BrokerageModel #sleela 2.5 (lib/citizen/character/BrokerageModel.sleela)
BrokerageModel class extends BusinessModel
BrokerageModel — stand between two parties who want to trade and charge a fee per trade for the privilege of your standing there. Revenue is trades x fee; cost is the clearing/compliance machinery that keeps the regulators calm. A concrete BusinessModel. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
trades | int trades | trades executed this month |
feePerTradeCents | int feePerTradeCents | commission per trade |
clearingCostCents | int clearingCostCents | clearing/settlement cost per trade |
complianceCents | int complianceCents | monthly fixed compliance overhead |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int executed, int feePerTrade, int clearingCost, int compliance) | No description in source. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
BusinessModel #sleela 2.5 (lib/citizen/character/BusinessModel.sleela)
BusinessModel class
Defines BusinessModel, the language-neutral base contract a
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
MODULE | static final String MODULE = "BusinessModel" | No description in source. |
KIND_NONE | static final int KIND_NONE = 0 | Model archetypes, so a Character can say what it is without a pitch deck. |
KIND_SUBSCRIPTION | static final int KIND_SUBSCRIPTION = 1 | No description in source. |
KIND_FREEMIUM | static final int KIND_FREEMIUM = 2 | No description in source. |
KIND_MARKETPLACE | static final int KIND_MARKETPLACE = 3 | No description in source. |
KIND_ADVERTISING | static final int KIND_ADVERTISING = 4 | No description in source. |
KIND_RETAIL | static final int KIND_RETAIL = 5 | No description in source. |
KIND_WHOLESALE | static final int KIND_WHOLESALE = 6 | No description in source. |
KIND_FRANCHISE | static final int KIND_FRANCHISE = 7 | No description in source. |
KIND_LICENSING | static final int KIND_LICENSING = 8 | No description in source. |
KIND_SAAS | static final int KIND_SAAS = 9 | No description in source. |
KIND_CONSULTING | static final int KIND_CONSULTING = 10 | No description in source. |
KIND_MANUFACTURING | static final int KIND_MANUFACTURING = 11 | No description in source. |
KIND_BROKERAGE | static final int KIND_BROKERAGE = 12 | No description in source. |
loadedFlag | int loadedFlag | 1 once the module is loaded |
modelName | String modelName | human-readable, e.g. "Subscription" |
kind | int kind | one of KIND_* |
unitsCents | int unitsCents | the model's primary quantity (seats, items, listings) |
configured | boolean configured | true once a subclass has declared identity |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
load | void load() | --- loadable-module contract ------------------------------------------ |
loaded | boolean loaded() | No description in source. |
moduleName | String moduleName() | No description in source. |
configure | void configure(String name, int modelKind) | A subclass calls this from its own setup to declare identity. Mirrors the declare()/configure() pattern used by the lib/compiler front ends. |
setUnits | void setUnits(int n) | The model's primary driver — seats, items sold, listings, billable hours. Expressed as a plain count; subclasses decide what it means. |
monthlyRevenue | int monthlyRevenue() | --- revenue hooks. Base implementations report "nothing yet"; a concrete model overrides these with its own economics. All amounts are whole cents. |
monthlyCost | int monthlyCost() | No description in source. |
monthlyProfit | int monthlyProfit() | Profit is the same arithmetic for every model, so the base owns it and no subclass has to repeat it. This is the one honest law of business. |
profitable | boolean profitable() | No description in source. |
ready | boolean ready() | No description in source. |
modelKind | int modelKind() | No description in source. |
name | String name() | No description in source. |
units | int units() | No description in source. |
yn | String yn(boolean b) | Render a boolean as a word so describe() concatenates only Strings/ints, matching the proven /lib describe() idiom. |
describe | String describe() | No description in source. |
Character #sleela 2.5 (lib/citizen/character/Character.sleela)
Character class
Defines Character, the central Master Class of the character package — a named actor in the Sleela economy who adopts exactly one BusinessModel and lives or dies by its monthly profit. A Character is classful by design: it is one class that composes any one of the many, many business-model classes in this package. Character is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It holds a BusinessModel reference typed to the base class, so it can carry a Subscription, Freemium, Marketplace, Advertising, Retail, Wholesale, Franchise, Licensing, SaaS, Consulting, Manufacturing, or Brokerage model interchangeably and ask it, each month, the only question that matters. The polymorphism follows the exact base/subclass pattern used by lib/compiler's SLLanguageCompiler front ends. It also carries a little personality — grit and reputation — because a business model is only as good as the Character running it. Family: character. Settlement crosses an explicit bridge to the ledger.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
MODULE | static final String MODULE = "Character" | No description in source. |
loadedFlag | int loadedFlag | 1 once the module is loaded |
name | String name | who this Character is |
tagline | String tagline | their elevator pitch, mercifully short |
grit | int grit | 0..100 — how many bad months they can stomach |
reputation | int reputation | 0..100 — grows with profit, bruises with loss |
cashCents | int cashCents | running cash on hand |
model | BusinessModel model | the one model they live by (any concrete subclass) |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
load | void load() | --- loadable-module contract ------------------------------------------ |
loaded | boolean loaded() | No description in source. |
moduleName | String moduleName() | No description in source. |
introduce | void introduce(String who, String pitch, int startingGrit, int startingCash) | Introduce the Character and give them a little personality. |
adopt | void adopt(BusinessModel chosen) | Adopt a business model. Any concrete BusinessModel subclass will do — the Character does not care which, only whether it makes money. This is the whole point of a base-typed reference holding a subclass instance. |
hasModel | boolean hasModel() | No description in source. |
liveAMonth | int liveAMonth() | Live one month: realize the model's profit into cash and let it move the Character's reputation and grit. Returns the profit for the month. |
runMonths | int runMonths(int months) | Run several months and report the total profit realized. |
stillStanding | boolean stillStanding() | The question every Character secretly asks at 3am. |
thriving | boolean thriving() | No description in source. |
cash | int cash() | No description in source. |
reputationScore | int reputationScore() | No description in source. |
gritScore | int gritScore() | No description in source. |
characterName | String characterName() | No description in source. |
modelKind | int modelKind() | No description in source. |
modelName | String modelName() | No description in source. |
clamp | int clamp(int v) | No description in source. |
yn | String yn(boolean b) | No description in source. |
describe | String describe() | No description in source. |
Citizen #sleela 2.5 (lib/citizen/Citizen.sleela)
Citizen class
Defines Citizen, the civic Master Class — one honest, taxpaying, coffee-drinking person as modeled by the Republic of Sleela. A Citizen is the smallest unit of a nation that still complains about the weather. Citizen is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe) with the other /lib Master Classes, so a loader can treat it uniformly. It composes three sidecar records that it owns and keeps consistent: an Industry affiliation (what they do for a living), a BankAccount (where the money quietly leaves from), and a FederalReserveID (how the central bank pretends to know them personally). A Citizen is, famously, able. It can be born, employed, paid, taxed, retired, and — on a good day — content. It holds civic state only; the paperwork is performed by the sidecar classes in this package. The runnable orchestration example lives in citizen/sleela/CitizenDemo.sleela. Family: citizen. Civic data crosses an explicit bridge to the ledger.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
MODULE | static final String MODULE = "Citizen" | No description in source. |
STAGE_UNBORN | static final int STAGE_UNBORN = 0 | Life stages, because every bureaucracy loves an enum it can't spell. a gleam in the census-taker's eye |
STAGE_MINOR | static final int STAGE_MINOR = 1 | all rights, none of the taxes |
STAGE_WORKING | static final int STAGE_WORKING = 2 | the golden, caffeinated years |
STAGE_RETIRED | static final int STAGE_RETIRED = 3 | emeritus citizen, senior discount |
STAGE_DECEASED | static final int STAGE_DECEASED = 4 | files one final, very late return |
loadedFlag | int loadedFlag | 1 once the module is loaded |
legalName | String legalName | the name on the forms nobody reads |
nickname | String nickname | the name their friends actually use |
age | int age | in laps around a medium yellow star |
stage | int stage | one of STAGE_* |
moodOutOf100 | int moodOutOf100 | 0 = DMV queue, 100 = Friday 5pm |
industry | Industry industry | what they claim at parties |
bank | BankAccount bank | the sad truth of what they can afford |
fedId | FederalReserveID fedId | how the central bank addresses the holiday card |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
load | void load() | --- loadable-module contract ------------------------------------------ |
loaded | boolean loaded() | No description in source. |
moduleName | String moduleName() | No description in source. |
beBorn | void beBorn(String name) | A citizen is born. Congratulations, you now owe the system a resume. |
haveABirthday | void haveABirthday() | Time, that undefeated opponent, advances exactly one year. |
getAJob | void getAJob(int sector, int wageCents) | Pick a trade. The Industry class judges you so this class doesn't have to. |
getPaid | int getPaid() | Payday. The one unambiguously good day of the fortnight. |
payTaxes | int payTaxes(int ratePercent) | Taxes. A citizen is, after all, defined by their relationship with Form 1040. |
treatYourself | boolean treatYourself(int cents) | Spend some money on something frivolous. Highly recommended for morale. |
retire | void retire() | Gracefully exit the workforce; keep the opinions. |
passAway | void passAway() | The final, non-negotiable withdrawal. |
alive | boolean alive() | --- queries ------------------------------------------------------------ |
employed | boolean employed() | No description in source. |
solvent | boolean solvent() | No description in source. |
isAble | boolean isAble() | The whole point: a Citizen is able. This proves it. |
netWorthCents | int netWorthCents() | No description in source. |
lifeStage | int lifeStage() | No description in source. |
happiness | int happiness() | No description in source. |
name | String name() | No description in source. |
fedNumber | String fedNumber() | No description in source. |
clampMood | void clampMood() | No description in source. |
yn | String yn(boolean b) | Render a boolean as a word, so describe() concatenates only Strings/ints — the exact idiom the shipped /lib describe() methods already use. |
describe | String describe() | No description in source. |
CitizenCommunityRelationshipsAndCivicParticipationStats #sleela 2.5 (lib/citizen/CitizenCommunityRelationshipsAndCivicParticipationStats.sleela)
CitizenCommunityRelationshipsAndCivicParticipationStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
socialConnection | int socialConnection | No description in source. |
familySupport | int familySupport | No description in source. |
friendNetworkSize | int friendNetworkSize | No description in source. |
communityBelonging | int communityBelonging | No description in source. |
socialTrust | int socialTrust | No description in source. |
institutionalTrust | int institutionalTrust | No description in source. |
volunteerHoursPerMonth | int volunteerHoursPerMonth | No description in source. |
communityServiceHours | int communityServiceHours | No description in source. |
civicParticipation | int civicParticipation | No description in source. |
votingParticipation | int votingParticipation | No description in source. |
publicMeetingParticipation | int publicMeetingParticipation | No description in source. |
localOrganizationMemberships | int localOrganizationMemberships | No description in source. |
charitableGivingCentsPerYear | int charitableGivingCentsPerYear | No description in source. |
neighborliness | int neighborliness | No description in source. |
socialIsolationRisk | int socialIsolationRisk | No description in source. |
discriminationExposure | int discriminationExposure | No description in source. |
inclusionAccess | int inclusionAccess | No description in source. |
culturalParticipation | int culturalParticipation | No description in source. |
recreationHoursPerWeek | int recreationHoursPerWeek | No description in source. |
libraryUse | int libraryUse | No description in source. |
publicServiceSatisfaction | int publicServiceSatisfaction | No description in source. |
communityContribution | int communityContribution | No description in source. |
CitizenDemo #sleela 2.5 (lib/citizen/seem/CitizenDemo.sleela)
CitizenDemo class
Walks a single Citizen through a whole, slightly comic life — born, schooled, employed across the whole industry, banked, cleared through a Federal Reserve District, paid, taxed, treated, and retired — printing a describe() line at each milestone. This is the executable counterpart to the citizen Master Classes; the authoritative definitions (Citizen, Industry, BankAccount, FederalReserveID) live one level up in lib/citizen/*.sleela. Family: citizen.
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
main | void main() | No description in source. |
CitizenDigitalAccessAndSafetyStats #sleela 2.5 (lib/citizen/CitizenDigitalAccessAndSafetyStats.sleela)
CitizenDigitalAccessAndSafetyStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
deviceAccess | int deviceAccess | No description in source. |
computerAccess | int computerAccess | No description in source. |
broadbandQuality | int broadbandQuality | No description in source. |
onlineServiceUse | int onlineServiceUse | No description in source. |
cybersecurityAwareness | int cybersecurityAwareness | No description in source. |
digitalPrivacyAwareness | int digitalPrivacyAwareness | No description in source. |
accessibilityTechnologyAccess | int accessibilityTechnologyAccess | No description in source. |
digitalSkills | int digitalSkills | No description in source. |
digitalExclusionRisk | int digitalExclusionRisk | No description in source. |
telehealthCapability | int telehealthCapability | No description in source. |
CitizenEducationAndKnowledgeStats #sleela 2.5 (lib/citizen/CitizenEducationAndKnowledgeStats.sleela)
CitizenEducationAndKnowledgeStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
educationLevel | int educationLevel | No description in source. |
yearsOfEducation | int yearsOfEducation | No description in source. |
literacy | int literacy | No description in source. |
numeracy | int numeracy | No description in source. |
digitalLiteracy | int digitalLiteracy | No description in source. |
financialLiteracy | int financialLiteracy | No description in source. |
civicLiteracy | int civicLiteracy | No description in source. |
scientificLiteracy | int scientificLiteracy | No description in source. |
highestQualification | int highestQualification | No description in source. |
schoolAttendanceRate | int schoolAttendanceRate | No description in source. |
academicPerformance | int academicPerformance | No description in source. |
vocationalTraining | int vocationalTraining | No description in source. |
apprenticeshipProgress | int apprenticeshipProgress | No description in source. |
certifications | int certifications | No description in source. |
skillsCount | int skillsCount | No description in source. |
languagesSpoken | int languagesSpoken | No description in source. |
readingProficiency | int readingProficiency | No description in source. |
writingProficiency | int writingProficiency | No description in source. |
mathematicsProficiency | int mathematicsProficiency | No description in source. |
researchSkill | int researchSkill | No description in source. |
teachingSkill | int teachingSkill | No description in source. |
lifelongLearning | int lifelongLearning | No description in source. |
educationDebtCents | int educationDebtCents | No description in source. |
CitizenEmploymentWorkAndProfessionalLifeStats #sleela 2.5 (lib/citizen/CitizenEmploymentWorkAndProfessionalLifeStats.sleela)
CitizenEmploymentWorkAndProfessionalLifeStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
employerId | string employerId | No description in source. |
occupationCode | string occupationCode | No description in source. |
industryCode | string industryCode | No description in source. |
employmentStatus | string employmentStatus | No description in source. |
employed | int employed | No description in source. |
selfEmployed | int selfEmployed | No description in source. |
seekingWork | int seekingWork | No description in source. |
workExperienceYears | int workExperienceYears | No description in source. |
tenureMonths | int tenureMonths | No description in source. |
hoursWorkedPerWeek | int hoursWorkedPerWeek | No description in source. |
contractedHoursPerWeek | int contractedHoursPerWeek | No description in source. |
productivity | int productivity | No description in source. |
workQuality | int workQuality | No description in source. |
attendanceReliability | int attendanceReliability | No description in source. |
jobSatisfaction | int jobSatisfaction | No description in source. |
careerProgress | int careerProgress | No description in source. |
leadershipAtWork | int leadershipAtWork | No description in source. |
workplaceSafety | int workplaceSafety | No description in source. |
remoteWorkCapability | int remoteWorkCapability | No description in source. |
unionMembership | int unionMembership | No description in source. |
unemploymentMonths | int unemploymentMonths | No description in source. |
grossIncomeCentsPerMonth | long grossIncomeCentsPerMonth | No description in source. |
netIncomeCentsPerMonth | long netIncomeCentsPerMonth | No description in source. |
annualIncomeCents | long annualIncomeCents | No description in source. |
benefitsValueCentsPerMonth | long benefitsValueCentsPerMonth | No description in source. |
pensionContributionCentsPerMonth | long pensionContributionCentsPerMonth | No description in source. |
incomeStability | int incomeStability | No description in source. |
jobSecurity | int jobSecurity | No description in source. |
workLifeBalance | int workLifeBalance | No description in source. |
CitizenHousingUtilitiesAndHouseholdServicesStats #sleela 2.5 (lib/citizen/CitizenHousingUtilitiesAndHouseholdServicesStats.sleela)
CitizenHousingUtilitiesAndHouseholdServicesStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
housingType | string housingType | No description in source. |
tenureType | string tenureType | No description in source. |
housingQuality | int housingQuality | No description in source. |
housingSecurity | int housingSecurity | No description in source. |
roomsInHome | int roomsInHome | No description in source. |
peoplePerRoom | int peoplePerRoom | No description in source. |
overcrowdingRisk | int overcrowdingRisk | No description in source. |
homelessnessRisk | int homelessnessRisk | No description in source. |
waterAccess | int waterAccess | No description in source. |
sanitationAccess | int sanitationAccess | No description in source. |
electricityAccess | int electricityAccess | No description in source. |
heatingAccess | int heatingAccess | No description in source. |
coolingAccess | int coolingAccess | No description in source. |
internetAccess | int internetAccess | No description in source. |
phoneAccess | int phoneAccess | No description in source. |
wasteCollectionAccess | int wasteCollectionAccess | No description in source. |
publicTransportAccess | int publicTransportAccess | No description in source. |
distanceToHealthcare | int distanceToHealthcare | No description in source. |
distanceToSchool | int distanceToSchool | No description in source. |
neighborhoodSafety | int neighborhoodSafety | No description in source. |
neighborhoodQuality | int neighborhoodQuality | No description in source. |
environmentalQuality | int environmentalQuality | No description in source. |
householdEnergyUse | int householdEnergyUse | No description in source. |
householdWaterUse | int householdWaterUse | No description in source. |
housingAssistance | int housingAssistance | No description in source. |
CitizenIdentityAndDemographicProfileStats #sleela 2.5 (lib/citizen/CitizenIdentityAndDemographicProfileStats.sleela)
CitizenIdentityAndDemographicProfileStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
citizenId | string citizenId | No description in source. |
legalName | string legalName | No description in source. |
preferredName | string preferredName | No description in source. |
householdId | string householdId | No description in source. |
familyId | string familyId | No description in source. |
citizenshipCode | string citizenshipCode | No description in source. |
residencyCode | string residencyCode | No description in source. |
birthPlace | string birthPlace | No description in source. |
currentAddress | string currentAddress | No description in source. |
postalCode | string postalCode | No description in source. |
municipality | string municipality | No description in source. |
region | string region | No description in source. |
countryCode | string countryCode | No description in source. |
primaryLanguage | string primaryLanguage | No description in source. |
ageYears | int ageYears | No description in source. |
ageMonths | int ageMonths | No description in source. |
birthYear | int birthYear | No description in source. |
birthMonth | int birthMonth | No description in source. |
birthDay | int birthDay | No description in source. |
lifeExpectancyYears | int lifeExpectancyYears | No description in source. |
householdSize | int householdSize | No description in source. |
dependents | int dependents | No description in source. |
isAlive | int isAlive | No description in source. |
isResident | int isResident | No description in source. |
isCitizen | int isCitizen | No description in source. |
isRegisteredVoter | int isRegisteredVoter | No description in source. |
isEmancipated | int isEmancipated | No description in source. |
hasDisability | int hasDisability | No description in source. |
accessibilityNeeds | int accessibilityNeeds | No description in source. |
CitizenLegalAndAdministrativeStandingStats #sleela 2.5 (lib/citizen/CitizenLegalAndAdministrativeStandingStats.sleela)
CitizenLegalAndAdministrativeStandingStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
civilStatus | string civilStatus | No description in source. |
residencyStatus | string residencyStatus | No description in source. |
voterRegistrationStatus | string voterRegistrationStatus | No description in source. |
taxAccountId | string taxAccountId | No description in source. |
identityVerified | int identityVerified | No description in source. |
addressVerified | int addressVerified | No description in source. |
permitsHeld | int permitsHeld | No description in source. |
licensesHeld | int licensesHeld | No description in source. |
legalCaseCount | int legalCaseCount | No description in source. |
unresolvedLegalCases | int unresolvedLegalCases | No description in source. |
fineBalanceCents | int fineBalanceCents | No description in source. |
complianceScore | int complianceScore | No description in source. |
civicObligationsComplete | int civicObligationsComplete | No description in source. |
juryServiceEligible | int juryServiceEligible | No description in source. |
juryServiceCompleted | int juryServiceCompleted | No description in source. |
publicRecordsConsent | int publicRecordsConsent | No description in source. |
privacyPreferenceLevel | int privacyPreferenceLevel | No description in source. |
CitizenLifeStageGoalsAndPersonalStatusStats #sleela 2.5 (lib/citizen/CitizenLifeStageGoalsAndPersonalStatusStats.sleela)
CitizenLifeStageGoalsAndPersonalStatusStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
lifeSatisfaction | int lifeSatisfaction | No description in source. |
happiness | int happiness | No description in source. |
morale | int morale | No description in source. |
motivation | int motivation | No description in source. |
futureOutlook | int futureOutlook | No description in source. |
personalGoalProgress | int personalGoalProgress | No description in source. |
retirementStatus | int retirementStatus | No description in source. |
caregiverStatus | int caregiverStatus | No description in source. |
parentingStatus | int parentingStatus | No description in source. |
studentStatus | int studentStatus | No description in source. |
veteranStatus | int veteranStatus | No description in source. |
newcomerStatus | int newcomerStatus | No description in source. |
displacedStatus | int displacedStatus | No description in source. |
disasterExposure | int disasterExposure | No description in source. |
emergencyPreparedness | int emergencyPreparedness | No description in source. |
resilienceAfterCrisis | int resilienceAfterCrisis | No description in source. |
lastSurveyYear | int lastSurveyYear | No description in source. |
dataCompleteness | int dataCompleteness | No description in source. |
dataConfidence | int dataConfidence | No description in source. |
CitizenMobilityTransportAndEnvironmentalImpactStats #sleela 2.5 (lib/citizen/CitizenMobilityTransportAndEnvironmentalImpactStats.sleela)
CitizenMobilityTransportAndEnvironmentalImpactStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
primaryTransportMode | string primaryTransportMode | No description in source. |
hasDrivingLicense | int hasDrivingLicense | No description in source. |
hasVehicle | int hasVehicle | No description in source. |
commuteMinutes | int commuteMinutes | No description in source. |
commuteDistanceMeters | int commuteDistanceMeters | No description in source. |
walkingAbility | int walkingAbility | No description in source. |
cyclingAbility | int cyclingAbility | No description in source. |
transitUseDaysPerWeek | int transitUseDaysPerWeek | No description in source. |
transportReliability | int transportReliability | No description in source. |
mobilityAccess | int mobilityAccess | No description in source. |
travelIndependence | int travelIndependence | No description in source. |
estimatedCarbonKgPerMonth | int estimatedCarbonKgPerMonth | No description in source. |
energyConservation | int energyConservation | No description in source. |
recyclingParticipation | int recyclingParticipation | No description in source. |
environmentalStewardship | int environmentalStewardship | No description in source. |
CitizenPersonalFinanceAndEconomicResilienceStats #sleela 2.5 (lib/citizen/CitizenPersonalFinanceAndEconomicResilienceStats.sleela)
CitizenPersonalFinanceAndEconomicResilienceStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
cashBalanceCents | long cashBalanceCents | No description in source. |
bankBalanceCents | long bankBalanceCents | No description in source. |
savingsCents | long savingsCents | No description in source. |
investmentValueCents | long investmentValueCents | No description in source. |
debtBalanceCents | long debtBalanceCents | No description in source. |
monthlyDebtPaymentCents | long monthlyDebtPaymentCents | No description in source. |
monthlyExpensesCents | long monthlyExpensesCents | No description in source. |
monthlyHousingCostCents | long monthlyHousingCostCents | No description in source. |
monthlyFoodCostCents | long monthlyFoodCostCents | No description in source. |
monthlyTransportCostCents | long monthlyTransportCostCents | No description in source. |
monthlyHealthcareCostCents | long monthlyHealthcareCostCents | No description in source. |
monthlyUtilityCostCents | long monthlyUtilityCostCents | No description in source. |
creditLimitCents | long creditLimitCents | No description in source. |
creditScore | int creditScore | No description in source. |
financialStress | int financialStress | No description in source. |
emergencyFundMonths | int emergencyFundMonths | No description in source. |
povertyRisk | int povertyRisk | No description in source. |
foodSecurity | int foodSecurity | No description in source. |
economicResilience | int economicResilience | No description in source. |
taxCompliance | int taxCompliance | No description in source. |
taxBracket | int taxBracket | No description in source. |
taxRateBasisPoints | int taxRateBasisPoints | No description in source. |
receivesPublicBenefits | int receivesPublicBenefits | No description in source. |
publicBenefitsCentsPerMonth | long publicBenefitsCentsPerMonth | No description in source. |
pensionEligibility | int pensionEligibility | No description in source. |
retirementReadiness | int retirementReadiness | No description in source. |
financialDependents | int financialDependents | No description in source. |
CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats #sleela 2.5 (lib/citizen/CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats.sleela)
CitizenPersonalityAbilitiesAndPersonalCapabilitiesStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
INT | int INT | No description in source. |
CON | int CON | No description in source. |
WIS | int WIS | No description in source. |
CHA | int CHA | No description in source. |
STR | int STR | No description in source. |
DEX | int DEX | No description in source. |
EMP | int EMP | No description in source. |
WILL | int WILL | No description in source. |
LCK | int LCK | No description in source. |
creativity | int creativity | No description in source. |
adaptability | int adaptability | No description in source. |
reliability | int reliability | No description in source. |
conscientiousness | int conscientiousness | No description in source. |
curiosity | int curiosity | No description in source. |
patience | int patience | No description in source. |
emotionalStability | int emotionalStability | No description in source. |
conflictResolution | int conflictResolution | No description in source. |
civicMindedness | int civicMindedness | No description in source. |
trustworthiness | int trustworthiness | No description in source. |
riskTolerance | int riskTolerance | No description in source. |
leadership | int leadership | No description in source. |
teamwork | int teamwork | No description in source. |
communication | int communication | No description in source. |
negotiation | int negotiation | No description in source. |
problemSolving | int problemSolving | No description in source. |
CitizenPhysicalHealthAndDailyWellbeingStats #sleela 2.5 (lib/citizen/CitizenPhysicalHealthAndDailyWellbeingStats.sleela)
CitizenPhysicalHealthAndDailyWellbeingStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
healthScore | int healthScore | No description in source. |
maxHealthScore | int maxHealthScore | No description in source. |
fitness | int fitness | No description in source. |
mobility | int mobility | No description in source. |
vision | int vision | No description in source. |
hearing | int hearing | No description in source. |
speech | int speech | No description in source. |
nutrition | int nutrition | No description in source. |
hydration | int hydration | No description in source. |
sleepQuality | int sleepQuality | No description in source. |
stressLevel | int stressLevel | No description in source. |
mentalWellbeing | int mentalWellbeing | No description in source. |
physicalWellbeing | int physicalWellbeing | No description in source. |
chronicConditionCount | int chronicConditionCount | No description in source. |
acuteConditionSeverity | int acuteConditionSeverity | No description in source. |
injurySeverity | int injurySeverity | No description in source. |
infectionRisk | int infectionRisk | No description in source. |
vaccinationStatus | int vaccinationStatus | No description in source. |
healthcareAccess | int healthcareAccess | No description in source. |
healthInsuranceCoverage | int healthInsuranceCoverage | No description in source. |
medicationAdherence | int medicationAdherence | No description in source. |
substanceRisk | int substanceRisk | No description in source. |
disabilitySupportLevel | int disabilitySupportLevel | No description in source. |
CitizenSchemaAndRulesMetadataStats #sleela 2.5 (lib/citizen/CitizenSchemaAndRulesMetadataStats.sleela)
CitizenSchemaAndRulesMetadataStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
schemaVersion | int schemaVersion | No description in source. |
rulesetId | int rulesetId | No description in source. |
CitizenStats #sleela 2.5 (lib/citizen/seem/CitizenStats.sleela)
CitizenStats class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
citizenId | string citizenId | Identity and demographic profile |
legalName | string legalName | No description in source. |
preferredName | string preferredName | No description in source. |
householdId | string householdId | No description in source. |
familyId | string familyId | No description in source. |
citizenshipCode | string citizenshipCode | No description in source. |
residencyCode | string residencyCode | No description in source. |
birthPlace | string birthPlace | No description in source. |
currentAddress | string currentAddress | No description in source. |
postalCode | string postalCode | No description in source. |
municipality | string municipality | No description in source. |
region | string region | No description in source. |
countryCode | string countryCode | No description in source. |
primaryLanguage | string primaryLanguage | No description in source. |
ageYears | int ageYears | No description in source. |
ageMonths | int ageMonths | No description in source. |
birthYear | int birthYear | No description in source. |
birthMonth | int birthMonth | No description in source. |
birthDay | int birthDay | No description in source. |
lifeExpectancyYears | int lifeExpectancyYears | No description in source. |
householdSize | int householdSize | No description in source. |
dependents | int dependents | No description in source. |
isAlive | int isAlive | No description in source. |
isResident | int isResident | No description in source. |
isCitizen | int isCitizen | No description in source. |
isRegisteredVoter | int isRegisteredVoter | No description in source. |
isEmancipated | int isEmancipated | No description in source. |
hasDisability | int hasDisability | No description in source. |
accessibilityNeeds | int accessibilityNeeds | No description in source. |
healthScore | int healthScore | Physical health and daily wellbeing (game-defined scales) |
maxHealthScore | int maxHealthScore | No description in source. |
fitness | int fitness | No description in source. |
mobility | int mobility | No description in source. |
vision | int vision | No description in source. |
hearing | int hearing | No description in source. |
speech | int speech | No description in source. |
nutrition | int nutrition | No description in source. |
hydration | int hydration | No description in source. |
sleepQuality | int sleepQuality | No description in source. |
stressLevel | int stressLevel | No description in source. |
mentalWellbeing | int mentalWellbeing | No description in source. |
physicalWellbeing | int physicalWellbeing | No description in source. |
chronicConditionCount | int chronicConditionCount | No description in source. |
acuteConditionSeverity | int acuteConditionSeverity | No description in source. |
injurySeverity | int injurySeverity | No description in source. |
infectionRisk | int infectionRisk | No description in source. |
vaccinationStatus | int vaccinationStatus | No description in source. |
healthcareAccess | int healthcareAccess | No description in source. |
healthInsuranceCoverage | int healthInsuranceCoverage | No description in source. |
medicationAdherence | int medicationAdherence | No description in source. |
substanceRisk | int substanceRisk | No description in source. |
disabilitySupportLevel | int disabilitySupportLevel | No description in source. |
creativity | int creativity | No description in source. |
adaptability | int adaptability | No description in source. |
reliability | int reliability | No description in source. |
conscientiousness | int conscientiousness | No description in source. |
curiosity | int curiosity | No description in source. |
patience | int patience | No description in source. |
emotionalStability | int emotionalStability | No description in source. |
conflictResolution | int conflictResolution | No description in source. |
civicMindedness | int civicMindedness | No description in source. |
trustworthiness | int trustworthiness | No description in source. |
riskTolerance | int riskTolerance | No description in source. |
leadership | int leadership | No description in source. |
teamwork | int teamwork | No description in source. |
communication | int communication | No description in source. |
negotiation | int negotiation | No description in source. |
problemSolving | int problemSolving | No description in source. |
educationLevel | int educationLevel | Education and knowledge |
yearsOfEducation | int yearsOfEducation | No description in source. |
literacy | int literacy | No description in source. |
numeracy | int numeracy | No description in source. |
digitalLiteracy | int digitalLiteracy | No description in source. |
financialLiteracy | int financialLiteracy | No description in source. |
civicLiteracy | int civicLiteracy | No description in source. |
scientificLiteracy | int scientificLiteracy | No description in source. |
highestQualification | int highestQualification | No description in source. |
schoolAttendanceRate | int schoolAttendanceRate | No description in source. |
academicPerformance | int academicPerformance | No description in source. |
vocationalTraining | int vocationalTraining | No description in source. |
apprenticeshipProgress | int apprenticeshipProgress | No description in source. |
certifications | int certifications | No description in source. |
skillsCount | int skillsCount | No description in source. |
languagesSpoken | int languagesSpoken | No description in source. |
readingProficiency | int readingProficiency | No description in source. |
writingProficiency | int writingProficiency | No description in source. |
mathematicsProficiency | int mathematicsProficiency | No description in source. |
researchSkill | int researchSkill | No description in source. |
teachingSkill | int teachingSkill | No description in source. |
lifelongLearning | int lifelongLearning | No description in source. |
educationDebtCents | int educationDebtCents | No description in source. |
employerId | string employerId | Employment, work, and professional life |
occupationCode | string occupationCode | No description in source. |
industryCode | string industryCode | No description in source. |
employmentStatus | string employmentStatus | No description in source. |
employed | int employed | No description in source. |
selfEmployed | int selfEmployed | No description in source. |
seekingWork | int seekingWork | No description in source. |
workExperienceYears | int workExperienceYears | No description in source. |
tenureMonths | int tenureMonths | No description in source. |
hoursWorkedPerWeek | int hoursWorkedPerWeek | No description in source. |
contractedHoursPerWeek | int contractedHoursPerWeek | No description in source. |
productivity | int productivity | No description in source. |
workQuality | int workQuality | No description in source. |
attendanceReliability | int attendanceReliability | No description in source. |
jobSatisfaction | int jobSatisfaction | No description in source. |
careerProgress | int careerProgress | No description in source. |
leadershipAtWork | int leadershipAtWork | No description in source. |
workplaceSafety | int workplaceSafety | No description in source. |
remoteWorkCapability | int remoteWorkCapability | No description in source. |
unionMembership | int unionMembership | No description in source. |
unemploymentMonths | int unemploymentMonths | No description in source. |
grossIncomeCentsPerMonth | int grossIncomeCentsPerMonth | No description in source. |
netIncomeCentsPerMonth | int netIncomeCentsPerMonth | No description in source. |
annualIncomeCents | int annualIncomeCents | No description in source. |
benefitsValueCentsPerMonth | int benefitsValueCentsPerMonth | No description in source. |
pensionContributionCentsPerMonth | int pensionContributionCentsPerMonth | No description in source. |
incomeStability | int incomeStability | No description in source. |
jobSecurity | int jobSecurity | No description in source. |
workLifeBalance | int workLifeBalance | No description in source. |
cashBalanceCents | int cashBalanceCents | Personal finance and economic resilience |
bankBalanceCents | int bankBalanceCents | No description in source. |
savingsCents | int savingsCents | No description in source. |
investmentValueCents | int investmentValueCents | No description in source. |
debtBalanceCents | int debtBalanceCents | No description in source. |
monthlyDebtPaymentCents | int monthlyDebtPaymentCents | No description in source. |
monthlyExpensesCents | int monthlyExpensesCents | No description in source. |
monthlyHousingCostCents | int monthlyHousingCostCents | No description in source. |
monthlyFoodCostCents | int monthlyFoodCostCents | No description in source. |
monthlyTransportCostCents | int monthlyTransportCostCents | No description in source. |
monthlyHealthcareCostCents | int monthlyHealthcareCostCents | No description in source. |
monthlyUtilityCostCents | int monthlyUtilityCostCents | No description in source. |
creditLimitCents | int creditLimitCents | No description in source. |
creditScore | int creditScore | No description in source. |
financialStress | int financialStress | No description in source. |
emergencyFundMonths | int emergencyFundMonths | No description in source. |
povertyRisk | int povertyRisk | No description in source. |
foodSecurity | int foodSecurity | No description in source. |
economicResilience | int economicResilience | No description in source. |
taxCompliance | int taxCompliance | No description in source. |
taxBracket | int taxBracket | No description in source. |
taxRateBasisPoints | int taxRateBasisPoints | No description in source. |
receivesPublicBenefits | int receivesPublicBenefits | No description in source. |
publicBenefitsCentsPerMonth | int publicBenefitsCentsPerMonth | No description in source. |
pensionEligibility | int pensionEligibility | No description in source. |
retirementReadiness | int retirementReadiness | No description in source. |
financialDependents | int financialDependents | No description in source. |
housingType | string housingType | Housing, utilities, and household services |
tenureType | string tenureType | No description in source. |
housingQuality | int housingQuality | No description in source. |
housingSecurity | int housingSecurity | No description in source. |
roomsInHome | int roomsInHome | No description in source. |
peoplePerRoom | int peoplePerRoom | No description in source. |
overcrowdingRisk | int overcrowdingRisk | No description in source. |
homelessnessRisk | int homelessnessRisk | No description in source. |
waterAccess | int waterAccess | No description in source. |
sanitationAccess | int sanitationAccess | No description in source. |
electricityAccess | int electricityAccess | No description in source. |
heatingAccess | int heatingAccess | No description in source. |
coolingAccess | int coolingAccess | No description in source. |
internetAccess | int internetAccess | No description in source. |
phoneAccess | int phoneAccess | No description in source. |
wasteCollectionAccess | int wasteCollectionAccess | No description in source. |
publicTransportAccess | int publicTransportAccess | No description in source. |
distanceToHealthcare | int distanceToHealthcare | No description in source. |
distanceToSchool | int distanceToSchool | No description in source. |
neighborhoodSafety | int neighborhoodSafety | No description in source. |
neighborhoodQuality | int neighborhoodQuality | No description in source. |
environmentalQuality | int environmentalQuality | No description in source. |
householdEnergyUse | int householdEnergyUse | No description in source. |
householdWaterUse | int householdWaterUse | No description in source. |
housingAssistance | int housingAssistance | No description in source. |
socialConnection | int socialConnection | Community, relationships, and civic participation |
familySupport | int familySupport | No description in source. |
friendNetworkSize | int friendNetworkSize | No description in source. |
communityBelonging | int communityBelonging | No description in source. |
socialTrust | int socialTrust | No description in source. |
institutionalTrust | int institutionalTrust | No description in source. |
volunteerHoursPerMonth | int volunteerHoursPerMonth | No description in source. |
communityServiceHours | int communityServiceHours | No description in source. |
civicParticipation | int civicParticipation | No description in source. |
votingParticipation | int votingParticipation | No description in source. |
publicMeetingParticipation | int publicMeetingParticipation | No description in source. |
localOrganizationMemberships | int localOrganizationMemberships | No description in source. |
charitableGivingCentsPerYear | int charitableGivingCentsPerYear | No description in source. |
neighborliness | int neighborliness | No description in source. |
socialIsolationRisk | int socialIsolationRisk | No description in source. |
discriminationExposure | int discriminationExposure | No description in source. |
inclusionAccess | int inclusionAccess | No description in source. |
culturalParticipation | int culturalParticipation | No description in source. |
recreationHoursPerWeek | int recreationHoursPerWeek | No description in source. |
libraryUse | int libraryUse | No description in source. |
publicServiceSatisfaction | int publicServiceSatisfaction | No description in source. |
communityContribution | int communityContribution | No description in source. |
civilStatus | string civilStatus | Legal and administrative standing |
residencyStatus | string residencyStatus | No description in source. |
voterRegistrationStatus | string voterRegistrationStatus | No description in source. |
taxAccountId | string taxAccountId | No description in source. |
identityVerified | int identityVerified | No description in source. |
addressVerified | int addressVerified | No description in source. |
permitsHeld | int permitsHeld | No description in source. |
licensesHeld | int licensesHeld | No description in source. |
legalCaseCount | int legalCaseCount | No description in source. |
unresolvedLegalCases | int unresolvedLegalCases | No description in source. |
fineBalanceCents | int fineBalanceCents | No description in source. |
complianceScore | int complianceScore | No description in source. |
civicObligationsComplete | int civicObligationsComplete | No description in source. |
juryServiceEligible | int juryServiceEligible | No description in source. |
juryServiceCompleted | int juryServiceCompleted | No description in source. |
publicRecordsConsent | int publicRecordsConsent | No description in source. |
privacyPreferenceLevel | int privacyPreferenceLevel | No description in source. |
primaryTransportMode | string primaryTransportMode | Mobility, transport, and environmental impact |
hasDrivingLicense | int hasDrivingLicense | No description in source. |
hasVehicle | int hasVehicle | No description in source. |
commuteMinutes | int commuteMinutes | No description in source. |
commuteDistanceMeters | int commuteDistanceMeters | No description in source. |
walkingAbility | int walkingAbility | No description in source. |
cyclingAbility | int cyclingAbility | No description in source. |
transitUseDaysPerWeek | int transitUseDaysPerWeek | No description in source. |
transportReliability | int transportReliability | No description in source. |
mobilityAccess | int mobilityAccess | No description in source. |
travelIndependence | int travelIndependence | No description in source. |
estimatedCarbonKgPerMonth | int estimatedCarbonKgPerMonth | No description in source. |
energyConservation | int energyConservation | No description in source. |
recyclingParticipation | int recyclingParticipation | No description in source. |
environmentalStewardship | int environmentalStewardship | No description in source. |
deviceAccess | int deviceAccess | Digital access and safety |
computerAccess | int computerAccess | No description in source. |
broadbandQuality | int broadbandQuality | No description in source. |
onlineServiceUse | int onlineServiceUse | No description in source. |
cybersecurityAwareness | int cybersecurityAwareness | No description in source. |
digitalPrivacyAwareness | int digitalPrivacyAwareness | No description in source. |
accessibilityTechnologyAccess | int accessibilityTechnologyAccess | No description in source. |
digitalSkills | int digitalSkills | No description in source. |
digitalExclusionRisk | int digitalExclusionRisk | No description in source. |
telehealthCapability | int telehealthCapability | No description in source. |
lifeSatisfaction | int lifeSatisfaction | Life stage, goals, and personal status |
happiness | int happiness | No description in source. |
morale | int morale | No description in source. |
motivation | int motivation | No description in source. |
futureOutlook | int futureOutlook | No description in source. |
personalGoalProgress | int personalGoalProgress | No description in source. |
retirementStatus | int retirementStatus | No description in source. |
caregiverStatus | int caregiverStatus | No description in source. |
parentingStatus | int parentingStatus | No description in source. |
studentStatus | int studentStatus | No description in source. |
veteranStatus | int veteranStatus | No description in source. |
newcomerStatus | int newcomerStatus | No description in source. |
displacedStatus | int displacedStatus | No description in source. |
disasterExposure | int disasterExposure | No description in source. |
emergencyPreparedness | int emergencyPreparedness | No description in source. |
resilienceAfterCrisis | int resilienceAfterCrisis | No description in source. |
lastSurveyYear | int lastSurveyYear | No description in source. |
dataCompleteness | int dataCompleteness | No description in source. |
dataConfidence | int dataConfidence | No description in source. |
schemaVersion | int schemaVersion | Schema and rules metadata |
rulesetId | int rulesetId | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
isAdult | int isAdult() | No description in source. |
isWorkingAge | int isWorkingAge() | No description in source. |
isEmployed | int isEmployed() | No description in source. |
isFinanciallyStable | int isFinanciallyStable() | No description in source. |
hasBasicUtilities | int hasBasicUtilities() | No description in source. |
hasDigitalAccess | int hasDigitalAccess() | No description in source. |
canParticipateCivically | int canParticipateCivically() | No description in source. |
adjustHealth | int adjustHealth(int delta) | No description in source. |
setAge | int setAge(int years, int months) | No description in source. |
normalize | int normalize() | No description in source. |
ConsultingModel #sleela 2.5 (lib/citizen/character/ConsultingModel.sleela)
ConsultingModel class extends BusinessModel
ConsultingModel — sell time, dressed up as insight. Revenue is billable hours x rate, bounded by the brutal truth that there are only so many hours and consultants insist on sleeping some of them. A concrete BusinessModel: revenue scales with utilization, not headcount alone; cost is the consultants' salaries whether or not they billed. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
consultants | int consultants | people who can bill |
billableHours | int billableHours | total hours actually billed this month |
rateCents | int rateCents | billing rate per hour |
salaryPerHeadCents | int salaryPerHeadCents | monthly salary cost per consultant |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int heads, int hours, int rate, int salaryPerHead) | No description in source. |
utilizationPercent | int utilizationPercent() | Utilization as a percent of a nominal 160-hour month across all heads. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
FederalReserveID #sleela 2.5 (lib/citizen/FederalReserveID.sleela)
FederalReserveID class
Defines FederalReserveID, the central-bank identity Master Class — the number by which the Federal Reserve pretends to know a Citizen personally. It issues and validates a civic clearing ID and maps the money to one of the twelve Federal Reserve Districts. FederalReserveID is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is a sidecar owned by Citizen and the single source of truth for Federal Reserve details in this package: the twelve District codes (01 Boston .. 12 San Francisco), the mapping from an ABA routing prefix to a District, and the issuance of a deterministic, obviously-synthetic clearing identifier. No real identifiers are generated — the central bank's holiday card list remains, mercifully, fictional. Family: citizen. Clearing crosses an explicit bridge to the ledger.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
MODULE | static final String MODULE = "FederalReserveID" | No description in source. |
DISTRICT_BOSTON | static final int DISTRICT_BOSTON = 1 | The twelve Federal Reserve Districts. Yes, there are exactly twelve. No, nobody remembers why Missouri got two. |
DISTRICT_NEW_YORK | static final int DISTRICT_NEW_YORK = 2 | No description in source. |
DISTRICT_PHILADELPHIA | static final int DISTRICT_PHILADELPHIA = 3 | No description in source. |
DISTRICT_CLEVELAND | static final int DISTRICT_CLEVELAND = 4 | No description in source. |
DISTRICT_RICHMOND | static final int DISTRICT_RICHMOND = 5 | No description in source. |
DISTRICT_ATLANTA | static final int DISTRICT_ATLANTA = 6 | No description in source. |
DISTRICT_CHICAGO | static final int DISTRICT_CHICAGO = 7 | No description in source. |
DISTRICT_ST_LOUIS | static final int DISTRICT_ST_LOUIS = 8 | No description in source. |
DISTRICT_MINNEAPOLIS | static final int DISTRICT_MINNEAPOLIS = 9 | No description in source. |
DISTRICT_KANSAS_CITY | static final int DISTRICT_KANSAS_CITY = 10 | No description in source. |
DISTRICT_DALLAS | static final int DISTRICT_DALLAS = 11 | No description in source. |
DISTRICT_SAN_FRANCISCO | static final int DISTRICT_SAN_FRANCISCO = 12 | No description in source. |
DISTRICT_COUNT | static final int DISTRICT_COUNT = 12 | No description in source. |
loadedFlag | int loadedFlag | No description in source. |
issued | boolean issued | No description in source. |
idNumber | String idNumber | synthetic clearing ID: FRS-<district>-<serial> |
district | int district | one of DISTRICT_* |
serial | int serial | the citizen's spot in a very long, patient line |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
load | void load() | No description in source. |
loaded | boolean loaded() | No description in source. |
moduleName | String moduleName() | No description in source. |
issue | void issue(String legalName) | Issue a Fed clearing ID to a named citizen. Deterministic + fake on purpose. |
assignDistrict | void assignDistrict(int whichDistrict) | Re-home the citizen to a specific District (e.g. they moved to Dallas). |
districtOfRouting | int districtOfRouting(String routing) | Map an ABA routing number to its Federal Reserve District. The first two digits (01..12) ARE the District; anything else is a rounding error. |
districtName | String districtName() | A friendly name for the District, for forms and small talk alike. |
valid | boolean valid() | No description in source. |
number | String number() | No description in source. |
currentDistrict | int currentDistrict() | No description in source. |
routingPrefix | int routingPrefix(String routing) | Turn the first two characters of the routing string into an int 0..99. |
nameSerial | int nameSerial(String legalName) | Fold a name into a stable 6-digit serial. Not secure; delightfully not. |
digitValue | int digitValue(String c) | Map a single-character String to its digit value 0..9, or -1 if not a digit. |
charWeight | int charWeight(String c) | A stable per-character weight for serial folding. Digits use their value; everything else gets a constant nudge so names still spread out nicely. |
describe | String describe() | No description in source. |
FranchiseModel #sleela 2.5 (lib/citizen/character/FranchiseModel.sleela)
FranchiseModel class extends BusinessModel
FranchiseModel — don't run the shops; rent out the right to BE the shop. Revenue is an ongoing royalty on each franchisee's sales plus a one-time fee amortized across the month, and the brand does the rest. A concrete BusinessModel. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
outlets | int outlets | franchised locations |
avgOutletSalesCents | int avgOutletSalesCents | average monthly sales per outlet |
royaltyPercent | int royaltyPercent | the franchisor's royalty (0..100) |
supportCostCents | int supportCostCents | monthly cost to support one outlet |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int locations, int avgSales, int royalty, int supportCost) | No description in source. |
networkSales | int networkSales() | Total sales across the whole brand this month. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
FreemiumModel #sleela 2.5 (lib/citizen/character/FreemiumModel.sleela)
FreemiumModel class extends BusinessModel
FreemiumModel — a large crowd uses the product for free, a small fraction converts to paid, and that fraction quietly funds everyone else. The business of giving most of it away on purpose. A concrete BusinessModel: revenue comes only from the converted fraction; cost scales with the whole free-plus-paid population. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
freeUsers | int freeUsers | the generous majority |
conversionPercent | int conversionPercent | share of free users who go paid (0..100) |
priceCents | int priceCents | monthly price for a converted user |
serveCostCents | int serveCostCents | cost to serve ONE user (free or paid) per month |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int free, int conversion, int price, int serveCost) | No description in source. |
paidUsers | int paidUsers() | No description in source. |
totalUsers | int totalUsers() | No description in source. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
Industry #sleela 2.5 (lib/citizen/Industry.sleela)
Industry class
Defines Industry, the civic-sector Master Class — the honest living a Citizen claims to make. It models which slice of "the whole economy" a person belongs to and what that slice pays per cycle. Industry is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is a sidecar owned by Citizen: Citizen models the person; Industry models their place in the great churning machine of commerce — and whether that machine currently remembers their name. It covers the whole industry at the sector level, from the people who grow the food to the people who grow the spreadsheets. Family: citizen. Economic data crosses an explicit bridge to the ledger.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
MODULE | static final String MODULE = "Industry" | No description in source. |
SECTOR_NONE | static final int SECTOR_NONE = 0 | The whole economy, abridged to fit on one business card. between jobs; "consulting" |
SECTOR_AGRICULTURE | static final int SECTOR_AGRICULTURE = 1 | feeds everyone, thanked by few |
SECTOR_MINING | static final int SECTOR_MINING = 2 | digs up tomorrow's shortage |
SECTOR_MANUFACTURING | static final int SECTOR_MANUFACTURING = 3 | makes the thing in the box |
SECTOR_ENERGY | static final int SECTOR_ENERGY = 4 | keeps the lights, bills on |
SECTOR_CONSTRUCTION | static final int SECTOR_CONSTRUCTION = 5 | runs 3 weeks over, always |
SECTOR_RETAIL | static final int SECTOR_RETAIL = 6 | "did you find everything okay?" |
SECTOR_TRANSPORT | static final int SECTOR_TRANSPORT = 7 | the box, now moving |
SECTOR_FINANCE | static final int SECTOR_FINANCE = 8 | moves money, keeps a slice |
SECTOR_HEALTHCARE | static final int SECTOR_HEALTHCARE = 9 | the only sector that bills you |
SECTOR_EDUCATION | static final int SECTOR_EDUCATION = 10 | for existing near it underpaid, over-caffeinated |
SECTOR_TECHNOLOGY | static final int SECTOR_TECHNOLOGY = 11 | "we've gone fully remote" |
SECTOR_GOVERNMENT | static final int SECTOR_GOVERNMENT = 12 | the sector that counts the rest |
SECTOR_COUNT | static final int SECTOR_COUNT = 13 | No description in source. |
loadedFlag | int loadedFlag | No description in source. |
sector | int sector | one of SECTOR_* |
wageCents | int wageCents | pay per cycle, in cents, so nobody loses a penny |
onPayroll | boolean onPayroll | whether the machine currently remembers your name |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
load | void load() | No description in source. |
loaded | boolean loaded() | No description in source. |
moduleName | String moduleName() | No description in source. |
employ | void employ(int whichSector, int cents) | Join the workforce in a given sector at a given wage. Welcome aboard. |
layOff | void layOff() | "We're going in a different direction." Famous last words of a Friday. |
giveRaise | void giveRaise(int cents) | A modest raise. The economy's rare act of kindness. |
employed | boolean employed() | No description in source. |
wage | int wage() | No description in source. |
currentSector | int currentSector() | No description in source. |
sectorName | String sectorName() | A human-readable job title, because SECTOR_8 impresses no one at dinner. |
yn | String yn(boolean b) | No description in source. |
describe | String describe() | No description in source. |
LicensingModel #sleela 2.5 (lib/citizen/character/LicensingModel.sleela)
LicensingModel class extends BusinessModel
LicensingModel — own the idea, let others do the sweating. The Character licenses intellectual property and collects a royalty per licensed unit sold by someone else, with almost no marginal cost of its own. A concrete BusinessModel: wonderfully cheap to run, entirely dependent on the licensee's hustle. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
licensedUnits | int licensedUnits | units the licensees sold this month |
royaltyPerUnitCents | int royaltyPerUnitCents | royalty collected per licensed unit |
ipUpkeepCents | int ipUpkeepCents | monthly cost to maintain/defend the IP |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int unitsLicensed, int royaltyPerUnit, int ipUpkeep) | No description in source. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
ManufacturingModel #sleela 2.5 (lib/citizen/character/ManufacturingModel.sleela)
ManufacturingModel class extends BusinessModel
ManufacturingModel — make the physical thing at scale. Revenue is units shipped x wholesale price; cost is variable material/labor per unit plus a large, stubborn fixed cost for the factory that does not care whether the line ran today. A concrete BusinessModel: the fixed cost is the drama; volume is the cure. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
unitsProduced | int unitsProduced | units shipped this month |
wholesalePriceCents | int wholesalePriceCents | price per unit to the buyer |
variableCostCents | int variableCostCents | material + labor per unit |
fixedPlantCents | int fixedPlantCents | monthly fixed factory cost (regardless of volume) |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int produced, int wholesalePrice, int variableCost, int fixedPlant) | No description in source. |
breakEvenUnits | int breakEvenUnits() | Break-even volume: units needed to cover the fixed plant cost alone. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
MarketplaceModel #sleela 2.5 (lib/citizen/character/MarketplaceModel.sleela)
MarketplaceModel class extends BusinessModel
MarketplaceModel — the Character owns neither the goods nor the buyers; it owns the handshake, and takes a cut of every one. Revenue is a commission on gross merchandise value (GMV). A concrete BusinessModel: revenue = GMV x take-rate; cost scales with the number of transactions it has to shepherd. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
transactions | int transactions | deals brokered this month |
avgOrderCents | int avgOrderCents | average value of one order |
takeRatePercent | int takeRatePercent | the house's cut (0..100) |
opCostCents | int opCostCents | operating cost per transaction (support, fraud, etc.) |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int txns, int avgOrder, int takeRate, int opCost) | No description in source. |
gmv | int gmv() | Gross merchandise value: everything that flowed through the marketplace. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
RetailModel #sleela 2.5 (lib/citizen/character/RetailModel.sleela)
RetailModel class extends BusinessModel
RetailModel — buy a thing, mark it up, sell it to a person who wants it today. Revenue is units x retail price; cost is units x what you paid, plus the rent on the shop with the nice window. A concrete BusinessModel. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
unitsSold | int unitsSold | items sold this month |
retailPriceCents | int retailPriceCents | price on the shelf |
unitCostCents | int unitCostCents | what the item cost to acquire |
overheadCents | int overheadCents | monthly rent/staff/lights |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int sold, int retailPrice, int unitCost, int overhead) | No description in source. |
unitMargin | int unitMargin() | Margin per unit, in case anyone asks how thin it really is. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
SaaSModel #sleela 2.5 (lib/citizen/character/SaaSModel.sleela)
SaaSModel class extends BusinessModel
SaaSModel — software as a service, billed per seat per month, priced across tiers. Like Subscription's more ambitious cousin: seats are split across a basic and a premium tier, each at its own price, and the cloud bill scales with the whole seat count. A concrete BusinessModel. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
basicSeats | int basicSeats | seats on the basic tier |
premiumSeats | int premiumSeats | seats on the premium tier |
basicPriceCents | int basicPriceCents | monthly price per basic seat |
premiumPriceCents | int premiumPriceCents | monthly price per premium seat |
infraCostPerSeatCents | int infraCostPerSeatCents | cloud/infra cost per seat per month |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int basic, int premium, int basicPrice, int premiumPrice, int infraPerSeat) | No description in source. |
totalSeats | int totalSeats() | No description in source. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
SLPackage #sleela 2.5 (lib/citizen/SLPackage.sleela)
SLPackage class
Defines the SLeeLa standard-library package for citizen.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
packageName | String packageName | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
configure | void configure(String name) | No description in source. |
name | String name() | No description in source. |
available | boolean available() | No description in source. |
SubscriptionModel #sleela 2.5 (lib/citizen/character/SubscriptionModel.sleela)
SubscriptionModel class extends BusinessModel
SubscriptionModel — recurring revenue from subscribers who each pay the same price every month and leave at a steady churn rate. The classic "predictable until it isn't" business. A concrete BusinessModel: subclass, declare identity in setUp(), and override the revenue/cost hooks. Revenue is subscribers x price, minus the ones who quietly cancelled this month. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
subscribers | int subscribers | paying seats right now |
priceCents | int priceCents | monthly price per subscriber |
churnPercent | int churnPercent | share who cancel each month (0..100) |
serviceCostCents | int serviceCostCents | cost to serve one subscriber per month |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int seats, int price, int churn, int serviceCost) | No description in source. |
retained | int retained() | Subscribers who are still around after this month's churn pay full price. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |
WholesaleModel #sleela 2.5 (lib/citizen/character/WholesaleModel.sleela)
WholesaleModel class extends BusinessModel
WholesaleModel — sell in bulk to the people who sell to people. Thin margin per case, enormous volume, and a loyalty to the pallet jack that borders on romantic. A concrete BusinessModel: revenue is cases x case-price; the per-case margin is slim by design. Family: character.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
cases | int cases | cases moved this month |
casePriceCents | int casePriceCents | price per case to the retailer |
caseCostCents | int caseCostCents | cost per case from the manufacturer |
logisticsCents | int logisticsCents | monthly warehouse + freight overhead |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
setUp | void setUp(int casesSold, int casePrice, int caseCost, int logistics) | No description in source. |
monthlyRevenue | int monthlyRevenue() | No description in source. |
monthlyCost | int monthlyCost() | No description in source. |