Animated objects – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "[[Ylands " to "[[Ylands:")
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Overview=
=Overview=
Animated objects are objects which can be animated using visual scripting. Object can be animated when "animated" property is checked in entity, game logic or group properties. Animation can be then applied onto selected object either by assigning appropriate game logic or by using corresponding instruction.  
Animated objects are objects which can be made to move using visual scripting. Object can be animated when "animated" option is enabled in their properties panel. Eligible objects are - entities, selected game logic and groups. Animation can be then applied onto selected object either by assigning appropriate "animator" game logic or by using corresponding instructions.
 
*Objects in a group are automatically "animation enabled" if group their is, so it is not need to set it for each individual object in the group.
*Children groups of animated group will move with a parent, so they do not need to be "animation enabled". They have to only if you want to animate them independently from their parent.


<gallery>
<gallery>
Image:Ylands-Editor-Animator-example3.gif|Animated object
Image:Ylands-Editor-Animator-example3.gif|Animated object
Image:Ylands-Editor-Animator-example1.png|Animation properties
</gallery>
</gallery>


=Animator game logic=
=== Properties ===
Animators are special game logic, which define a movement. When an animator is assigned to a object, that object will start movement as defined in the animator. Animators can be either assigned trough object properties panel, or from script.
*'''Position / Rotation animator''' - assigned animator game logic
*'''Movement / Rotation time offset''' - time offset of the animation (seconds)
*'''Platform''' - whnever the object will also move characters standing on it
 
=== Note ===
*Pickable object can be also animated, but they will stop to do when picked up.
 
= Animator game logic =
Animators are special game logic, which define a movement (translation or rotation). When an animator is assigned to a object, that object will perform that movement until the animator is either unassigned or disabled. Animators are either assigned trough object properties panel, or from script.
 
*When animator is unassigned, the object will stop the movement in its current position. If the animator is then assigned again, the movement will reset.
*If object's animator is disabled, the movement will pause, when the animator is enabled again, the animation will resume from current position.  


*[[Ylands Game logic - Animator position|'''Position Animator''']] - defines translation animation
=== Animator types ===
*[[Ylands Game logic - Animator rotation|'''Rotation Animator''']] - defines rotation animation
*[[Ylands:Game logic - Animator position|'''Position Animator''']] - defines translation animation
*[[Ylands:Game logic - Animator rotation|'''Rotation Animator''']] - defines rotation animation


<gallery>
=== Animator events ===
Image:Ylands-Editor-Animator-example1.png
*When animator is active and "spawn events" option is enabled, the animator will generate [[Ylands:Tile - Animator On Cycle End|'''On Animator Cycle End''']] event at the end of each repeat.
</gallery>


===Animator events===
=== Note ===
*When animator is active nad "spawn events" option is enabled, the animator will send [[Ylands Tile - Animator On Cycle End|'''On Animator Cycle End''']] event at the end of each repeat.
*Animators can be tested using "Test animators" button in Playtest sub menu, or by using F7 hot key.


===Note===
=== Note ===
*Each '''object''' can have assigned '''one movement''' (position) animation and '''one rotation''' animation '''at one time'''. When new animation is assigned, the previous one stops and will be overwritten by new one. Only rotation and position animations stack together.
*Each '''object''' can have assigned '''one move''' (position) animation and '''one rotation''' animation '''at one time'''. When new animation is assigned, the previous one stops and will be overwritten by new one. Only rotation and position animations stack together.


=Animation instructions=
= Animation instructions =
Dynamic objects does not have to be animated only using animators, it can be also achieved by using specific instructions found in visual scripting. When such instruction is used on dynamic object, that object will start executing instructed movement immediately.
Objects does not have to be animated only using animators, it can be also achieved by using specific instructions found in visual scripting. When such instruction is used on animation enabled object, that object will start executing instructed movement immediately.


<gallery>
<gallery>
Line 29: Line 44:
</gallery>
</gallery>


===Animation events===
=== Animation events ===
*When an object finishes given instruction, it will send corresponding [[Ylands Tile - On Movement End|'''On Movement End''']] or [[Ylands Tile - On Rotation End|'''On Rotation End''']] event.
*When an object finishes given instruction, it will send corresponding [[Ylands:Tile - On Movement End|'''On Movement End''']] or [[Ylands:Tile - On Rotation End|'''On Rotation End''']] event.


===Note===
=== Note ===
*Animation instruction work only on "dynamic" objects (objects marked as "animated" in properties)
*These instructions work only on "animation enabled" objects (objects marked as "animated" in properties)
*Any object can have only one translation and rotation animation assigned at one time.
*Any object can have only one translation and rotation animation assigned at one time.




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


[[Category: How-to]]
[[Category: Editor: How To]]

Latest revision as of 16:36, 16 November 2022

Overview

Animated objects are objects which can be made to move using visual scripting. Object can be animated when "animated" option is enabled in their properties panel. Eligible objects are - entities, selected game logic and groups. Animation can be then applied onto selected object either by assigning appropriate "animator" game logic or by using corresponding instructions.

  • Objects in a group are automatically "animation enabled" if group their is, so it is not need to set it for each individual object in the group.
  • Children groups of animated group will move with a parent, so they do not need to be "animation enabled". They have to only if you want to animate them independently from their parent.

Properties

  • Position / Rotation animator - assigned animator game logic
  • Movement / Rotation time offset - time offset of the animation (seconds)
  • Platform - whnever the object will also move characters standing on it

Note

  • Pickable object can be also animated, but they will stop to do when picked up.

Animator game logic

Animators are special game logic, which define a movement (translation or rotation). When an animator is assigned to a object, that object will perform that movement until the animator is either unassigned or disabled. Animators are either assigned trough object properties panel, or from script.

  • When animator is unassigned, the object will stop the movement in its current position. If the animator is then assigned again, the movement will reset.
  • If object's animator is disabled, the movement will pause, when the animator is enabled again, the animation will resume from current position.

Animator types

Animator events

  • When animator is active and "spawn events" option is enabled, the animator will generate On Animator Cycle End event at the end of each repeat.

Note

  • Animators can be tested using "Test animators" button in Playtest sub menu, or by using F7 hot key.

Note

  • Each object can have assigned one move (position) animation and one rotation animation at one time. When new animation is assigned, the previous one stops and will be overwritten by new one. Only rotation and position animations stack together.

Animation instructions

Objects does not have to be animated only using animators, it can be also achieved by using specific instructions found in visual scripting. When such instruction is used on animation enabled object, that object will start executing instructed movement immediately.

Animation events

Note

  • These instructions work only on "animation enabled" objects (objects marked as "animated" in properties)
  • Any object can have only one translation and rotation animation assigned at one time.