Action On Key Press (Power Type)

Runs an entity action on the entity that has the power when the chosen Key is pressed.

Type ID: apoli:action_on_key_press (the old ID active_self still works as an alias)

Fields

Field	Type	Default	Description
`entity_action`	Entity Action Type		The action to run on the player.
`entity_action_released`	Entity Action Type	optional	Runs when the key is let go after a press that fired `entity_action`. See Acting on release.
`cooldown`	Integer or Expression	`1`	Ticks the power needs to recharge before it can be triggered again.
`hud_render`	HUD Render	`{"should_render": false}`	How the power's cooldown is shown on the HUD.
`key`	Key	`{"key": "key.apoli.primary_active"}`	The active key the power responds to.

note

cooldown is evaluated when the power fires, against the entity with the power, so "cooldown": "20 - mypack:haste * 2" shortens the recharge as a resource grows. The HUD bar and the max of the apoli:resource condition read the same expression, so both follow the current value.

Acting on release

With entity_action_released, every press that fires entity_action is followed by exactly one release action when the key comes back up. While it runs, the expression variable held_ticks is the number of ticks the key was held, so a charged ability can scale with how long it was charged:

{
    "type": "apoli:action_on_key_press",
    "key": "key.apoli.primary_active",
    "cooldown": 40,
    "entity_action": {
        "type": "apoli:apply_effect",
        "effect": {
            "effect": "minecraft:slowness",
            "duration": 200,
            "amplifier": 2
        }
    },
    "entity_action_released": {
        "type": "apoli:and",
        "actions": [
            {
                "type": "apoli:clear_effect",
                "effect": "minecraft:slowness"
            },
            {
                "type": "apoli:add_velocity",
                "z": "min(held_ticks, 40) / 20",
                "space": "local"
            }
        ]
    }
}

Pressing the key slows the player while they charge. Letting go clears the slowness and launches them forward, further the longer they held the key, up to two seconds.

The release only follows a press that went through. A press blocked by the cooldown, the power's condition or a prevent_key_press has no release.
The power's condition isn't checked again on release, so the release can always undo what the press started. A release doesn't run if the power was removed or suppressed in between.
A "continuous": true key fires entity_action every tick it is held but releases once, and held_ticks counts from the first press.
Opening a screen while holding the key counts as letting go.
A forced press (apoli:force_key_pressed or the /apoli:key press command) releases when its duration runs out, on players and mobs alike. A power activated directly, as apoli:run_stored_power does, releases straight away with held_ticks at 0.

Examples

{
	"type": "apoli:action_on_key_press",
	"entity_action": {
		"type": "apoli:if_else",
		"condition": {
	    	"type": "apoli:on_fire"
    	},
    	"if_action": {
    		"type": "apoli:extinguish"
    	},
    	"else_action": {
    		"type": "apoli:set_on_fire",
    		"duration": 8
    	}
  	},
  	"cooldown": 20,
  	"hud_render": {
    	"should_render": false
  	}
}

When the player presses the primary ability key, this sets them on fire for 8 seconds, or puts the fire out if they are already burning.

{
	"type": "apoli:active_self",
	"entity_action": {
		"type": "apoli:and",
		"actions": [
			{
				"type": "apoli:equipped_item_action",
				"equipment_slot": "mainhand",
				"action": {
					"type": "apoli:consume",
					"amount": 1
				}
			},
			{
				"type": "apoli:apply_effect",
				"effect": {
					"effect": "minecraft:speed",
					"duration": 100,
					"amplifier": 1,
					"is_ambient": true,
					"show_particles": true,
					"show_icon": true
				}
			}
		]
	},
	"cooldown": 1,
	"hud_render": {
		"should_render": false
	},
	"key": {
		"key": "key.use",
		"continuous": true
	},
	"condition": {
		"type": "apoli:equipped_item",
		"equipment_slot": "mainhand",
		"item_condition": {
			"type": "apoli:ingredient",
			"ingredient": {
				"item": "minecraft:sugar"
			}
		}
	}
}

While the player holds sugar in their main hand, holding the key.use keybind eats one sugar and gives them Speed II for 5 seconds.