Tile - YVector3 - Move Towards – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with " ---- {{Ylands scripting navbox}}")
 
No edit summary
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<!---
THIS PAGE WAS GENERATED AUTOMATICALLY; DO NOT EDIT IT, OTHERWISE YOUR CHANGES WILL BE LOST DURING FUTURE UPDATE.
-->
== Move Towards(A, B, Max Distance) ==
[[File:YlandsTile-152.png]]
<pre>static moveTowards(a: YVector3, b: YVector3, maxDistance: number): YVector3;</pre>
=== Parameters ===
==== a ====
Vector A
==== b ====
Vector B
==== maxDistance ====
Maximum distance
=== Returns ===
'''YVector3'''
=== Availability ===
[[Ylands:Tile Availability - Client|Client]], [[Ylands:Tile Availability - Server|Server]], [[Ylands:Tile Availability - Custom Controller|Custom Controller]]
=== Description ===
'''Moves''' point '''A''' in a straight line '''towards''' target point '''B''', '''limited''' by maximum distance (meters).
=== Notes ===
* If the '''target''' is '''closer''' than '''maximum distance''' then the returned value will be '''equal''' to '''target'''.
* '''Negative''' values of maximum distance can be used to '''push''' the point '''away''' from the target.




----
----
{{Ylands scripting navbox}}
{{Navbox/Ylands}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}}
 
[[Category: Instructions]]

Revision as of 12:17, 12 November 2021

Move Towards(A, B, Max Distance)

YlandsTile-152.png

static moveTowards(a: YVector3, b: YVector3, maxDistance: number): YVector3;

Parameters

a

Vector A

b

Vector B

maxDistance

Maximum distance

Returns

YVector3

Availability

Client, Server, Custom Controller

Description

Moves point A in a straight line towards target point B, limited by maximum distance (meters).

Notes

  • If the target is closer than maximum distance then the returned value will be equal to target.
  • Negative values of maximum distance can be used to push the point away from the target.