Package ch.njol.skript.expressions

Class ExprHash

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<T>

ch.njol.skript.expressions.base.PropertyExpression<String,String>

ch.njol.skript.expressions.ExprHash

All Implemented Interfaces:

Debuggable, Expression<String>, SyntaxElement

@Name("Hash")
@Description({"Hashes the given text using the MD5 or SHA-256 algorithms. Each algorithm is suitable for different use cases.<p>","MD5 is provided mostly for backwards compatibility, as it is outdated and not secure. ","SHA-256 is more secure, and can used to hash somewhat confidental data like IP addresses and even passwords. ","It is not <i>that</i> secure out of the box, so please consider using salt when dealing with passwords! ","When hashing data, you <strong>must</strong> specify algorithms that will be used for security reasons! ","<p>Please note that a hash cannot be reversed under normal circumstanses. You will not be able to get original value from a hash with Skript."})
@Examples({"command /setpass &lt;text&gt;:","\ttrigger:","\t\tset {password::%uuid of player%} to text-argument hashed with SHA-256","command /login &lt;text&gt;:","\ttrigger:","\t\tif text-argument hashed with SHA-256 is {password::%uuid of player%}:","\t\t\tmessage \"Login successful.\"","\t\telse:","\t\t\tmessage \"Wrong password!\""})
@Since("2.0, 2.2-dev32 (SHA-256 algorithm)")
public class ExprHash
extends PropertyExpression<String,String>

Constructor Summary

Constructors

Constructor	Description
ExprHash()

Method Summary

Modifier and Type	Method	Description
protected String[]	get(org.bukkit.event.Event e, String[] source)	Converts the given source object(s) to the correct type.
Class<? extends String>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)

Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression

get, get, getAll, getAnd, getExpr, isSingle, register, setExpr, simplify

Methods inherited from class ch.njol.skript.lang.util.SimpleExpression

acceptChange, change, check, check, check, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.njol.skript.lang.Expression

beforeChange, stream

Methods inherited from interface ch.njol.skript.lang.SyntaxElement

getParser

Constructor Details

ExprHash

public ExprHash()

Method Details

init

public boolean init(Expression<?>[] exprs,
 int matchedPattern,
 Kleenean isDelayed,
 SkriptParser.ParseResult parseResult)

Description copied from interface: SyntaxElement

Called just after the constructor.

Parameters:

exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list holding the default value of the desired type which usually depends on the event.

matchedPattern - The index of the pattern which matched

isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)

parseResult - Additional information about the match.

Returns:

Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.

See Also:

ParserInstance.isCurrentEvent(Class...)

get

protected String[] get(org.bukkit.event.Event e,
 String[] source)

Description copied from class: PropertyExpression

Converts the given source object(s) to the correct type.

Please note that the returned array must neither be null nor contain any null elements!

Specified by:

get in class PropertyExpression<String,String>

Returns:

An array of the converted objects, which may contain less elements than the source array, but must not be null.

See Also:

Converters.convert(Object[], Class, Converter)

toString

public String toString(@Nullable org.bukkit.event.Event e,
 boolean debug)

Parameters:

e - The event to get information to. This is always null if debug == false.

debug - If true this should print more information, if false this should print what is shown to the end user

Returns:

String representation of this object

getReturnType

public Class<? extends String> getReturnType()

Description copied from interface: Expression

Gets the return type of this expression.

Returns:

A supertype of any objects returned by Expression.getSingle(Event) and the component type of any arrays returned by Expression.getArray(Event)