Difference between revisions of "Quest Alias Tab"
Jump to navigation
Jump to search
bold text
imported>Terra Nova2 m (→Fill Type:) |
imported>Werez (bold text) |
||
| Line 24: | Line 24: | ||
==Reference Alias data:== | ==Reference Alias data:== | ||
*Alias Name: used within the quest to refer to this alias. This is never displayed in the game. This also becomes part of the automatically generated [[Quest_Stage_Fragments|quest stage fragment property name]]. | *'''Alias Name''': used within the quest to refer to this alias. This is never displayed in the game. This also becomes part of the automatically generated [[Quest_Stage_Fragments|quest stage fragment property name]]. | ||
*Display Name (optional) | *'''Display Name''': (optional) Can be used to rename the reference when it is assigned to the alias. The dropdown is a list of Messages - the Message Title will replace the reference's name. Note that this change is permanent - the reference will retain the new Display Name even when it is removed from the alias. | ||
*Force Into Alias When Filled: (optional) The specified alias will also be filled with whatever fills this alias. This can be useful when you need to fill aliases in a "prioritized" manner (for example, pick NPC_A if alive, otherwise pick NPC_B). | *'''Force Into Alias When Filled''': (optional) The specified alias will also be filled with whatever fills this alias. This can be useful when you need to fill aliases in a "prioritized" manner (for example, pick NPC_A if alive, otherwise pick NPC_B). | ||
*Additional Valid Voice Types for Export: This is used in cases where the alias's Fill Type (see below) does not give the editor enough information to determine what voice types are valid (for example, Location Alias Reference). Select a form list of voice types which the editor uses to limit any dialogue assigned to this alias (on scenes or through the [[GetIsAliasRef]] condition). | *'''Additional Valid Voice Types for Export''': This is used in cases where the alias's Fill Type (see below) does not give the editor enough information to determine what voice types are valid (for example, Location Alias Reference). Select a form list of voice types which the editor uses to limit any dialogue assigned to this alias (on scenes or through the [[GetIsAliasRef]] condition). | ||
===Checkboxes:=== | ===Checkboxes:=== | ||
*Reserves Reference: Once a reference is assigned to a "Reserved" alias, the Story Manager will not fill any other alias with this reference unless: | *'''Reserves Reference''': Once a reference is assigned to a "Reserved" alias, the Story Manager will not fill any other alias with this reference unless: | ||
** A) The new alias is marked "Allow Reserved", or | ** A) The new alias is marked "Allow Reserved", or | ||
** B) The new alias is a "From External" fill type. | ** B) The new alias is a "From External" fill type. | ||
** C) "Starts Enabled" quests - all their aliases are treated as if "Allow Reserved" was checked (in order to avoid "race conditions" where the order that the "game start" quests actually fill their aliases matters). | ** C) "Starts Enabled" quests - all their aliases are treated as if "Allow Reserved" was checked (in order to avoid "race conditions" where the order that the "game start" quests actually fill their aliases matters). | ||
*Optional: If checked, the quest is not required to fill this in order to start. If unchecked, the quest will fail to start if the Story Manager fails to fill this alias. | *'''Optional''': If checked, the quest is not required to fill this in order to start. If unchecked, the quest will fail to start if the Story Manager fails to fill this alias. | ||
*Essential: Make the actor in this alias Essential while in the alias. | *'''Essential''': Make the actor in this alias Essential while in the alias. | ||
*Protected: Make the actor in this alias Protected while in the alias. | *'''Protected''': Make the actor in this alias Protected while in the alias. | ||
*Quest Object: Make the reference in this alias a Quest Object while in the alias: | *'''Quest Object''': Make the reference in this alias a Quest Object while in the alias: | ||
** Cannot be dropped or sold by the player. EXCEPTION: Player can place Quest Objects into a container in an alias on the same quest which is ALSO marked as a Quest Object. | ** Cannot be dropped or sold by the player. EXCEPTION: Player can place Quest Objects into a container in an alias on the same quest which is ALSO marked as a Quest Object. | ||
** Any container containing a Quest Object cannot be cleaned up (deleted) by the game. | ** Any container containing a Quest Object cannot be cleaned up (deleted) by the game. | ||
*Allow Reuse in Quest: Normally, the Story Manager will not fill two aliases on the same quest with the same reference. If "Allow Reuse in Quest", the reference in this alias CAN be placed into another alias on this quest during the startup process. | *'''Allow Reuse in Quest''': Normally, the Story Manager will not fill two aliases on the same quest with the same reference. If "Allow Reuse in Quest", the reference in this alias CAN be placed into another alias on this quest during the startup process. | ||
*Allow Dead: The Story Manager will skip dead actors unless this is checked. | *'''Allow Dead''': The Story Manager will skip dead actors unless this is checked. | ||
*Allow Disabled: Allows the alias to be filled with a disabled reference. | *'''Allow Disabled''': Allows the alias to be filled with a disabled reference. | ||
*Allow Reserved: Allows the alias to be filled with a reference which is already in a Reserved alias on another quest. Checking this will resolve some issues with quests failing to initialize because aliases could not be filled. | *'''Allow Reserved''': Allows the alias to be filled with a reference which is already in a Reserved alias on another quest. Checking this will resolve some issues with quests failing to initialize because aliases could not be filled. | ||
**This option is greyed out for Start Game Enabled quests, which consider their aliases to "Allow Reserved" by default when initialized at the beginning of a new game. However, ticking "Allow Reserved" may be required to avoid problems if the Start Game Enabled quest is added to a pre-existing save. To select this option on a Start Game Enabled quest: | **This option is greyed out for Start Game Enabled quests, which consider their aliases to "Allow Reserved" by default when initialized at the beginning of a new game. However, ticking "Allow Reserved" may be required to avoid problems if the Start Game Enabled quest is added to a pre-existing save. To select this option on a Start Game Enabled quest: | ||
***Highlight the alias's line in the main alias list for the quest, then press CTRL-SHIFT-R to set this flag, OR | ***Highlight the alias's line in the main alias list for the quest, then press CTRL-SHIFT-R to set this flag, OR | ||
***Temporarily disable the quest's Start Game Enabled status until you've ticked the box in the alias. | ***Temporarily disable the quest's Start Game Enabled status until you've ticked the box in the alias. | ||
*Allow Destroyed: Allows the alias to be filled with a Destroyed reference. (see [[SetDestroyed]]) | *'''Allow Destroyed''': Allows the alias to be filled with a Destroyed reference. (see [[SetDestroyed]]) | ||
*Uses Stored Text: Check this if the alias requires text replacement (for example, a book with text replacement tags, or an alias which uses text replacement in an alternate Display Name). | *'''Uses Stored Text''': Check this if the alias requires text replacement (for example, a book with text replacement tags, or an alias which uses text replacement in an alternate Display Name). | ||
*Stores Text: Check this if the alias is used in text replacement. (see [[Text Replacement]]) | *'''Stores Text''': Check this if the alias is used in text replacement. (see [[Text Replacement]]) | ||
*Initially Disabled: If checked, the reference will be automatically disabled when it is assigned to this alias. | *'''Initially Disabled''': If checked, the reference will be automatically disabled when it is assigned to this alias. | ||
*Clears Name When Removed: If checked, any "Display Name" assigned by this alias (see above) will be removed from the reference when it is removed from this alias. If unchecked, the Display Name will be permanently changed. | *'''Clears Name When Removed''': If checked, any "Display Name" assigned by this alias (see above) will be removed from the reference when it is removed from this alias. If unchecked, the Display Name will be permanently changed. | ||
===Fill Type:=== | ===Fill Type:=== | ||
There are 6 ways that an alias can be filled during the process of starting the quest. | There are 6 ways that an alias can be filled during the process of starting the quest. | ||
;Specific Reference: A specific reference is assigned to this alias. Note that this makes that reference '''permanently''' persistent (always loaded in memory), even when this quest is not running. This can eventually cause performance issues, particularly with actors. | ;Specific Reference: A specific reference is assigned to this alias. {{WarningBox| | ||
Note that this makes that reference '''permanently''' persistent (always loaded in memory), even when this quest is not running. This can eventually cause performance issues, particularly with actors.}} | |||
*Contrary to the above, all aliases are persistent for as long as the quest is running. | |||
;Unique Actor: Pick a Unique actor to fill the alias. Note that this will only work if the specified actor's reference has been assigned a Persist Location. (see [[Object Reference]]) | ;Unique Actor: Pick a Unique actor to fill the alias. Note that this will only work if the specified actor's reference has been assigned a Persist Location. (see [[Object Reference]]) | ||
;Location Alias Reference: Pick a Location Alias from this quest (must be higher in the list than this alias), and pick a [[Location Ref Type]]. When the quest starts, the Story Manager will attempt to find a matching loc ref type from that location to fill this alias. | ;Location Alias Reference: Pick a Location Alias from this quest (must be higher in the list than this alias), and pick a [[Location Ref Type]]. When the quest starts, the Story Manager will attempt to find a matching loc ref type from that location to fill this alias. | ||
| Line 63: | Line 64: | ||
'''Note''': A reference that this fill option, must have the Reference that this reference will create and object to be higher in the Alias list. | '''Note''': A reference that this fill option, must have the Reference that this reference will create and object to be higher in the Alias list. | ||
;Find Matching Reference: This option allows the Story Manager to find a reference from anywhere in the world (but only persistent references, or Unique actors, can be found this way outside the loaded area). The "Match Conditions" are used by the Story Manager to filter the potential choices. The optional checkboxes are as follows: | ;Find Matching Reference: This option allows the Story Manager to find a reference from anywhere in the world (but only persistent references, or Unique actors, can be found this way outside the loaded area). The "Match Conditions" are used by the Story Manager to filter the potential choices. The optional checkboxes are as follows: | ||
*In Loaded Area: This limits the search to the loaded area (the player's current interior cell, or the 5x5 cells around the player in a worldspace). Useful when you want something near the player. | *'''In Loaded Area''': This limits the search to the loaded area (the player's current interior cell, or the 5x5 cells around the player in a worldspace). Useful when you want something near the player. | ||
*Closest: Only available when searching "In Loaded Area", this will cause the Story Manager to prefer the closest matching reference. (Otherwise it picks randomly from all matching refs.) | *'''Closest''': Only available when searching "In Loaded Area", this will cause the Story Manager to prefer the closest matching reference. (Otherwise it picks randomly from all matching refs.) | ||
* From Event: This is only available for quests which are started from an Event through the Story Manager (see [[Quest Data Tab]]). Select the event data to run the conditions against. | * '''From Event''': This is only available for quests which are started from an Event through the Story Manager (see [[Quest Data Tab]]). Select the event data to run the conditions against. | ||
* Near Alias: Select another Reference Alias on this quest - the Story Manager will run the conditions only on any references linked to that alias's ref. (NOTE: Only linked refs with NO keyword are considered.) | * '''Near Alias''': Select another Reference Alias on this quest - the Story Manager will run the conditions only on any references linked to that alias's ref. (NOTE: Only linked refs with NO keyword are considered.) | ||
====Fill Type Conditions==== | ====Fill Type Conditions==== | ||
| Line 83: | Line 84: | ||
===Alias Data:=== | ===Alias Data:=== | ||
*Scripts: Select scripts to run on the alias. These must extend [[ReferenceAlias_Script|ReferenceAlias]] script type in order to work properly. | *'''Scripts''': Select scripts to run on the alias. These must extend [[ReferenceAlias_Script|ReferenceAlias]] script type in order to work properly. | ||
* Factions: The aliased reference will be considered a member of the specified factions while in the alias. When the alias is cleared, the faction data will be removed from the base actor as well if that data is present. | * Factions: The aliased reference will be considered a member of the specified factions while in the alias. When the alias is cleared, the faction data will be removed from the base actor as well if that data is present. | ||
* Spells: The specified spells will be added to the reference that fills the alias, and removed when the reference leaves the alias. Note that rightclicking and using the Add menu in this box will allow you to add only Shouts, but if you wish to add other kinds of spell, you can drag them into this box from the Object Window. | * '''Spells''': The specified spells will be added to the reference that fills the alias, and removed when the reference leaves the alias. Note that rightclicking and using the Add menu in this box will allow you to add only Shouts, but if you wish to add other kinds of spell, you can drag them into this box from the Object Window. | ||
* Keywords: The aliased reference will be considered to have the specified keywords while in the alias. | * '''Keywords''': The aliased reference will be considered to have the specified keywords while in the alias. | ||
* Inventory: The specified items are added to the reference's inventory when the reference is placed into the alias. Note that this is permanent - these items are NOT removed when the reference leaves the alias. | * '''Inventory''': The specified items are added to the reference's inventory when the reference is placed into the alias. Note that this is permanent - these items are NOT removed when the reference leaves the alias. | ||
* Package Data: The list of packages is considered an additional "package stack" that sits on top of the aliased actor's base package stack. If an actor is in multiple aliases, the alias packages stack in quest priority order. | * '''Package Data''': The list of packages is considered an additional "package stack" that sits on top of the aliased actor's base package stack. If an actor is in multiple aliases, the alias packages stack in quest priority order. | ||
* Override Package Lists: Anything specified here replaces the matching "override" package list from the base actor. (See [[Interrupt Override Packages]].) | * '''Override Package Lists''': Anything specified here replaces the matching "override" package list from the base actor. (See [[Interrupt Override Packages]].) | ||
==Location Aliases== | ==Location Aliases== | ||
| Line 96: | Line 97: | ||
===Location Alias Data=== | ===Location Alias Data=== | ||
*Alias Name: used within the quest to refer to this alias. This is never displayed in the game. | *'''Alias Name''': used within the quest to refer to this alias. This is never displayed in the game. | ||
*Force Into Alias When Filled: (optional) The specified alias will also be filled with whatever fills this alias. | *'''Force Into Alias When Filled''': (optional) The specified alias will also be filled with whatever fills this alias. | ||
===Checkboxes:=== | ===Checkboxes:=== | ||
*Reserves Location: Similar to Reference Aliases, once a Location is assigned to a Reserved alias, the Story Manager will not assign it to any other aliases (unless they are marked "Allow Reserved"). | *'''Reserves Location''': Similar to Reference Aliases, once a Location is assigned to a Reserved alias, the Story Manager will not assign it to any other aliases (unless they are marked "Allow Reserved"). | ||
* Optional: If checked, this alias can be unfilled and the quest will still start. If unchecked, failure to fill this alias will cause the quest to fail to start. | * '''Optional''': If checked, this alias can be unfilled and the quest will still start. If unchecked, failure to fill this alias will cause the quest to fail to start. | ||
* Displays Text: Check this if the alias is used in text replacement. | * '''Displays Text''': Check this if the alias is used in text replacement. | ||
* Allow Reuse in Quest: Normally, the Story Manager will not fill two aliases on the same quest with the same location. If "Allow Reuse in Quest" is checked, the location in this alias CAN be placed into another alias on this quest during the startup process. | * '''Allow Reuse in Quest''': Normally, the Story Manager will not fill two aliases on the same quest with the same location. If "Allow Reuse in Quest" is checked, the location in this alias CAN be placed into another alias on this quest during the startup process. | ||
* Allow Reserved: Allows locations that are in Reserved aliases on other quests to be picked for this alias. | * '''Allow Reserved''': Allows locations that are in Reserved aliases on other quests to be picked for this alias. | ||
* Allow Cleared: If unchecked, "Cleared" Locations will never be selected for this alias. If checked, "Cleared" Locations can be checked, but uncleared locations will be preferred if available. | * '''Allow Cleared''': If unchecked, "Cleared" Locations will never be selected for this alias. If checked, "Cleared" Locations can be checked, but uncleared locations will be preferred if available. | ||
===Fill Type:=== | ===Fill Type:=== | ||