Andrew Branscom: 2 revisions imported

2025-02-16T20:22:26Z

2 revisions imported

← Older revision	Revision as of 16:22, 16 February 2025
(No difference)

Andrew Branscom: 1 revision imported

2024-06-03T04:55:23Z

1 revision imported

← Older revision	Revision as of 00:55, 3 June 2024
(No difference)

Andrew Branscom: 1 revision imported

2022-01-28T16:19:38Z

1 revision imported

New page

The '''distance''' command calculates the distance between two [[screen objects]], and stores the result in a [[variable]].

== Syntax ==

distance([[screen object|obj]] oA,[[screen object|obj]] oB, [[variable|var]] vC);

== Remarks ==

Variable '''vC''' is set to distance between objects '''oA''' and '''oB'''. The distance calculated in NOT the shortest straight line between the two objects. Instead, AGI uses the following formula:

'''<code>d = Abs(y1 - y2) + Abs((x1 + w1 / 2) - (x2 + w2 / 2))</code>'''

where
:d = distance
:x1, y1, w1 = horizontal position, vertical position and width of first object
:x2, y2, w2 = horizontal position, vertical position and width of second object
Basically, this means that AGI calculates the distance by adding the difference in horizontal position of the objects' center points to the difference in the objects' vertical positions. (When calculating the center points, results round down, i.e. if width is 13, then width / 2 = 6, not 7).

If either object is not on screen (or not initialized), distance is set to 255. If both objects are visible, and the distance is 255 or greater, the result is set to 254.

== Possible Errors ==

None.

== Example ==

<div class="CodeBlockHeader">Code:</div>
<syntaxhighlight lang="agi">
[ object 0 is at (110, 100); width is 6
[ object 1 is at (98, 161); width is 13
distance(o0, 01, v50); [ v50 now equals 70
</syntaxhighlight>

== Technical Information ==

{| border="1" cellpadding="2"
| style="background-color: #efefef" width="200" | '''Required Interpreter Version:'''
| width="175" | Available in all AGI versions.
|-
| style="background-color: #efefef" | '''Byte-Code Value:'''
| 69 (0x45 hex)
|}

== See Also ==

[[Screen Object/View Commands]]<br />
[[Category:Commands]]<br />

Distance - Revision history

Andrew Branscom: 2 revisions imported

Andrew Branscom: 1 revision imported

Andrew Branscom: 1 revision imported