Event - atom description

<- back to all classes

General description

• Data for all types of events used in the game.

Properties description

Name	Type	Default value / Obligatory	Description
image	texture	obligatory	Event image.
title	locale string	empty	Event title.
text	locale string	obligatory	Event text.
buttons	vec_1D[locale string]	obligatory	List of buttons labels.
params	vec_1D[int]	empty vec	Event parameters.

Types of events

First residents

• Triggered by accommodation of first settlers in the city.
• All button are acknowledgements.

Leaving residents

• Triggered by leaving settlers from leveled down houses.
• 2nd button is goto house button.

Returning residents

• Triggered by accommodation of settlers after some of them left city in the past.
• All button are acknowledgements.

Cannot reach houses

• Triggered by settlers which cannot reach empty houses because there is no road to them.
• All button are acknowledgements.

New request

Request failed

New demand

Demand failed

New request

Mission introduction

New request

City unlocked

No money

Example

-- generals

atom ('event.first_residents',
{
    image = "images/ui/events/first_residents.png",
    title = "@event.first_residents.title",
    text = "@event.first_residents.text",
    buttons = {"@event.first_residents.button"},
})

atom ('event.leaving_residents',
{
    image = "images/ui/events/leaving_residents.png",
    title = "@event.leaving_residents.title",
    text = "@event.leaving_residents.text",
    buttons = {
        "@event.leaving_residents.button.a",
        "@event.leaving_residents.button.b",
    },
})

atom ('event.returning_residents',
{
    image = "images/ui/events/returning_residents.png",
    title = "@event.returning_residents.title",
    text = "@event.returning_residents.text",
    buttons = {"@event.returning_residents.button"},
})

atom ('event.no_path_residents',
{
    image = "images/ui/events/no_path_residents.png",
    title = "@event.no_path_residents.title",
    text = "@event.no_path_residents.text",
    buttons = {"@event.no_path_residents.button"},
})

-- request

atom ('event.request',
{
    image = "images/ui/events/request.png",
    title = "@event.request.title",
    text = "@event.request.text",
    buttons = {
        "@event.request.button.a",
        "@event.request.button.b",
        "@event.request.button.c",
    },
})

atom ('event.request.failed',
{
    image = "images/ui/events/request_failed.png",
    title = "@event.request.failed.title",
    text = "@event.request.failed.text",
    buttons = {
        "@event.request.failed.button.a",
        "@event.request.failed.button.b",
    },
})

-- money events

atom ('event.money.nothing',
{
    image = "images/ui/events/money.png",
    title = "@event.money.title",
    text = "@event.money.nothing.text",
    buttons = {"@event.money.nothing.button"},
})

atom ('event.money.nz.1',
{
    image = "images/ui/events/money.png",
    title = "@event.money.title",
    text = "@event.money.people.text",
    buttons = {"@event.money.people.button"},
    params = {1000},
})