FF7/Field/Script/Opcodes/14 IFUB - Revision history

BukTop: 8 revisions imported

2019-05-23T02:16:34Z

8 revisions imported

my_wiki>BukTop: 7 revisions imported

2018-04-04T09:34:25Z

7 revisions imported

my_wiki>Synergy Blades at 12:22, 7 September 2006

2006-09-07T12:22:17Z

my_wiki>Synergy Blades at 12:22, 7 September 2006

2006-09-07T12:22:02Z

my_wiki>Synergy Blades: Bank nibble

2006-08-24T22:23:07Z

Bank nibble

my_wiki>Synergy Blades: 'else' clarification

2006-08-17T22:01:03Z

'else' clarification

my_wiki>Synergy Blades: /* Comparison Types */ prettier

2006-08-17T21:56:30Z

‎Comparison Types: prettier

my_wiki>Synergy Blades: /* If/Else Example */

2006-08-17T21:54:41Z

‎If/Else Example

my_wiki>Synergy Blades at 21:46, 17 August 2006

2006-08-17T21:46:32Z

New page

* Opcode: '''0x14'''
* Short name: '''IFUB'''
* Long name: If (Unsigned Byte)

==== Memory layout ====
{| border="1" cellspacing="1" cellpadding="3" style="border: 1px solid black; border-collapse: collapse;"
! width="40" | 0x14
! width="40" | ''B''
! width="40" | ''A''
! width="40" | ''V''
! width="40" | ''C''
! width="40" | ''E''
|}

==== Arguments ====

* '''const UByte''' ''B'': Memory bank to access.
* '''const UByte''' ''A'': Address of the value to retrieve.
* '''const UByte''' ''V'': Unsigned value to compare the retrieved value to.
* '''const UByte''' ''C'': Type of comparison to perform.
* '''const UByte''' ''E'': Amount to jump if the comparison does not hold.

==== Description ====

Performs a comparison between a retrieved value from memory (Bank and Address), and the unsigned byte Value given in the argument list. The type of comparison used is shown in the table below. If the comparison fails, the script pointer jumps forward by the amount specified in the final argument; the starting offset for this jump is just before the jump value argument itself. This is used to implement if/else functionality in scripts, as demonstrated below.

If the content of the 'if' block following the IFUB line is longer than 0xFF, the 'else' argument will also need to be longer than 0xFF, and hence you should use [[FF7/Field/Script/Opcodes/15 IFUBL|IFUBL]] instead. If the value or address is larger than 0xFF, you should use the [[FF7/Field/Script/Opcodes/18 IFUW|IFUW]]/[[FF7/Field/Script/Opcodes/19 IFUWL|IFUWL]] variants. If the value you are comparing is negative, you should use the [[FF7/Field/Script/Opcodes/16 IFSW|IFSW]]/[[FF7/Field/Script/Opcodes/17 IFSWL|IFSWL]] variants.

==== Comparison Types ====

{| border="1" cellspacing="1" cellpadding="3" style="border: 1px solid black; border-collapse: collapse;"
! style="background:rgb(204,204,204)" width="40" | ID
! style="background:rgb(204,204,204)" width="100" | Comparison Performed
|-
| align="center" | 0
| A == B
|-
| align="center" | 1
| A != B
|-
| align="center" | 2
| A > B
|-
| align="center" | 3
| A < B
|-
| align="center" | 4
| A >= B
|-
| align="center" | 5
| A <= B
|-
| align="center" | 6
| A & B
|-
| align="center" | 7
| A ^ B
|-
| align="center" | 8
| A | B
|-
| align="center" | 9
| A & (1<<B)
|-
| align="center" | A
| !((A & (1<<B)))
|-
|}

==== If/Else Example ====

In this example, if the value found is greater than 0x30, the script halts for a shorter period of time; otherwise, the script halts for a long period of time.

<pre>
IFUB (10,20,30,02,06)
WAIT (00,01)
JMPF (04)
WAIT (00,04)
RET ()
</pre>

<cpp>
if(<10>[20] > 30)
{
WAIT(100);
}
else
{
WAIT(400);
}

return;
</cpp>

