Difference between revisions of "Category:Conditions"

imported>Darkconsole
m (Script running global find and replace: = for '''=)
 
imported>Qazaaq
(Added editor object)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Overview==
Conditions are used in a number of places in the editor to tell the game when certain things should happen, and whether certain events or effects should be applied. Conditions are simply a list of one or more logical statements that specify the circumstances under which the associated editor item should be valid or take effect. In the case that a list of conditions evaluates to be false, the effect or event it is attached to will not happen.
Conditions are used in a number of places in the editor to tell the game when certain things should happen. Conditions are simply a list of one or more [[:Category:Console Commands|console commands]] that specify the circumstances under which a given editor item is valid. Conditions are used in the following editor sections:


* [[Idle Animations]]
== Editor Dialog ==
* [[Quest_Data_Tab|Quest Conditions]]
[[File:Condition_Editor.png]]
* [[Quest_Stages_Tab|Quest Stages]]
*'''<<:'''
* [[Quest_Objectives_Tab|Quest Objectives]]
*'''>>:'''
* [[:Category:Dialogue|Dialogue]]
*'''New:'''
* [[:Category:Packages|Packages]]
**[[:Category:Package_Templates#Procedure_Trees|Package Procedure Trees]]
** [[:Category:Procedures|Procedures]]


==The Condition List==
== Condition Item Editor ==
The condition list displays all of the individual Condition Items for this set of Conditions. Right-clicking in the list displays a popup menu which you can use to create New condition items, Duplicate or Delete existing condition items, Copy one or All items in the list, or Paste in items copied from elsewhere.
[[File:Condition_Item_Editor.png]]
*'''Run on:'''
**'''Swap Subject and Target:'''
*'''Condition Function:'''
*'''Parameters:'''
**'''Use Aliases:'''
**'''Use Pack data:'''
*'''Comparison:'''
**'''OR:'''
*'''Value:'''
**'''Use Global:'''




The << and >> buttons are used to move Condition Items up or down in the list, respectively, and the New button can be used to create a new item.
[[Category:Editor Reference]]
 
 
To edit a Condition Item, select it in the list and all of the data for that item will displayed in the controls beneath the list where the data can be altered.
 
 
The Condition Function dropdown list is the function to run. See [[:Category:Console Commands|Console Commands]] for the complete list of script functions that can be used as conditions.
 
===Run On===
The "Run on" field is used to indicate that the function should be run on the indicated actor.
 
Note: For some types, an additional drop down to the right of the "Run On" field specifies further data (for example, picking which alias to run on for "Quest Alias")
*'''Subject:''' The actor owning the object. In the case of dialogue, it's whoever is saying it. In the case of quest targets, it's the player.
*'''Target:''' For dialogue, this is the actor being spoken to. For Packages, it's the actor/object specified as the target.
*'''Reference:''' A specific reference in the world. Use the Select button to find the reference.
*'''Combat Target:''' If the owning actor is in combat, it is his current combat target.
*'''Linked Reference:''' If the reference is linked to another reference, it will used the linked object.
*'''Quest Alias:''' If the condition is being applied to something that is owned by a quest (dialogue in a quest, an alias in a quest, or a package who's "owning quest" is set to a particular quest) then you can select to run a condition on a reference alias.
*'''Package Data:''' you can point to package data that is a reference and run condition on that, however, this only works for conditions applied to [[packages]], [[procedures]], and procedure tree branches.
*'''Event Data:''' points to references in particular radiant quest event data (for example Actor1 in an ActorDialgoue event), like 'Run on Quest Alias' this only works for things owned by a quest of that type.
 
===Function Parameters===
The Function Parameters button opens up another dialog box in which parameters for the currently selected function can be set. This is where the Reference for a GetDistance function or the Faction for a GetFactionRank function is set.
 
===Comparison===
The Comparison dropdown list determines how the return value for the function is compared with the Comparison Value to determine if the condition item is true.
 
 
The Comparison Value is normally a text field where a value is entered by hand. However, if the '''Use Global''' checkbox is checked, the Value is instead a dropdown list in which a global variable can be selected to use as the Comparison Value instead.
 
 
The OR checkbox is used to determine how a Condition Item is evaluated with the ones that follow it. Consecutive ORs are treated like a single block when evaluating and have order preference over AND. For example, the condition items ( A AND B OR C AND D ) are evaluated as ( A AND ( B OR C ) AND D ) and not ( ( A AND B ) OR ( C AND D ) ).
 
 
[[Category:Quests]]

Latest revision as of 07:58, 22 October 2017

Conditions are used in a number of places in the editor to tell the game when certain things should happen, and whether certain events or effects should be applied. Conditions are simply a list of one or more logical statements that specify the circumstances under which the associated editor item should be valid or take effect. In the case that a list of conditions evaluates to be false, the effect or event it is attached to will not happen.

Editor DialogEdit

Condition Editor.png

  • <<:
  • >>:
  • New:

Condition Item EditorEdit

Condition Item Editor.png

  • Run on:
    • Swap Subject and Target:
  • Condition Function:
  • Parameters:
    • Use Aliases:
    • Use Pack data:
  • Comparison:
    • OR:
  • Value:
    • Use Global:

Subcategories

This category has the following 2 subcategories, out of 2 total.

P