Skip to content

Commit

Permalink
Merge pull request #170 from Bubb13/trigger-object-selectors
Browse files Browse the repository at this point in the history 
Add notes about special object selector behaviors for triggers
  • Loading branch information
@lynxlynxlynx
lynxlynxlynx authored Apr 23, 2024
2 parents 80773dd + 73f94bf commit 1ba5c6f
Showing 1 changed file with 57 additions and 7 deletions.
64 changes: 57 additions & 7 deletions scripting/triggers/bgeetriggers.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,22 @@
<div class="triggerHeader"><a name="0x400A">0x400A Alignment(O:Object*,I:Alignment*Align)</a></div>
<div class="indent1">
Returns true only if the <a href="../../files/ids/bgee/align.htm">alignment</a> of the specified object matches that in the second parameter.

{% capture note %}
Doesn't evaluate object selectors (e.g. [PC]).
{% endcapture %}
{% include bug.html %}
</div>
<br />

<div class="triggerHeader"><a name="0x400B">0x400B Allegiance(O:Object*,I:Allegience*EA)</a></div>
<div class="indent1">
Returns true only if the <a href="../../files/ids/bgee/ea.htm">Enemy/Ally</a> status of the specified object matches that in the second parameter.

{% capture note %}
Doesn't evaluate object selectors (e.g. [PC]).
{% endcapture %}
{% include bug.html %}
</div>
<br />

Expand All @@ -88,6 +98,11 @@
<div class="triggerHeader"><a name="0x400E">0x400E General(O:Object*,I:General*General)</a></div>
<div class="indent1">
Returns true only if the <a href="../../files/ids/bgee/general.htm">General</a> category of the specified object matches that in the second parameter.

{% capture note %}
Doesn't evaluate object selectors (e.g. [PC]).
{% endcapture %}
{% include bug.html %}
</div>
<br />

Expand Down Expand Up @@ -142,6 +157,11 @@
<div class="triggerHeader"><a name="0x4017">0x4017 Race(O:Object*,I:Race*Race)</a></div>
<div class="indent1">
Returns true only if the <a href="../../files/ids/bgee/race.htm">Race</a> of the specified object is the same as that specified by the 2<small><sup>nd</sup></small> parameter.

{% capture note %}
Doesn't evaluate object selectors (e.g. [PC]).
{% endcapture %}
{% include bug.html %}
</div>
<br />

Expand Down Expand Up @@ -178,6 +198,11 @@
<div class="triggerHeader"><a name="0x401D">0x401D Specifics(O:Object*,I:Specifics*Specific)</a></div>
<div class="indent1">
Returns true only if the <a href="../../files/ids/bgee/specific.htm">specifics</a> (as set in the <a href="../../file_formats/ie_formats/cre_v1.htm#CREV1_0_Header_0x274">CRE</a> file or by the <a href="../actions/bgeeactions.htm#157">ChangeSpecifics()</a> action) of the specified object is equal to the 2<small><sup>nd</sup></small> parameter.

{% capture note %}
Doesn't evaluate object selectors (e.g. [PC]).
{% endcapture %}
{% include bug.html %}
</div>
<br />

Expand Down Expand Up @@ -444,13 +469,18 @@

<div class="triggerHeader"><a name="0x4043">0x4043 InParty(O:Object*)</a></div>
<div class="indent1">
Returns true only if the specifed object is in the player's party.
Returns true only if the specified object is in the player's party.

{% capture note %}
Alternate object selector (e.g. [PC]) behavior &mdash; returns true if a party member matches against the selector.
{% endcapture %}
{% include info.html %}
</div>
<br />

<div class="triggerHeader"><a name="0x4044">0x4044 CheckStat(O:Object*,I:Value*,I:StatNum*Stats)</a></div>
<div class="indent1">
Returns true only if the specifed object has the <a href="../../files/ids/bgee/stats.htm">statistic</a> in the 3<small><sup>rd</sup></small> parameter at the value of the 2<small><sup>nd</sup></small> parameter.
Returns true only if the specified object has the <a href="../../files/ids/bgee/stats.htm">statistic</a> in the 3<small><sup>rd</sup></small> parameter at the value of the 2<small><sup>nd</sup></small> parameter.

{% capture note %}
This trigger looks at the entire value of any <code><a href="../../files/ids/bgee/stats.htm">STAT</a></code> (16 or 32 bits, depending on the <code><a href="../../files/ids/bgee/stats.htm">STAT</a></code>).
Expand All @@ -461,7 +491,7 @@

