Attribute
Link to attribute
Importing the class
Link to importing-the-class
It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
ZenScript Copyimport crafttweaker.api.entity.attribute.Attribute;
Casters
Link to casters
Result Type | Is Implicit |
---|---|
Result Type string | Is Implicit false |
Methods
Link to methods
Name: getCommandString
Gets the attribute bracket handler syntax for this Attribute.
E.G. <attribute:minecraft:generic.max_health>
Returns: The attribute bracket handler syntax for this Block.
Return Type: string
ZenScript Copy// Attribute.getCommandString() as string
myAttribute.getCommandString();
Name: getDefaultValue
Gets the default value for this Attribute.
Returns: The default value for this Attribute.
Return Type: double
ZenScript Copy// Attribute.getDefaultValue() as double
myAttribute.getDefaultValue();
Name: getRegistryName
Return Type: ResourceLocation
ZenScript Copy// Attribute.getRegistryName() as ResourceLocation
myAttribute.getRegistryName();
Name: isClientSyncable
Should this attribute be synced to the client.
Returns: True if synced. False otherwise.
Return Type: boolean
ZenScript Copy// Attribute.isClientSyncable() as boolean
myAttribute.isClientSyncable();
Name: sanitizeValue
Sanitizes the given value for this Attribute.
Returns: The sanitized value.
Return Type: double
ZenScript Copy// Attribute.sanitizeValue(value as double) as double
myAttribute.sanitizeValue(4);
Parameter | Type | Description |
---|---|---|
Parameter value | Type double | Description The given value to sanitized. |
Properties
Link to properties
Name | Type | Has Getter | Has Setter | Description |
---|---|---|---|---|
Name clientSyncable | Type boolean | Has Getter true | Has Setter false | Description Should this attribute be synced to the client. |
Name commandString | Type string | Has Getter true | Has Setter false | Description Gets the attribute bracket handler syntax for this Attribute. E.G. <attribute:minecraft:generic.max_health> |
Name defaultValue | Type double | Has Getter true | Has Setter false | Description Gets the default value for this Attribute. |
Name registryName | Type ResourceLocation | Has Getter true | Has Setter false | Description |