@@ Line 6: / Line 6: @@
 {| border="1" cellspacing="1" cellpadding="3" style="border: 1px solid black; border-collapse: collapse;"
 ! width="40" | 0x14
-! width="40" | ''B / 0''
+! width="40" | ''B1 / B2''
 ! width="40" | ''A''
 ! width="40" | ''V''
@@ Line 15: / Line 15: @@
 ==== Arguments ====
-* '''const Bit[4]''' ''B'': Memory bank to access.
+* '''const Bit[4]''' ''B1'': First memory bank to access.
-* '''const Bit[4]''' ''0'': Zero.
+* '''const Bit[4]''' ''B2'': Second memory bank to access.
-* '''const UByte''' ''A'': Address of the value to retrieve.
+* '''const UByte''' ''A'': Address, from the first bank, of the value to retrieve.
-* '''const UByte''' ''V'': Unsigned value to compare the retrieved value to.
+* '''const UByte''' ''V'': Unsigned value to compare the retrieved value to, or address from the second bank of the value to retrieve.
 * '''const UByte''' ''C'': Type of comparison to perform.
 * '''const UByte''' ''E'': Amount to jump if the comparison does not hold.
@@ Line 24: / Line 24: @@
 ==== Description ====
-Performs a comparison between a retrieved value from memory (Bank and Address), and the unsigned byte Value given in the argument list. The type of comparison used is shown in the table below. If the comparison fails, the script pointer jumps forward by the amount specified in the final argument; the starting offset for this jump is just before the jump value argument itself. This, combined with an appropriate [[FF7/Field/Script/Opcodes/10 JMPF|jump forward]], is used to implement if/else functionality in scripts, as demonstrated below.
+Performs a comparison between a retrieved values from memory at specific banks and addresses. If '''B2''' is zero, then the value retrieved from bank '''B1''', address '''A''' is compared with the value specified by '''V'''. If '''B2''' is not zero, then the value retrieved from bank '''B1''', address '''A''' is compared with the value retrieved from bank '''B2''', address '''V'''.
-If the content of the 'if' block following the IFUB line is longer than 0xFF, the jump argument will also need to be longer than 0xFF, and hence you should use [[FF7/Field/Script/Opcodes/15 IFUBL|IFUBL]] instead. If the value or address is larger than 0xFF, you should use the [[FF7/Field/Script/Opcodes/18 IFUW|IFUW]]/[[FF7/Field/Script/Opcodes/19 IFUWL|IFUWL]] variants. If the value you are comparing is negative, you should use the [[FF7/Field/Script/Opcodes/16 IFSW|IFSW]]/[[FF7/Field/Script/Opcodes/17 IFSWL|IFSWL]] variants.
+The type of comparison used is shown in the table below. If the comparison fails, the script pointer jumps forward by the amount specified in the final argument; the starting offset for this jump is just before the jump value argument itself. This, combined with an appropriate [[FF7/Field/Script/Opcodes/10 JMPF|jump forward]], is used to implement if/else functionality in scripts, as demonstrated below.
 ==== Comparison Types ====

@@ Line 23: / Line 23: @@
 ==== Description ====
-Performs a comparison between a retrieved value from memory (Bank and Address), and the unsigned byte Value given in the argument list. The type of comparison used is shown in the table below. If the comparison fails, the script pointer jumps forward by the amount specified in the final argument; the starting offset for this jump is just before the jump value argument itself. This is used to implement if/else functionality in scripts, as demonstrated below.
+Performs a comparison between a retrieved value from memory (Bank and Address), and the unsigned byte Value given in the argument list. The type of comparison used is shown in the table below. If the comparison fails, the script pointer jumps forward by the amount specified in the final argument; the starting offset for this jump is just before the jump value argument itself. This, combined with an appropriate [[FF7/Field/Script/Opcodes/10 JMPF|jump forward]], is used to implement if/else functionality in scripts, as demonstrated below.
-If the content of the 'if' block following the IFUB line is longer than 0xFF, the 'else' argument will also need to be longer than 0xFF, and hence you should use [[FF7/Field/Script/Opcodes/15 IFUBL|IFUBL]] instead. If the value or address is larger than 0xFF, you should use the [[FF7/Field/Script/Opcodes/18 IFUW|IFUW]]/[[FF7/Field/Script/Opcodes/19 IFUWL|IFUWL]] variants. If the value you are comparing is negative, you should use the [[FF7/Field/Script/Opcodes/16 IFSW|IFSW]]/[[FF7/Field/Script/Opcodes/17 IFSWL|IFSWL]] variants.
+If the content of the 'if' block following the IFUB line is longer than 0xFF, the jump argument will also need to be longer than 0xFF, and hence you should use [[FF7/Field/Script/Opcodes/15 IFUBL|IFUBL]] instead. If the value or address is larger than 0xFF, you should use the [[FF7/Field/Script/Opcodes/18 IFUW|IFUW]]/[[FF7/Field/Script/Opcodes/19 IFUWL|IFUWL]] variants. If the value you are comparing is negative, you should use the [[FF7/Field/Script/Opcodes/16 IFSW|IFSW]]/[[FF7/Field/Script/Opcodes/17 IFSWL|IFSWL]] variants.
 ==== Comparison Types ====
@@ Line 70: / Line 70: @@
 ==== If/Else Example ====
-In this example, if the value found is greater than 0x30, the script halts for a shorter period of time; otherwise, the script halts for a long period of time. Note how the jump forward placed before the longer WAIT ensures that on completion of the 'if' block, execution of the 'else' block is avoided. It jumps forward to just before the 0x200 WAIT, which it then executes, and returns.
+In this example, if the value found is greater than 0x30, the script halts for a shorter period of time; otherwise, the script halts for a long period of time. Note how the jump forward placed before the longer WAIT (start of the required 'else' block) ensures that on completion of the 'if' block, execution of the 'else' block is avoided. It jumps forward to just before the 0x200 WAIT, which it then executes, and returns.
 The 'else' block only executes if it is jumped into by the final argument of the IFUB argument list (thus avoiding the execution of the 'if' block). Once the 'else' block is executed, script execution just continues and the 0x200 WAIT and RET is executed. Since this is also executed by the 'if' block having jumped forward to skip the else block, this demonstrates that the two code paths converge. In C++ (below) this is the equivalent of the if/else block being completed.

← Older revision	Revision as of 02:16, 23 May 2019
(No difference)

← Older revision	Revision as of 09:34, 4 April 2018
(No difference)

@@ Line 34: / Line 34: @@
 |-
 | align="center" | 0
-| A == B
+| align="center" | A == B
 |-
 | align="center" | 1
-| A != B
+| align="center" | A != B
 |-
 | align="center" | 2
-| A > B
+| align="center" | A > B
 |-
 | align="center" | 3
-| A < B
+| align="center" | A < B
 |-
 | align="center" | 4
-| A >= B
+| align="center" | A >= B
 |-
 | align="center" | 5
-| A <= B
+| align="center" | A <= B
 |-
 | align="center" | 6
-| A & B
+| align="center" | A & B
 |-
 | align="center" | 7
-| A ^ B
+| align="center" | A ^ B
 |-
 | align="center" | 8
-| A | B
+| align="center" | A | B
 |-
 | align="center" | 9
-| A & (1<<B)
+| align="center" | A & (1<<B)
 |-
 | align="center" | A
-| !((A & (1<<B)))
+| align="center" | !((A & (1<<B)))
 |-
 |}
 ==== If/Else Example ====

@@ Line 71: / Line 71: @@
 ==== If/Else Example ====
-In this example, if the value found is greater than 0x30, the script halts for a shorter period of time; otherwise, the script halts for a long period of time.
+In this example, if the value found is greater than 0x30, the script halts for a shorter period of time; otherwise, the script halts for a long period of time. Note how the jump forward placed before the longer WAIT ensures that on completion of the 'if' block, execution of the 'else' block is avoided. It jumps forward to just before the 0x200 WAIT, which it then executes, and returns.
 <pre>
@@ Line 78: / Line 80: @@
 JMPF (04)
 WAIT (00,04)
 RET ()
 </pre>
@@ Line 91: / Line 94: @@
+  }
   return;
 </cpp>