编辑“Bypass modding”

{{Version|3.0}}

This page is about modding [[FTL#Bypasses|Bypasses]], namely Wormholes and Gateways only as traveling methods.

Before reading, you must understand that:
* {{blue|Bypasses}} are traveling methods, not {{yellow|Natural Wormholes}} or {{yellow|Gateways}}.
* {{yellow|Natural Wormholes}} and {{yellow|Gateways}} are containers of {{blue|bypasses}}, not bypasses themselves.
* In this article, words that refer to {{blue|bypasses}} are marked {{blue|blue}} and words that refer to {{yellow|bypass-containers}} are marked {{yellow|yellow}}.

They are defined at "common/bypass/xxx.txt".

== Data Structure ==

{| class="wikitable mw-collapsible"
|-
! width="40%" | Property
! width="30%" | Paired Bypass Type
! width="30%" | One-to-All Bypass Type
|- 
| '''name = <localisation key>'''
| colspan=2 | The name of this type of bypass.
|- 
| '''is_pathfind = <yes/no>'''
| colspan=2 | If yes, this bypass allows the pathfinder to use it. Vanilla always have "yes".
|- 
| '''uses_action = <yes/no>'''
| colspan=2 | Actual functionality is unclear. Vanilla always have "no".
|- 
| '''windup_time = <int>'''<br>'''winddown_time = <int>'''
| colspan=2 | Time spent to prepare / cooldown for fleets when using this bypass. Vanilla always have "0" for both.
|- 
| '''ftl_multiplier = <float>'''
| colspan=2 | Multiplies the time spent in FTL travel. If 0, the travel is finished in an instant. Vanilla always have "0".
|- 
| '''icon_frame = <int>'''<br>'''galactic_map_tooltip_header = <localisation key>'''<br>'''galactic_map_tooltip_desc = <localisation key>'''
| colspan=2 | Determines the icon and tooltip of the icon of this bypass type in the galaxy view.
|- 
| '''ftl_ship_effect = <entity key>'''<br>'''ftl_bypass_effect = <entity key>'''
| colspan=2 | Determines the animation effect to be displayed for this bypass type.
|- 
| '''animation_time = <int>'''
| colspan=2 | Days to wait for the jump animation to be played.
|- 
| '''always_active = <yes/no>'''
| colspan=2 | If yes, this {{blue|bypass type}} can't be used without activating or upgrading something. In addition, an inactive instance of this {{blue|bypass type}} triggers a red icon in the galaxy view.
|- 
| rowspan=2 | '''remember_instances = <yes/no>'''<br>'''requires_exploration = <yes/no>'''
| 

{| class="wikitable" width=100% style="text-align: center;"
|-
| colspan=2 rowspan=2 | {{blue|Wormhole}} Properties
| colspan=2 | <code>requires_exploration</code>
|- 
| yes
| no
|- 
| rowspan=2 | <code>remember_instances</code>
| yes
| colspan=2 | {{green|Each pair must be explored}}
|- 
| no
| colspan=2 | {{red|No need to explore}}
|}

|

{| class="wikitable" width=100% style="text-align: center;"
|-
| colspan=2 rowspan=2 | {{blue|Gateway}} Properties
| colspan=2 | <code>requires_exploration</code>
|- 
| yes
| no
|- 
| rowspan=2 | <code>remember_instances</code>
| yes
| colspan=2 | {{red|Each instance must be explored}}
|- 
| no
| colspan=2 | {{green|No need to explore}}
|}

|- 
| colspan=2 | As we can see, the <code>requires_exploration</code> property actually does nothing.
|- 
| '''extends_sensors = <yes/no>'''
| colspan=2 | Determines should ship sensors see through this {{blue|bypass}}.
|- 
| '''prerequisites = { tech_xxx }'''
| colspan=2 | Technologies to be researched before this bypass can be used for an Empire.
|- 
| '''connection_type'''
|
* <code>one_to_one</code>
|
* <code>any_other</code> ({{blue|Gateway}})
* <code>scripted_connection</code> ({{blue|L-Gate}})
|- 
| '''scripted_connection'''
| style="text-align: center;" | {{icon|no}}
| Vanilla use this for the {{blue|L-Gate}} bypass type.

<pre>
scripted_connection = {
	node = {
		has_star_flag = lgate
	}
	nexus = {
		has_star_flag = lcluster1
	}
}
</pre>

Vanilla comments claim that:
* {{icon|yes}} node to nexus
* {{icon|yes}} nexus to node
* {{icon|no}} node to node
* {{icon|no}} nexus to nexus
|- 
| '''on_action'''
| colspan=2 | An On-Action to be fired when a fleet uses this bypass. See [[Event modding]] for details.
|- 
| '''on_pre_explore'''
| colspan=2 | Vanilla comments claim that this is a block of [[Effects]] to be executed after this bypass have been explored. The only usage of this property is the {{blue|gateway}} bypass type, bu it actually doesn't need to be explored, making this property irrelevant.
|- 
| '''potential'''
| colspan=2 | Vanilla comments unmentioned. Presumably some sort of [[Conditions]] to be checked. The only usage of this property is the {{blue|wormhole}} bypass type, but it has <code>always = yes</code>, making this property irrelevant. Actual functionality is unclear.
|- 
| '''country_can_use'''
| colspan=2 | A block of [[Conditions]] to check can an Empire use this bypass. (Country scope, FROM = owner of target system)
|}

== How to install a bypass in the galaxy ==
=== Natural Wormholes ===
Use the Effect <code>spawn_natural_wormhole</code> to spawn a {{yellow|natural wormhole}}.
<pre>
spawn_natural_wormhole = {
	bypass_type = <bypass type key, e.g. wormhole / gateway>
	orbit_distance = <int>
	orbit_angle = <int, 0-360>
	random_pos = <yes/no>
}
</pre>

Use the Effect <code>link_wormholes</code> under the solar system scope to link it to another. The effect takes another solar system scope as a parameter.

* The {{blue|bypass type}} can be one-to-all. In this case, this wormhole doesn't need to be linked, but the {{blue|bypass type}} must have <code>remember_instances = no</code>, or each instance must be explored and only explored instances can be used to travel between each other.
* The {{blue|bypass type}} must have <code>always_active = yes</code>, or this {{yellow|natural wormhole}} can't be used by any mean, because there are no Effects to activate a {{yellow|natural wormhole}}.

=== Megastructures ===
Megastructures have a property called <code>bypass_type</code> to specify a {{blue|bypass type}}. See [[Megastructure modding]] for details.

Use the effect <code>activate_gateway = yes</code> under Megastructure scope to activate it.

* The {{blue|bypass type}} must NOT be paired, because there are no Effects to link a {{yellow|megastructure}} to another.
* The {{blue|bypass type}} must have <code>remember_instances = no</code>, or each instance must be explored and only explored instances can be used to travel between each other, including those you built. By the way, there are no Effects to mark an instance of a {{blue|bypass type}} as explored by a country.
* The {{blue|bypass type}} should have <code>always_active = no</code>.
** If it had <code>always_active = yes</code>, {{yellow|Dormant Gateways}} will become usable before it to be reactivated. {{yellow|Gateway Construction Sites}} still can't be used, because it doesn't have any associated {{blue|bypass type}}. This is also why don't Gateway Construction Sites trigger the red galaxy view icon.


{{ModdingNavbox}}
[[Category:模组制作]]