/tg/ Station 13 - Modules - TypesVar Details - Proc Details

stock_market_event

Vars

circumstanceA list of strings selected from the event that's used to describe the event in the news.
company_nameA list of company names to use for the event and the circumstance.
matWhat material is affected by the event?
nameThe name of the event, used to describe it in the news.
price_maximumConstant to multiply the original material value by to get the new maximum value.
price_minimumConstant to multiply the original material value by to get the new minimum value, unless the material has a minimum override.
trend_durationWhen this event is triggered, for how long will its effects last?
trend_valueWhen this event is ongoing, what direction will the price trend in?

Procs

create_newsThis proc is called to create a news string for the event, which is passed along to SSstock_market to be appended to the automatic newscaster messages.
end_eventWhen a stock_market_event is ended, this proc is called to apply any final effects and clean up anything that needs to be cleaned up.
handleThis proc is called every tick while the event is ongoing by SSstock_market.
start_eventWhen a new stock_market_event is created, this proc is called to set up the event if there's anything that needs to happen upon it starting. @param _mat The material that this event will affect.

Var Details

circumstance

A list of strings selected from the event that's used to describe the event in the news.

company_name

A list of company names to use for the event and the circumstance.

mat

What material is affected by the event?

name

The name of the event, used to describe it in the news.

price_maximum

Constant to multiply the original material value by to get the new maximum value.

price_minimum

Constant to multiply the original material value by to get the new minimum value, unless the material has a minimum override.

trend_duration

When this event is triggered, for how long will its effects last?

trend_value

When this event is ongoing, what direction will the price trend in?

Proc Details

create_news

This proc is called to create a news string for the event, which is passed along to SSstock_market to be appended to the automatic newscaster messages.

end_event

When a stock_market_event is ended, this proc is called to apply any final effects and clean up anything that needs to be cleaned up.

handle

This proc is called every tick while the event is ongoing by SSstock_market.

start_event

When a new stock_market_event is created, this proc is called to set up the event if there's anything that needs to happen upon it starting. @param _mat The material that this event will affect.