FF7/Field/Script/Opcodes/C2 LADER - Revision history

BukTop: 6 revisions imported

2019-05-23T02:18:27Z

6 revisions imported

my_wiki>BukTop: 5 revisions imported

2018-04-04T09:34:43Z

5 revisions imported

my_wiki>Synergy Blades: /* Description */ added effect for NPC.

2006-12-13T12:38:42Z

‎Description: added effect for NPC.

my_wiki>Synergy Blades at 14:30, 8 September 2006

2006-09-08T14:30:24Z

my_wiki>Synergy Blades: Memory

2006-09-08T14:26:02Z

Memory

my_wiki>Synergy Blades: /* Description */

2006-09-06T21:39:25Z

‎Description

my_wiki>Synergy Blades at 21:37, 6 September 2006

2006-09-06T21:37:59Z

New page

* Opcode: '''0xC2'''
* Short name: '''LADER'''
* Long name: Ladder

==== Memory layout ====
{| border="1" cellspacing="1" cellpadding="3" style="border: 1px solid black; border-collapse: collapse;"
! width="40" | 0xC2
! width="40" | ''0''
! width="40" | ''0''
! width="40" | ''X''
! width="40" | ''Y''
! width="40" | ''Z''
! width="40" | ''I''
! width="40" | ''K''
! width="40" | ''A''
! width="40" | ''D''
! width="40" | ''S''
|}

==== Arguments ====

* '''const UShort''' ''0'': Zero. Has an unusual effect on co-ordinates if non-zero.
* '''const Short''' ''X'': X-coordinate of the end of the ladder.
* '''const Short''' ''Y'': Y-coordinate of the end of the ladder.
* '''const Short''' ''Z'': Z-coordinate of the end of the ladder.
* '''const UShort''' ''I'': ID of the walkmesh triangle found at the end of the ladder.
* '''const UByte''' ''K'': The keys used to move the character on the ladder.
* '''const UByte''' ''A'': Animation ID for the field object's movement animation.
* '''const UByte''' ''D'': Direction the character faces when climbing the ladder.
* '''const UByte''' ''S'': Speed of the animation whilst climbing the ladder.

==== Description ====

Causes the character to climb a ladder; that is, switching from standard walkmesh movement, to climbing along a line connecting two points on the walkmesh.

