Demo Scene Examples

v1.0

In this demo scene we work with some custom actions and slightly more advanced methods to accomplish some juicy behaviors.

Note that I am using the Customize Component Names package from Magic Pig Games, available on the Asset Store. It allows for custom names in the Inspector for components. I will use them to better highlight what various components like ActionRunner components will do, especially when there are multiple on a single object.

Custom Predicates

The JuicyActor class, which is custom for this demo, also implements IAmRPGDemo which has various methods that can be used with the Custom Predicate Conditional option.

// IAmRPGActor.cs
public interface IAmRPGActor
{
    public bool IsReady();
    public bool IsActive();
}

The Main Sprite under each of the Player prefabs in the scene has an Action Runner which handles scaling their sprite up and down when they're active. To ensure it only runs when the player is actually active, and when they're in a "isReady" state, we can use the Custom Predicate Conditional.

Now the action will only run when the IsReady and IsActive both return true. The script automatically finds methods using the IAmRPGActor interface.

Set Override Values at Runtime

The Damage Number prefab is instantiated, but then positioned and set up by the JuicyActor who has been hit, as each of them has their own offset value based on Sprite size.

If the attack "Missed", meaning the damage was <= 0, then we want the text to be white, not red. So we set the target color values directly in the code:

// JuicyActor.cs
public void SetDamageNumberPosition(GameObject newDamageNumber, int damage)
{
    var tmpText = newDamageNumber.GetComponent<TMP_Text>();
    if (tmpText != null)
    {
        tmpText.text = damage <= 0 ? "Missed!" : $"-{damage}";
        
        // Determine if we want white or red, and then set that as the target of the first color transition
        var textColor = new List<Color> { damage <= 0 ? Color.white : Color.red };
        newDamageNumber.GetComponent<ActionOnStart>().onStartActions
            .SetFieldOverrideByUID("031cf247-bcf2-49f2-b042-dcbb965a899d", "colors", textColor);
        
        // Set the fade out target color to the same value but with an alpha of 0
        textColor[0] = new Color(textColor[0].r, textColor[0].g, textColor[0].b, 0f);
        newDamageNumber.GetComponent<ActionOnStart>().onStartActions
            .SetFieldOverrideByUID("d7206ca9-c492-45c8-b3a8-ee3149a05e17", "colors", textColor);
    }

    var rectTransform = newDamageNumber.GetComponent<RectTransform>();
    if (rectTransform != null)
        rectTransform.position = transform.position + damageNumberOffset;
}

Since the ActionExecutor has two TMPTextColorAction actions, we need to specify which one to target using the UID assigned to each, which I've copied from the Inspector into my code. One targets the color to full alpha, the other targets the color with alpha at 0.

Utilizing CanExecute()

The three buttons, Next Player, Player Attack, and Enemy Attack, disable when they are not able to do anything. For the two attack buttons, this utilizes properties on RGPGameManager.cs and ToggleButtonForEnemy.cs / ToggleButtonForPlayer.cs.

// RPGGameManager.cs
public bool EnemyCanAttack => enemy.attackActions.ActionExecutor.CanExecute;
public bool PlayerCanAttack => players.All(x => x.attackActions.ActionExecutor.CanExecute) 
                               && players.All(x => x.onSelectedActions.ActionExecutor.CanExecute)
                               && players.All(x => x.onDeselectedActions.ActionExecutor.CanExecute);

In this code, the EnemyCanAttack just checks to make sure the attackActions can execute.

For the PlayerCanAttack, we check the attackActions as well as the onSelectedActions and onDeselectedActions, which move the players forward and back when they are activated.

Action Executor Setup

It is important to remember that the value of CanExecute() is determined by the cooldown and restart settings of the ActionExecutor itself, and does not have to relate to the actual actions being executed.

Here we have Can Restart set true, and the cooldown is Determined by Duration. This means that CanExecute() will return true only when the duration (0.5) has elapsed. This matches the actual ActionExecutor logic, and is a helpful way to know if Execute() will even result in a successful execution.