ZenMembers and ZenProperties
Link to zenmembers-and-zenproperties
ZenMembers are a ZenObject's members.
They can be accesses using object.member
. Members can be settable, gettable or both.
Getters and Setters
Link to getters-and-setters
There are two Types of ZenGetters: ZenGetters and ZenMemberGetters.
So what's the difference?
Normally you use @ZenGetter(value)
, unless you have something which has either many members that return the same type or if you don't know the exact members yourself.
In that case you can use @ZenMemberGetter
.
So what's the difference?
- A Method annotated with a
@ZenGetter(value)
does not need any parameters, while a Method annotated with@ZenMemberGetter
needs a String argument that is the member's name. - MemberGetters are only executed if no other getter is found.
- If you only need one small Property, you should use
@ZenGetter(value)
The same applies for ZenSetters/ZenMemberSetters.
ZenProperty
Link to zenproperty
The @ZenProperty
combines both, @ZenGetter(value)
and @ZenSetter
in one annotation.
This annotation can only be applied to public fields (e.g. public String name
).
This Annotation can have these arguments:
String value
: the property name (in ZS you call object.value). If omitted, the field name is used.String getter
: the name of the corresponding Getter Method (which may not have a ZenGetter Annotation).- If not set or
""
, it will use useget + value
if the annotated field is not a booleanis + value
if annotated field is boolean or Boolean
- if
null
, it will not register a ZenSetter
- If not set or
String setter
: the name of the corresponding Setter Method (which may not have a ZenSetter Annotation).- If not set or
""
, it will useset + value
- If
null
, it will not register a ZenSetter
- If not set or
You can even omit the getter/setter method alltogether if you use @ZenProperty
.
If you do use those methods, however, you will need to add @ZenMethod
should you want this functionality, if you omit the methods, they will be generated automatically.
Examples
Link to examples
ZenGetters Example
Link to zengetters-example
Copy@ZenClass("crafttweaker.oredict.IOreDict")
@IterableSimple("crafttweaker.oredict.IOreDictEntry")
@ZenRegister
public interface IOreDict extends Iterable<IOreDictEntry> {
@ZenMemberGetter
@ZenOperator(OperatorType.INDEXGET)
@ZenMethod
IOreDictEntry get(String name);
@ZenGetter("entries")
List<IOreDictEntry> getEntries();
@ZenOperator(OperatorType.CONTAINS)
@ZenMethod
boolean contains(String name);
}
ZenProperties Example
Link to zenproperties-example
ContentTweaker's MCAxisAlignedBB
Copy@ZenRegister
@ZenClass("mods.contenttweaker.AxisAlignedBB")
public class MCAxisAlignedBB implements ICTObject<AxisAlignedBB> {
@ZenProperty
public double minX = 0.0;
...
@ZenMethod
public double getMinX() {
return minX;
}
@ZenMethod
public void setMinX(double minX) {
this.minX = minX;
}
...
}