Tile - YAnimators - Aim To – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
m (YlandsClassyBot moved page Ylands Tile - Aim to object to Ylands:Tile - YAnimators - Aim To: New Structure)
No edit summary
Line 1: Line 1:
[[Image:Aim to object.png]]
<!---
*'''Animation''' script tile, which rotates selected '''object''' to '''target'''.
THIS PAGE WAS GENERATED AUTOMATICALLY; DO NOT EDIT IT, OTHERWISE YOUR CHANGES WILL BE LOST DURING FUTURE UPDATE.
*Both '''object''' and '''target''' can be entity, group or game logic.
-->
*'''Target offset''' defines offset of the '''aimed''' position. Further defined by the '''relative offset''' option.
== Aim To(Object, Target, Target offset, Relative offset, Max speed, Acceleration, Angle to start, Angle to end, X, Y, Z) ==
*'''Max speed''' and '''acceleration''' define the angular velocity properties of the animation.
 
*'''Angle to start/stop''' work similarly as '''distance to start/stop''' in [[Ylands Tile - Follow object|'''Follow object''']] animation script tile.
[[File:YlandsTile-607.png]]
*'''Axis''' options define, if the aiming rotation happens around selected axis.
 
<pre>static aimTo(obj: YEntity | YLogic | YGroup, targetObject: YEntity | YLogic | YGroup, offset: YVector3, offsetIsRelative: boolean, maxSpeed: number, acceleration: number, distanceToStartRotation: number, distanceToEndRotation: number, x: boolean, y: boolean, z: boolean): void;</pre>
=== Parameters ===
 
==== obj ====
 
==== targetObject ====
 
==== offset ====
 
==== offsetIsRelative ====
 
==== maxSpeed ====
 
==== acceleration ====
 
==== distanceToStartRotation ====
 
==== distanceToEndRotation ====
 
==== x ====
 
==== y ====
 
==== z ====
 
=== Description ===
 
Selected '''animated object''' will rotate to '''aim to''' the '''target'''.
 
=== Notes ===
 
* The aim to instruction will stop when it reaches the '''angle to end''', and start again when the distance is greater than ''angle to start''
* Every time the ain to stops or starts, '''animator events''' are spawned


NOTE: Object needs to be set to '''Animated'''.


----
----
Line 14: Line 46:


[[Category: Instructions]]
[[Category: Instructions]]
[[Category: Ylands 0.13]]

Revision as of 08:51, 8 July 2021

Aim To(Object, Target, Target offset, Relative offset, Max speed, Acceleration, Angle to start, Angle to end, X, Y, Z)

YlandsTile-607.png

static aimTo(obj: YEntity | YLogic | YGroup, targetObject: YEntity | YLogic | YGroup, offset: YVector3, offsetIsRelative: boolean, maxSpeed: number, acceleration: number, distanceToStartRotation: number, distanceToEndRotation: number, x: boolean, y: boolean, z: boolean): void;

Parameters

obj

targetObject

offset

offsetIsRelative

maxSpeed

acceleration

distanceToStartRotation

distanceToEndRotation

x

y

z

Description

Selected animated object will rotate to aim to the target.

Notes

  • The aim to instruction will stop when it reaches the angle to end, and start again when the distance is greater than angle to start
  • Every time the ain to stops or starts, animator events are spawned