appeng.api.networking.security

Interface IActionSource

public interface IActionSource

The source of any action. This can either be a EntityPlayer or an IActionHost. In most cases this is used for security checks, but can be used to validate the source itself.

Method Summary

Modifier and Type	Method and Description
<T> java.util.Optional<T>	context(java.lang.Class<T> key) An IActionSource can have multiple optional contexts.
java.util.Optional<IActionHost>	machine() If present, it indicates the IActionHost of the source.
java.util.Optional<net.minecraft.entity.player.EntityPlayer>	player() If present, AE will consider the player being the source for the action.

Method Detail

player

@Nonnull
java.util.Optional<net.minecraft.entity.player.EntityPlayer> player()

If present, AE will consider the player being the source for the action. This will take precedence over machine() in any case.

Returns:

An optional player issuing the action.

machine

@Nonnull
java.util.Optional<IActionHost> machine()

If present, it indicates the IActionHost of the source. Should player() be absent, it will consider a machine as source. It is recommended to include the machine even when a player is present.

Returns:

An optional machine issuing the action or acting as proxy for a player.

context

@Nonnull
<T> java.util.Optional<T> context(@Nonnull
                                            java.lang.Class<T> key)

An IActionSource can have multiple optional contexts. It is strongly recommended to limit the uses for absolutely necessary cases. Currently there are no public contexts made available by AE. An example would be the context interfaces use internally to avoid looping items between each other.