Orx Learning

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Animation Targets, and Clearing Targets ======

Clearing a target can be very handy on objects with very simple behaviours. I recently had a requirement where an object would perform an animation every time another object collided with it. 

As per other tutorials, my code called //orxObject_SetTargetAnim// and away it animated. However, because the object was not under any kind of input control, there was no opportunity to clear the target, and therefore, the object animated over and over.

This is where the //cleartarget// symbol becomes useful.

Let's work through an example to see how it works.

See below the following spritesheet of a spring loaded bumper.

{{tutorials:animation:bumper.png|}}

The job of this bumper is to spring up and knock away any objects that collide with it. After it has sprung up, it needs to compress down again and stay compressed until the next collision.

First, make the object, graphics, and animations (body collision information left out):

<code ini>
[BumperObject]
Graphic	     = BumperGraphic ; Only used to supply a default size for all frames. If not supplied, the first animation frame will supply the size.
AnimationSet = BumperAnimationSetAll
Position     = (100, 100, -0.1)

[BumperGraphic]
Texture     = bumper.png
Pivot       = top left
TextureSize = (114, 117, 0)

[BumperAnimationSetAll]
Texture                = bumper.png
TextureOrigin          = (0,0,0)
FrameSize              = (114, 117, 0)
KeyDuration            = 0.05
BumperCompressAnim     = 20
BumperCompressedAnim   = 1
BumperSpringUpAnim     = 20
StartAnim              = BumperCompressedAnim
BumperCompressedAnim-> = BumperCompressedAnim # BumperSpringUpAnim
BumperSpringUpAnim->   = BumperCompressAnim
BumperCompressAnim->   = BumperCompressedAnim

[BumperCompressedAnim]
TextureOrigin = (456, 351, 0)

[BumperSpringUpAnim]
Direction   = left # up
</code>

So that completes the animation setup. 

In code, the bumper is defined at the top of the code:

<code c>
orxOBJECT *bumperObject;
</code>

and created in the Init() function with:

<code c>
bumperObject = orxObject_CreateFromConfig("BumperObject");
</code>

We'll use a key to set the animation target, but provide no way to clear the animation target in code. Create this following key map:

<code ini>
[MainInput]
KEY_ESCAPE = Quit
KEY_SPACE  = Activate
</code>

Add the following to the Run() function to start the animation target:

<code c>
  if (orxInput_IsActive("Activate") == orxTRUE && orxInput_HasNewStatus("Activate") == orxTRUE)
  {
	  orxObject_SetTargetAnim(bumperObject, "BumperSpringUpAnim");
  }
</code>

Compile and Run.

The bumper target is being set as default to //BumperSpringUpAnim// which means that the animation graph system will always seek it constantly. //BumperSpringUpAnim// will always remain the target, and therefore be sought, until found again, or otherwise cleared.

In code, if the object was under keyboard control, you could issue the following on keyup to clear a target from an object:

<code c>
orxObject_SetTargetAnim(bumperObject, orxNULL);
</code>

But our object is not cleared from code. We want it to clear after our target animation has completed.

Note that when the object is first initialised, "BumperCompressedAnim" is the animation that will play. This is because it is specified in the ''StartAnim'' property.

So in the present state, setting the target to "BumperSpringUpAnim", the animation graph will take the object through the following chain of animations trying to get to "BumperSpringUpAnim":

  - BumperCompressedAnim
  - BumperSpringUpAnim
  - BumperCompressAnim
  - BumperCompressedAnim
  - BumperSpringUpAnim
  - BumperCompressAnim
  - BumperCompressedAnim
  - BumperSpringUpAnim
  - BumperCompressAnim
  - etc etc etc..

See how it is caught in a loop?

The secret is to change the list of animations linked to ''BumperCompressedAnim'' by adding the cleartarget marker. By changing this line:

<code ini>
BumperCompressedAnim-> = BumperCompressedAnim # BumperSpringUpAnim
</code>

<code ini>
BumperCompressedAnim-> = BumperCompressedAnim # !BumperSpringUpAnim
</code>

Notice the ''!'' symbol? In short, this means, once the ''BumperSpringUpAnim'' plays, clear the target.

That little ''!'' is the whole the point to this article.

The object will no longer have a target, and //BumperCompressedAnim// will be the last animation to play.

That is until the object is given the animation target of ''BumperSpringUpAnim'' again.

This is a very handy symbol for objects that animate through once.
Orx Learning

User Tools

Site Tools

Page Tools