<div class="triggerHeader"><a name="0x4045">0x4045 CheckStatGT(O:Object*,I:Value*,I:StatNum*Stats)</a></div>
<div class="indent1">
Returns true only if the specifed object has the <a href="../../files/ids/bgee/stats.htm">statistic</a> in the 3<small><sup>rd</sup></small> parameter greater than the value of the 2<small><sup>nd</sup></small> parameter.
Returns true only if the specified object has the <a href="../../files/ids/bgee/stats.htm">statistic</a> in the 3<small><sup>rd</sup></small> parameter greater than the value of the 2<small><sup>nd</sup></small> parameter.

{% capture note %}
This trigger looks at the entire value of any <code><a href="../../files/ids/bgee/stats.htm">STAT</a></code> (16 or 32 bits, depending on the <code><a href="../../files/ids/bgee/stats.htm">STAT</a></code>).
Expand All @@ -472,7 +502,7 @@

<div class="triggerHeader"><a name="0x4046">0x4046 CheckStatLT(O:Object*,I:Value*,I:StatNum*Stats)</a></div>
<div class="indent1">
Returns true only if the specifed object has the <a href="../../files/ids/bgee/stats.htm">statistic</a> in the 3<small><sup>rd</sup></small> parameter less than the value of the 2<small><sup>nd</sup></small> parameter.
Returns true only if the specified object has the <a href="../../files/ids/bgee/stats.htm">statistic</a> in the 3<small><sup>rd</sup></small> parameter less than the value of the 2<small><sup>nd</sup></small> parameter.

{% capture note %}
This trigger looks at the entire value of any <code><a href="../../files/ids/bgee/stats.htm">STAT</a></code> (16 or 32 bits, depending on the <code><a href="../../files/ids/bgee/stats.htm">STAT</a></code>).
Expand Down Expand Up @@ -525,6 +555,11 @@
<div class="triggerHeader"><a name="0x404D">0x404D Gender(O:Object*,I:Sex*Gender)</a></div>
<div class="indent1">
Returns true only if the <a href="../../files/ids/bgee/gender.htm">gender</a> of the specified object is that given in the 2<small><sup>nd</sup></small> parameter.

{% capture note %}
Doesn't evaluate object selectors (e.g. [PC]).
{% endcapture %}
{% include bug.html %}
</div>
<br />

Expand Down Expand Up @@ -653,7 +688,12 @@

<div class="triggerHeader"><a name="0x4062">0x4062 InteractingWith(O:Object*)</a></div>
<div class="indent1">
NT Returns true only if the active <a href="../../file_formats/ie_formats/cre_v1.htm">CRE</a> is interacting (dialogue?) with the specified object.
Returns true only if the active <a href="../../file_formats/ie_formats/cre_v1.htm">CRE</a>'s latest target using the <code><a href="../actions/bgeeactions.htm#168">Interact()</a></code> action is the specified object.

{% capture note %}
Alternate object selector (e.g. [PC]) behavior &mdash; returns true if the active <a href="../../file_formats/ie_formats/cre_v1.htm">CRE</a>'s latest target using the <code><a href="../actions/bgeeactions.htm#168">Interact()</a></code> action matches against the selector.
{% endcapture %}
{% include info.html %}
</div>
<br />

Expand Down Expand Up @@ -913,6 +953,11 @@
<div class="triggerHeader"><a name="0x4090">0x4090 InPartySlot(O:Object*,I:Slot*)</a></div>
<div class="indent1">
Returns true only if the specified object is in the party and in the slot specified (slots are 0-5). Party slots are based on join order; Player1 is in slot 0, Player2 in slot 1 etc.

{% capture note %}
Alternate object selector (e.g. [PC]) behavior &mdash; returns true if the party member in the specified slot matches against the selector.
{% endcapture %}
{% include info.html %}
</div>
<br />

Expand Down Expand Up @@ -1070,7 +1115,7 @@
<div class="triggerHeader"><a name="0x40A8">0x40A8 IsValidForPartyDialogue(O:Object*)</a></div>
<div class="triggerHeader"><a name="0x40A8">0x40A8 IfValidForPartyDialogue(O:Object*)</a></div>
<div class="indent1">
Returns true only if that specifed party member can take part in party dialogue.
Returns true only if that specified party member can take part in party dialogue.
</div>
<br />

Expand Down Expand Up @@ -1321,7 +1366,12 @@

<div class="triggerHeader"><a name="0x40D3">0x40D3 InPartyAllowDead(O:Object*)</a></div>
<div class="indent1">
NT Returns true if the specified object which can be dead or alive is in the party.
Returns true only if the specified object, which can be dead or alive, is in the player's party.

{% capture note %}
Alternate object selector (e.g. [PC]) behavior &mdash; returns true if a party member, which can be dead or alive, matches against the selector.
{% endcapture %}
{% include info.html %}
</div>
<br />

Expand Down

0 comments on commit 1ba5c6f

Please sign in to comment.