Tile - YAnimators - Follow – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}}" to "{{DEFAULTSORT:{{#sub:{{PAGENAME}}|7}}}}")
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Image:Aim to object.png]]
<!---
*'''Animation''' script tile, which moves 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 '''followed''' object position. Further defined by the '''relative offset''' option.
== Follow(Object, Target, Target offset, Relative offset, Max speed, Acceleration, Distance to start, Distance to end) ==
*'''Max speed''' and '''acceleration''' define the velocity properties of the animation.
 
*'''Distance to start/stop''' sets when the distance is big enough to start following or small enough to stop following.
[[File:YlandsTile-606.png]]
 
<pre>static follow(obj: YEntity | YLogic | YGroup, targetObject: YEntity | YLogic | YGroup, offset: YVector3, offsetIsRelative: boolean, maxSpeed: number, acceleration: number, distanceToStartMovement: number, distanceToEndMovement: number): void;</pre>
=== Parameters ===
 
==== obj ====
 
Target object to be moved
 
==== targetObject ====
 
Target object to be followed
 
==== offset ====
 
Position offset from the target object (vector)
 
==== offsetIsRelative ====
 
Whether is the offset relative to the target orientation
 
==== maxSpeed ====
 
Maximum movement speed (m/s)
 
==== acceleration ====
 
Movement acceleration (m/s^2)
 
==== distanceToStartMovement ====
 
Minimal distance from target to resume the movement (meters)
 
==== distanceToEndMovement ====
 
Maximal distance from target to end the movement (meters)
 
=== Availability ===
 
[[Ylands:Tile Availability - Server|Server]]
 
=== Description ===
 
Moves selected '''animated object''' towards '''target''' object.
 
=== Notes ===
 
* Offset can be set as relative, that will apply the offset in the objects local space (takes into account the objects rotation)
* The movement will stop when it reaches the '''distance to end''', and start again when the distance is greater than ''distance to start''
* Every time the follow stops or starts, '''animator events''' are spawned
 


----
----
{{Ylands scripting navbox}}
{{Navbox/Ylands}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|7}}}}


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

Latest revision as of 14:24, 24 November 2023

Follow(Object, Target, Target offset, Relative offset, Max speed, Acceleration, Distance to start, Distance to end)

YlandsTile-606.png 

static follow(obj: YEntity | YLogic | YGroup, targetObject: YEntity | YLogic | YGroup, offset: YVector3, offsetIsRelative: boolean, maxSpeed: number, acceleration: number, distanceToStartMovement: number, distanceToEndMovement: number): void;

Parameters

obj

Target object to be moved

targetObject

Target object to be followed

offset

Position offset from the target object (vector)

offsetIsRelative

Whether is the offset relative to the target orientation

maxSpeed

Maximum movement speed (m/s)

acceleration

Movement acceleration (m/s^2)

distanceToStartMovement

Minimal distance from target to resume the movement (meters)

distanceToEndMovement

Maximal distance from target to end the movement (meters)

Availability

Server

Description

Moves selected animated object towards target object.

Notes

  • Offset can be set as relative, that will apply the offset in the objects local space (takes into account the objects rotation)
  • The movement will stop when it reaches the distance to end, and start again when the distance is greater than distance to start
  • Every time the follow stops or starts, animator events are spawned


Ylands - Editor
Editor

Animated objects, Custom UI, Entity welding, Game export, Game ID, Monetization, MIDI music, Optimizations, Common Problems, FAQ

Script

Introduction, Conventions, Client script, Text scripting, Custom controls, Custom controller, Storage Data, Game set, Leaderboards, Matchmaking, Map markers

Game logic

AI Behaviour, Ask Player, Controller, Custom Camera, Custom Controls, Custom HUD, Custom Window, Data Set, Dialogue, Entity Label, Entity Storage, Entity Template, Environment, Event Listener, Game Logic Label, Game Logic Storage, Game Logic Template, Global Storage, Group Template, Image Library, Impassable Barrier, Light, Melee Attack Effect, Particle Effect, Particle Template, Path, Play Area, Player Role, Player Team, Position Animator, Post Process, Reference Point, Resource, Rotation Animator, Script Module, Skill, Sound Effect, Spawn Point, Time Trigger, Transaction, Trigger Zone, Voice Chat Channel, Water Volume

Script tiles

Game, Entities, Game Logic, Logic, Loops, Instructions, Number, Vector, Color, String, Array

Misc

WIKI FAQ

Retrieved from "https://community.bistudio.com/wiki?title=Ylands:Tile_-_YAnimators_-_Follow&oldid=350390"