编辑“Template:Event/doc”

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
    <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
__NOTOC__
'''Event''' can be used to diplay description, trigger, trigger condition and options of an event in a compact infobox.

== Parameter ==
{| class="wikitable"
|-
! Parameter
! Description
! Default
! Status
|-
| version
| To specify the major patch for which the event was written or updated.
| empty
| '''required'''
|-
| event_id
| Event identification code as it appears in the file to serve as an anchor
| empty
| '''optional'''
|-
| event_name
| Title of the event.
| empty
| '''required'''
|-
| cond_event_text
| Set to "yes" if the event has multiple descriptions available for use.
| empty
| '''optional'''
|-
| event_text
| In-game description text of the event. If multiple descriptions exist then use only the first one.
| empty
| '''optional, but desired'''
|-
| img
| Shows a picture above the event description.
| empty
| '''optional'''
|-
| picture
| Shows a picture above the event description.
| empty
| '''optional'''
|-
| fire_only_once
| As in the script code - set to "yes" if the event happens ''only once'' during a campaign.
| empty
| '''optional'''
|-
| mtth
| For the base weight and its modifiers of [[Events#Mean_time_to_happen|MTTH-events]].
| empty
| rowspan="2" | One of theses two is '''required'''.
|-
| triggered only
| To specify the trigger of [[Events#Triggered_events|'triggered only'-events]].
| empty
|-
| trigger
| Trigger conditions of the event.
| 
*None
| '''optional'''
|-
| immediate
| The immediate effects of the event.
| empty
| '''optional'''
|-
| option conditions
| If set to ''‘yes’'' the section heading 'Option conditions' for events with conditional options is displayed.
| empty
| '''optional'''
|-
| options
| The possible effects of the event. Please use {{template|option}}.
| empty
| '''required'''
|-
| after
| Effects that happen after selecting any option.
| empty
| '''optional'''
|-
| collapse
| Whether to collapse the event. If set to ''‘yes’'' the content will be collapsed.<br>
(Please use collapsed content on country pages.)
| empty
| '''optional'''
|}

== Usage ==
<pre>
{{Event
|version = 
|event_id = 
|event_name = 
|event_text = <!-- optional, but desired -->
|picture = <!-- optional -->
|trigger = 
|mtth    = <!-- for Mtth events -->
|triggered only = <!-- for triggered only events -->
|immediate = <!-- optional for immediate effects -->
|options = <!-- options use {{option}} template -->
}}
</pre>
'''Note:''' Please use either “mtth”-parameter ''or'' “triggered only”-parameter.

== Examples ==
=== MTTH event ===
The following code
<pre>
{{Event
|version = 2.8
|event_id = colony.2050
|event_name = Lost to Bureaucracy
|img = [[File:Evt colony settlement.png]]
|event_text = Due to a major clerical error parts of [colony name] has fallen behind in infrastructure maintenance and accommodation services. The people live in rather bleak conditions and will not tolerate it for long. Remedying these problems will cost us time and effort.
|trigger = 
* Colony is not a [[File:Planet habitat.png|24px]] Habitat
* Colony has any building
* Not {{iconify|Gestalt Consciousness}}
|mtth = 36 months
|options = 
{{option |option_text = Unfortunate.|effect = 
* Adds a [[File:D slums.png|24px]] Sprawling Slums Blocker to the colony
* Adds an [[File:D metal boneyard.png|24px]] Industrial Wasteland Blocker to the colony}}
{{option |option_text = We must invest in this area.|effect = 
* Energy Credits: {{icon|energy}} {{red|-500}}
* Influence: {{icon|influence}} {{red|-100}}
* Unity Gained: {{icon|unity}} 150-1000}}
{{option |option_text = {{icon|authoritarian}}{{icon|fanatic authoritarian}} We have a strong community, help them recover.|effect = 
* Energy Credits: {{icon|energy}} {{red|-250}}
* Influence: {{icon|influence}} {{red|-50}}
* Unity Gained: {{icon|unity}} 150-1000}}
{{option |option_text = {{icon|militarist}}{{icon|fanatic militarist}} Throw out the inhabitants and raze the area.|effect = 
* Influence Gained: {{icon|influence}} 80-175
* The colony gets {{red|+20}} {{iconify|Devastation}}}}
}}
</pre>
will display:
{{Event|nocat=yes
|version = 2.8
|event_id = colony.2050
|event_name = Lost to Bureaucracy
|img = [[File:Evt colony settlement.png]]
|event_text = Due to a major clerical error parts of [colony name] has fallen behind in infrastructure maintenance and accommodation services. The people live in rather bleak conditions and will not tolerate it for long. Remedying these problems will cost us time and effort.
|trigger = 
* Colony is not a [[File:Planet habitat.png|24px]] Habitat
* Colony has any building
* Not {{iconify|Gestalt Consciousness}}
|mtth = 36 months
|options = 
{{option |option_text = Unfortunate.|effect = 
* Adds a [[File:D slums.png|24px]] Sprawling Slums Blocker to the colony
* Adds an [[File:D metal boneyard.png|24px]] Industrial Wasteland Blocker to the colony}}
{{option |option_text = We must invest in this area.|effect = 
* Energy Credits: {{icon|energy}} {{red|-500}}
* Influence: {{icon|influence}} {{red|-100}}
* Unity Gained: {{icon|unity}} 150-1000}}
{{option |option_text = {{icon|authoritarian}}{{icon|fanatic authoritarian}} We have a strong community, help them recover.|effect = 
* Energy Credits: {{icon|energy}} {{red|-250}}
* Influence: {{icon|influence}} {{red|-50}}
* Unity Gained: {{icon|unity}} 150-1000}}
{{option |option_text = {{icon|militarist}}{{icon|fanatic militarist}} Throw out the inhabitants and raze the area.|effect = 
* Influence Gained: {{icon|influence}} 80-175
* The colony gets {{red|+20}} {{iconify|Devastation}}}}
}}

=== Triggered only event ===
The following code
<pre>
{{Event
| version = 1.6
| event_id = progress.2
| event_name = The Discovery of Alien Life
| event_text = The [Root.GetName] has made a startling find on [From.GetName] - the [From.GetPlanetMoon] is teeming with alien life! For the first time in history, we have encountered life forms that did not originate on [Root.Owner.Capital.GetName].<br/><br/>This amazing discovery has silenced those who believed we were alone in the universe. Although none of the alien creatures found on [From.GetName] are sentient, it is likely only a matter of time before we encounter beings that are...
| picture = evt_alien_planet
| trigger = 
* The following country flag are ''not'' set: {{MultiColumn|
** ''first_alien_life''
** ''Story1''
** ''Story2''
** ''Story3''
** ''Story4''
** ''Story5''
** ''Story6''
** ''Story7''
** ''Story8''
|2}}
* Planet is habitable ''and'' unowned 
| triggered only = * On survey
| immediate = * Set country flag ''first_alien_life''
| options = 
{{Option
| option_text = We may not be alone out here.
| effect = 
* {{reward|soc|res1}}
* Get country event if planet has a {{icon|tile blocker|21px}} ''Dangerous Wildlife'' tile blocker
** {{icon|yes}} Present: [[Story events#story.3|''"Contact Report: Planetary Animalia"'']] in 30 days
** {{icon|no}} Present: [[Story events#story.1|''"Contact Report: Simple Forms of Life"'']] in 30 days
}}
}}
</pre>
will display:

{{Event|nocat=yes
| version = 1.6
| event_id = progress.2
| event_name = The Discovery of Alien Life
| event_text = The [Root.GetName] has made a startling find on [From.GetName] - the [From.GetPlanetMoon] is teeming with alien life! For the first time in history, we have encountered life forms that did not originate on [Root.Owner.Capital.GetName].<br/><br/>This amazing discovery has silenced those who believed we were alone in the universe. Although none of the alien creatures found on [From.GetName] are sentient, it is likely only a matter of time before we encounter beings that are...
| picture = evt_alien_planet
| trigger = 
* The following country flag are ''not'' set: {{MultiColumn|
** ''first_alien_life''
** ''Story1''
** ''Story2''
** ''Story3''
** ''Story4''
** ''Story5''
** ''Story6''
** ''Story7''
** ''Story8''
|2}}
* Planet is habitable ''and'' unowned 
| triggered only = * On survey
| immediate = * Set country flag ''first_alien_life''
| options = 
{{Option
| option_text = We may not be alone out here.
| effect = 
* {{reward|soc|res1}}
* Get country event if planet has a {{icon|tile blocker|21px}} ''Dangerous Wildlife'' tile blocker
** {{icon|yes}} Present: [[Story events#story.3|''"Contact Report: Planetary Animalia"'']] in 30 days
** {{icon|no}} Present: [[Story events#story.1|''"Contact Report: Simple Forms of Life"'']] in 30 days
}}
}}

=== Event with conditional options and after effects ===
The following code
<pre>
{{Event
| version = 1.4
| event_id = akx.9005
| event_name = The Horizon Signal: <span style="color:orange">THE WORM</span>
| event_text = Science Officer [Root.GetLeaderName] reports that the signal was unexpectedly easy to decipher... but their team has spent considerable time confirming that it's not a hoax. It is a repeating, half-coherent message in the [Root.Owner.GetAdj] language - something like a poem. It repeats the phrases <span style="color:orange">GRAVITY IS DESIRE</span> and <span style="color:orange">TIME IS SIGHT</span>. It encodes co-ordinates near the black hole. And it ends with a dedication {{green|by name}} to the Science Officer - who adds dispassionately that they have confirmed that the signal has been radiating into interstellar space since before their birth. In fact, the signal may predate our civilization.
| picture = evt_black_hole
| triggered only = Event ''"The Horizon Signal: <span style="color:orange">GRAVITY IS DESIRE</span>"''<!-- akx.9001 --> option ''"Fascinating! Send the vessel to those co-ordinates."''
| immediate =
* Fleet is temporarily locked in place.
* Fleet leader is temporarily exiled.
| after =
* Fleet owner:
** Gain between {{icon|physics}} 600 and 3000 monthly physics research, scaled by ???
** Trigger event ''"The Horizon Signal: <span style="color: orange">REPRISE</span>"''<!-- akx.9010 --> in a random amount of time (about 320 days)
* Fleet is deleted.
| option conditions = yes
| options =
{{Option
| option_text = Darkness; light; darkness.
| trigger = the fleet's owner has {{icon|spiritualist}} Spiritualist or {{icon|fanatic spiritualist}} Fanatic Spiritualist ethics
}}
{{Option
| option_text = We learn, and we go on.
| trigger = the fleet's owner has {{icon|materialist}} Materialist or {{icon|fanatic materialist}} Fanatic Materialist ethics
}}
{{Option|end
| option_text = They won't be forgotten.
| trigger = the fleet's owner has none of these ethics
}}
}}
</pre>

will display:
{{Event|nocat=yes
| version = 1.4
| event_id = akx.9005
| event_name = The Horizon Signal: <span style="color:orange">THE WORM</span>
| event_text = Science Officer [Root.GetLeaderName] reports that the signal was unexpectedly easy to decipher... but their team has spent considerable time confirming that it's not a hoax. It is a repeating, half-coherent message in the [Root.Owner.GetAdj] language - something like a poem. It repeats the phrases <span style="color:orange">GRAVITY IS DESIRE</span> and <span style="color:orange">TIME IS SIGHT</span>. It encodes co-ordinates near the black hole. And it ends with a dedication {{green|by name}} to the Science Officer - who adds dispassionately that they have confirmed that the signal has been radiating into interstellar space since before their birth. In fact, the signal may predate our civilization.
| picture = evt_black_hole
| triggered only = Event ''"The Horizon Signal: <span style="color:orange">GRAVITY IS DESIRE</span>"''<!-- akx.9001 --> option ''"Fascinating! Send the vessel to those co-ordinates."''
| immediate =
* Fleet is temporarily locked in place.
* Fleet leader is temporarily exiled.
| after =
* Fleet owner:
** Gain between {{icon|physics}} 600 and 3000 monthly physics research, scaled by ???
** Trigger event ''"The Horizon Signal: <span style="color: orange">REPRISE</span>"''<!-- akx.9010 --> in a random amount of time (about 320 days)
* Fleet is deleted.
| option conditions = yes
| options =
{{Option
| option_text = Darkness; light; darkness.
| trigger = the fleet's owner has {{icon|spiritualist}} Spiritualist or {{icon|fanatic spiritualist}} Fanatic Spiritualist ethics
}}
{{Option
| option_text = We learn, and we go on.
| trigger = the fleet's owner has {{icon|materialist}} Materialist or {{icon|fanatic materialist}} Fanatic Materialist ethics
}}
{{Option|end
| option_text = They won't be forgotten.
| trigger = the fleet's owner has none of these ethics
}}
}}