The coordinates specify the end-point of the ladder; the current position of the character is used as the start point. The ID of the walkmesh triangle must be specified; this is the triangle the character will step onto after reaching the end point of the ladder. The '''K''' value specifies the keys used to move the character across the ladder; keys outside the range found in the table will cause unpredictable behaviour. The animation ID specifies an offset into the field object's animation list; this animation is played at the speed specified by '''S''' whilst the character climbs. Finally, the '''D''' argument is a direction value in the game's standard direction format, which orients the character on the ladder.

This opcode is used as part of the character's entity, rather than in a seperate entity, as with a [[FF7/Field/Script/Opcodes/D0 LINE|LINE]]. A LINE is used to set the start point of the ladder on the walkmesh. When this LINE is crossed by the player, a script in the LINE then uses a [[FF7/Field/Script/Opcodes/04 PREQ|PREQ]] (or one of its variants), calling the script in the party leader that defines the LADER, causing the character to begin its climbing position.

To set up a two-way ladder, two LINEs are used at either end, with different values for the LADER arguments, such as differing end points.

==== Key IDs ====

{| 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" | Key: Towards the end point
! style="background:rgb(204,204,204)" width="100" | Key: Towards the start point
|-
| align="center" | 0
| Down
| Up
|-
| align="center" | 1
| Up
| Down
|-
| align="center" | 2
| Right
| Left
|-
| align="center" | 3
| Left
| Right
|-
|}

@@ Line 37: / Line 37: @@
 Causes the character to climb a ladder; that is, switching from standard walkmesh movement, to climbing along a line connecting two points on the walkmesh.
-If ''B1'', ''B2'', ''B3'' or ''B4'' is non-zero, then the value for that particular component is taken from memory using the corresponding bank and address specified, rather than as a literal value. Both retrieved values and literals can be used for different components.
+If ''B1'', ''B2'', ''B3'' or ''B4'' is non-zero, then the value for that particular component is taken from memory using the corresponding bank and address specified, rather than as a literal value. Both retrieved values and literals can be used for different components. If using ''X'', ''Y'', ''Z'' or ''I'' as addresses, the lower byte should hold the address whilst the higher byte should be zero.
 The coordinates specify the end-point of the ladder; the current position of the character is used as the start point. The ID of the walkmesh triangle must be specified; this is the triangle the character will step onto after reaching the end point of the ladder. The '''K''' value specifies the keys used to move the character across the ladder; keys outside the range found in the table will cause unpredictable behaviour. The animation ID specifies an offset into the field object's animation list; this animation is played at the speed specified by '''S''' whilst the character climbs. Finally, the '''D''' argument is a direction value in the game's standard direction format, which orients the character on the ladder.

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

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

@@ Line 40: / Line 40: @@
 The coordinates specify the end-point of the ladder; the current position of the character is used as the start point. The ID of the walkmesh triangle must be specified; this is the triangle the character will step onto after reaching the end point of the ladder. The '''K''' value specifies the keys used to move the character across the ladder; keys outside the range found in the table will cause unpredictable behaviour. The animation ID specifies an offset into the field object's animation list; this animation is played at the speed specified by '''S''' whilst the character climbs. Finally, the '''D''' argument is a direction value in the game's standard direction format, which orients the character on the ladder.
 This opcode is used as part of the character's entity, rather than in a seperate entity, as with a [[FF7/Field/Script/Opcodes/D0 LINE|LINE]]. A LINE is used to set the start point of the ladder on the walkmesh. When this LINE is crossed by the player, a script in the LINE then uses a [[FF7/Field/Script/Opcodes/04 PREQ|PREQ]] (or one of its variants), calling the script in the party leader that defines the LADER, causing the character to switch to 'climbing mode'.
 To set up a two-way ladder, two LINEs are used at either end, with different values for the LADER arguments, such as differing end points.
 ==== Key IDs ====

@@ Line 6: / Line 6: @@
 {| border="1" cellspacing="1" cellpadding="3" style="border: 1px solid black; border-collapse: collapse;"
 ! width="40" | 0xC2
-! width="40" | ''0''
+! width="50" | ''B1 / B2''
-! width="40" | ''0''
+! width="50" | ''B3 / B4''
-! width="40" | ''X''
+! width="80" | ''X''
-! width="40" | ''Y''
+! width="80" | ''Y''
-! width="40" | ''Z''
+! width="80" | ''Z''
-! width="40" | ''I''
+! width="80" | ''I''
 ! width="40" | ''K''
 ! width="40" | ''A''
@@ Line 20: / Line 20: @@
 ==== Arguments ====
-* '''const UShort''' ''0'': Zero. Has an unusual effect on co-ordinates if non-zero.
+* '''const Bit[4]''' ''B1'': Bank to retrieve X-coordinate, or zero if ''X'' is specified as a literal value.
-* '''const Short''' ''X'': X-coordinate of the end of the ladder.
+* '''const Bit[4]''' ''B2'': Bank to retrieve Y-coordinate, or zero if ''Y'' is specified as a literal value.
-* '''const Short''' ''Y'': Y-coordinate of the end of the ladder.
+* '''const Bit[4]''' ''B3'': Bank to retrieve Z-coordinate, or zero if ''Z'' is specified as a literal value.
-* '''const Short''' ''Z'': Z-coordinate of the end of the ladder.
+* '''const Bit[4]''' ''B4'': Bank to retrieve ID, or zero if ''I'' is specified as a literal value.
-* '''const UShort''' ''I'': ID of the walkmesh triangle found at the end of the ladder.
+* '''const Short''' ''X'': X-coordinate of the end of the ladder, or address to find X-coordinate if ''B1'' is non-zero.
 * '''const UByte''' ''K'': The keys used to move the character on the ladder.
 * '''const UByte''' ''A'': Animation ID for the field object's movement animation.
@@ Line 33: / Line 36: @@
 Causes the character to climb a ladder; that is, switching from standard walkmesh movement, to climbing along a line connecting two points on the walkmesh.
 The coordinates specify the end-point of the ladder; the current position of the character is used as the start point. The ID of the walkmesh triangle must be specified; this is the triangle the character will step onto after reaching the end point of the ladder. The '''K''' value specifies the keys used to move the character across the ladder; keys outside the range found in the table will cause unpredictable behaviour. The animation ID specifies an offset into the field object's animation list; this animation is played at the speed specified by '''S''' whilst the character climbs. Finally, the '''D''' argument is a direction value in the game's standard direction format, which orients the character on the ladder.