PSK Update

The PSK (1.1.1) update is live!

It fixes a number of issues found in this thread, www.garagegames.com/community/forums/viewthread/86673 and introduces the ability to add custom Physics and Animation states to your actors.

I have also moved the legacy behaviors to another folder, though they remain there as a reference.

Here is a quick outline of what you need to do to set it up. The Animation Tutorial on TDN will be updated shortly to work nicely with these changes.

Custom Physics State

When you create your actor, you must register a custom state with the pskActor object.

function MyActorClass::onAdd( %this )
{
    // Register My New State
    %this.registerPhysicsState( "MyCustom" );
}

Since the Actor's core is unaware of the state you have created, you will have to manually set the state when it is appropriate.

...
%this.setPhysicsState( "MyCustom" );
...

Now that we can execute the state, we need to create two methods that control state transitions, as well as what the state actually does to our object.

function MyActorClass::executeMyCustomPhysicsState( %this )
{
    // This method is used to tell the FSM which state we should be in
    // based on what you return here. Returning "NULL" or "" will
    // maintain this state.
    
    if ( !%this.Alive )
    {
        return "isDead";
    }
    
    return "NULL";
}

function MyActorClass::updateMyCustomPhysicsState( %this )
{
    // This method is updated every tick.
}

One of the best things about this functionality is that you can override the existing states! If you register any of the following states, then they are yours to modify in script:

- onGround
- inAir
- onLadder
- isDead

Custom Animation State

Very similar to above:

function MyActorClass::onAdd( %this )
{
    // Register My New State
    %this.registerAnimationState( "MyCustom" );
}

...
%this.setAnimationState( "MyCustom" );
...

function MyActorClass::enterMyCustomAnimationState( %this )
{
    // In this function, all you need to do is return the name
    // of the Animation datablock that you would like to transition to
    // and the engine will take care of the rest.
    return MyCustomAnimation;
}

function MyActorClass::executeMyCustomAnimationState( %this )
{
    // This is just like the Physics method, you just specify
    // the animation that you need to move to next, or return ""
    // or "NULL" to maintain this animation state.

    return "NULL";
}

Fin.

That is it folks, a small update which should be of massive benefit to all PSK users.