How it works - Event plugin

[Skorak]

I've noticed that people often don't really know what is possible with the plugins we have. This causes them to be unable to make proper suggestions or requests to staff. Considering the demand for events I'd like to start with explaining the event plugin. This might be just listing out the script parameters but that is really how these things work.

There is two types of events that can interact with each other in some manners we'll get to later.
[TradeEvent] and [CombatEvent]

I hope this will help people submit event suggestions or requests and also understand what tools staff uses for the events in question. This does not explain how you calculate bonuses or set up good events in general.
Open the spoilers if you want to look at an empty template.

---

[TradeEvent]
id =

This is the internal name for the event

name =

This is the name that displays to the player "You are participating in NAME event"

url =

This used to be for an automated leaderboard. Is now typically used to provide documentation for the event

startbase =

The internal name for the base where you buy the commodity. For example: li01_01_base

endbase =

The internal name for the base where you sell the commodity. For example rh01_05_base

bonus =

Straightforward. Credits you get per sold unit of the event commodity

objectivemax =

How many units will the game pay out a bonus for

commodity =

The internal name for the commodity. For example: commodity_water

;;;Next two lines are only used if endpoint is intended to be a POB
;flhookbase =
;flhookbasename =

In theory you can use pobs as an event destination. Kind of wonky. I used it only once. But it works. Sadly only counts the amount of trips and not the amount of cargo transported per person for some reason.

limited =

Should this be limited to specific IDs? 0(false) or 1(true)

allowedid =

in case the event is limited = 1, then list the IDs here. New line with 'allowedid = ' for each ID. Internal names like dsy_license_co_ss_grp

TradeEvent

;[TradeEvent]
id =
name =
url =
startbase =
endbase =
bonus =
objectivemax =
commodity =
;;;Next two lines are only used if endpoint is intended to be a POB
;;flhookbase =
;;flhookbasename =
limited =
;allowedid =

---

[CombatEvent]

This is the internal name for the event

name =

This is the name that displays to the player "You are participating in NAME event"

url =

This used to be for an automated leaderboard. Is now typically used to provide documentation for the event

objectivemax =

How many kills are allowed before the event ends

system =

Internal name of the systems this event is active in. for example li01. New line per system each starting with 'system = '

playersonly =

If this is valid against players only or npcs too. 0(false) or 1(true) - Set this to 1 always

bonusplayer =

The amount of credits you get for a kill

allowedid =

The internal name of the IDs allowed to collect the bonus. For example: dsy_license_fc_lr_grp

targetid =

The internal name of the IDs that players are allowed to collect on. For example: dsy_license_co_ss_grp
This is where it gets interesting too. This ID can also be a trade event. Making only people registered to the event give a reward.

;;;Next two lines are only used if 'playersonly = 0'
;;targetnpc =
;;bonusNPC =

This feature is difficult to regulate and is thus never used. Npcs don't carry IDs.

CombatEvent

[CombatEvent]
id =
name =
url =
objectivemax =
system =
playersonly =
bonusplayer =
allowedid =
targetid =
;;;Next two lines are only used if 'playersonly = 0'
;;targetnpc =
;;bonusNPC =

---