Extensions.DataType.CreateResourceLocation

From emotive
Jump to navigation Jump to search

Classification

Name CreateResourceLocation
Short Description Creates a ResourceLocation out of a given ID and default location
Class Term
Extension OTX DataType extension
Group DataType related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

ResourceLocationTerm DataType.CreateResourceLocation(StringTerm id, StringTerm defaultLocation);

Description

This term creates creates a ResourceLocation out of a given ID and default location.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
ResourceLocation Returns the ResourceLocation out of a given ID and default location.

Properties

Name Data Type Class Default Cardinality Description
Id String Term - [1..1] Represents the resource ID value. At runtime the ID will be used to map the ResourceLocation to a certain path
DefaultLocation String Term - [0..1] Represents the optional default location. This value will be used, if the related resource ID cannot be mapped.

OTL Examples

/// Local Declarations

DataType.ResourceLocation ResourceLocation1;

/// Flow

ResourceLocation1 = DataType.CreateResourceLocation("OtfMapping");

See also

EnumerationContainsName
EnumerationContainsValue
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
CreateResourceLocation
GetResourceLocationId
IsResourceLocationMapped
StructureCopy
StructureCreate