Difference between revisions of "Building Portals"
From ALFA
Foambats4all (talk | contribs) (Created page with "Category:Tech Guides Triggers, Doors, and Usable Placeables are the customary objects used for inter-server travel in ALFA. Simply put, a portal (not to be confused with ...") |
(→IC Portals) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category: | + | [[Category:Technical Manuals]] |
| + | =Server Portals= | ||
Triggers, Doors, and Usable Placeables are the customary objects used for inter-server travel in ALFA. | Triggers, Doors, and Usable Placeables are the customary objects used for inter-server travel in ALFA. | ||
Simply put, a portal (not to be confused with other [[Portals]])) is a method of traveling between ALFA servers. | Simply put, a portal (not to be confused with other [[Portals]])) is a method of traveling between ALFA servers. | ||
| − | = Scripts = | + | == Scripts == |
A portal event may be initialized in either the <code>'''OnClick'''</code> or <code>'''OnUsed'''</code> events. Set either script to use or call [[acr_trg_portalstart.nss]]. | A portal event may be initialized in either the <code>'''OnClick'''</code> or <code>'''OnUsed'''</code> events. Set either script to use or call [[acr_trg_portalstart.nss]]. | ||
Remaining scripts should be the default acr_* scripts for the portal object type. See [[Building Placeables]] or [[Building Triggers]] for details on how to configure those. | Remaining scripts should be the default acr_* scripts for the portal object type. See [[Building Placeables]] or [[Building Triggers]] for details on how to configure those. | ||
| − | = Waypoints = | + | == Waypoints == |
The destination of a cross-server portal is always a waypoint. | The destination of a cross-server portal is always a waypoint. | ||
| Line 15: | Line 16: | ||
: ''Example: For the arrival waypoint of a portal from [[Baldur's Gate (Server) | Baldur's Gate]] (Server ID 010) to [[The Silver Marches (Server) | The Silver Marches]] (Server ID 003), the first such arrival waypoint is given the tag: <code>'''010_PortalTo_003_01'''</code> | : ''Example: For the arrival waypoint of a portal from [[Baldur's Gate (Server) | Baldur's Gate]] (Server ID 010) to [[The Silver Marches (Server) | The Silver Marches]] (Server ID 003), the first such arrival waypoint is given the tag: <code>'''010_PortalTo_003_01'''</code> | ||
| − | = Customizing Portals = | + | == Customizing Portals == |
: ''See also: [[Using Local Variables]]'' | : ''See also: [[Using Local Variables]]'' | ||
The following two variables are required for the portal to function. | The following two variables are required for the portal to function. | ||
| Line 25: | Line 26: | ||
The following options are optional. | The following options are optional. | ||
* <code>'''ACR_PORTAL_DEST_ADJACENT'''</code> (int) -- If set to <code>1</code>, the 24-hour portal cooldown will be disabled. | * <code>'''ACR_PORTAL_DEST_ADJACENT'''</code> (int) -- If set to <code>1</code>, the 24-hour portal cooldown will be disabled. | ||
| + | |||
| + | =IC Portals= | ||
| + | |||
| + | See Building IC [https://www.alandfaraway.info/wiki/Portals Portals] | ||
Latest revision as of 13:08, 1 February 2023
Server Portals
Triggers, Doors, and Usable Placeables are the customary objects used for inter-server travel in ALFA.
Simply put, a portal (not to be confused with other Portals)) is a method of traveling between ALFA servers.
Scripts
A portal event may be initialized in either the OnClick or OnUsed events. Set either script to use or call acr_trg_portalstart.nss.
Remaining scripts should be the default acr_* scripts for the portal object type. See Building Placeables or Building Triggers for details on how to configure those.
Waypoints
The destination of a cross-server portal is always a waypoint.
Create a Waypoint with a Tag of the form <SourceServerId>_PortalTo_<DestinationServerId>_<PortalNumber>, where the ServerIds are 3 digit integers, and the PortalNumber is a 2 digit integer.
- Example: For the arrival waypoint of a portal from Baldur's Gate (Server ID 010) to The Silver Marches (Server ID 003), the first such arrival waypoint is given the tag:
010_PortalTo_003_01
Customizing Portals
- See also: Using Local Variables
The following two variables are required for the portal to function.
-
ACR_PORTAL_DEST_SERVER(int) -- Must be set to the destination server ID.- Example:
int ACR_PORTAL_DEST_SERVER = 10to travel to Baldur's Gate.
- Example:
-
ACR_PORTAL_NUM(int) -- The unique ID (for the destination server) of the destination waypoint.- Example:
int ACR_PORTAL_NUM = 1may put you at the docks, whileint ACR_PORTAL_NUM = 2may put you at the transition between the Western Heartlands and Tempest's Tears.
- Example:
The following options are optional.
-
ACR_PORTAL_DEST_ADJACENT(int) -- If set to1, the 24-hour portal cooldown will be disabled.
IC Portals
See Building IC Portals
