ActionApi

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #go #android #linux #docker #macos #nodejs #cli #mcp #openai #open-source

(★ 16)

Generalized user interface framework for PocketMine plugins.

ActionApi Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ActionApi

Generalized user interface framework for PocketMine plugins.

## How does this work?
ActionApi introduces the following concepts:

### Action
`Action` is an interface implemented by plugins
to represent something that a user can do.

Each action type implements a new subclass of `Action`.
A new instance of `Action` is created for every execution.
An `Action` subclass holds the arguments required for the action.

### Arg
`Arg` is an argument that the user provides to customize the action.
They can be inferred from the `Hook` (action trigger),
or separately requested from the user.

Implementations provided by `ActionApi`:

Inference from `Hook` may be suppressed as the default value instead of silently selected
by an extra flag from the constructor call in the `Action` implementation.

### Hook
`Hook` is the method that the user used to trigger the initiation of this action.
It stores data related to the trigger.

Implementations provided by `ActionApi`:

- command
- block click
- air click
- entity click
- item selection
- hotbar switch
- action menu (a navigation index for actions defined in config.yml)

### Example `Action` implementation
```php
final class AddWarpAction implements Action {
	private DataProvider $db;

private ?string $name = null;
	private ?Position $pos = null;
	private ?bool $open = null;

public function __construct(DataProvider $db) {
		$this->db = $db;
	}

public function isMissingArg() : bool {
		return $this->name === null || $this->pos === null || $this->open === null;
	}

public function getArguments() : iterable {
		yield StringArg::new("Warp name", $this->name);
		yield PositionArg::new("Warp position", $this->pos);
		yield BoolArg::new("Open to public?", $this->open)->default(true);
	}

public function run(CommandSender $sender) : void {
		$this->db->addWarp($this->name, $this->pos->getX(), $this->pos->getY(), $this->pos->getZ(),
				$this->pos->getWorld()->getFolderName(), $this->open);
		$sender->sendMessage("Warp \"$this->name\" created at $this->pos");
	}
}
```

### Implementing `Arg` and `Hook`
If the existing arguments are not sufficient, other plugins can implement additional `Arg` types.
Plugins that want to trigger actions from other methods can also implement their own `Hook` types.

Each `Arg` supports command line and form UI interface.
However, if an `Arg` additionally infers arguments from a `Hook`,
the logic is implemented under a separate `Inferrer` interface.
Plugins may register an `Inferrer` instance that supports a specific type of `Arg` and a specific type of `Hook`.
An example implementation for inferring `EntityArg` from an `EntityClickHook`:

```php
final class EntityClickItemInferrer implements Inferrer {
	public function infer(Hook $hook) {
		assert($hook instanceof EntityClickHook); // this is true if you registered the inferrer for the correct class
		return $hook->getClickedEntity();
	}
}
```

ActionApi

ActionApi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ActionApi

ActionApi Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README