Documentation

Support

Asset Transformer SDK


User Manual

Python API

C# API

Changelog

Discussions

Asset Transformer SDK


Core

Python API types
Read time 33 minutesLast updated a month ago

AliasTypeDesc

Fields

Type

Name

Default

Description

aliasString

ArrayTypeDesc

Fields

Type

Name

Default

Description

arrayTypeString
sizeInt0

AutoValueReturn

Auto value function return. Fields

Type

Name

Default

Description

valuesStringPairList[]
messageString

Bool

Derived class: Boolean
Functions accepting this type or a list of this type as a parameter:

BoolList

List of core.Bool

Boolean

Base class: core.Bool Derived class: Orientation
Functions accepting this type or a list of this type as a parameter:

BoundedInteger

Fields

Type

Name

Default

Description

valueInt0
minInt0
maxInt0

Byte

Functions accepting this type or a list of this type as a parameter:

ByteList

List of core.Byte Functions accepting this type or a list of this type as a parameter:

CaptchaCallback

Functions accepting this type or a list of this type as a parameter:

Coeff

Base class: core.Double
Functions accepting this type or a list of this type as a parameter:

Color

A Color defines a color RGB. Fields

Type

Name

Default

Description

rDouble1
gDouble1
bDouble1
Functions accepting this type or a list of this type as a parameter:

ColorAlpha

A Color defines a color RGBA. Fields

Type

Name

Default

Description

rDouble1
gDouble1
bDouble1
aDouble1
Functions accepting this type or a list of this type as a parameter:

ColorAlphaList

List of core.ColorAlpha Functions accepting this type or a list of this type as a parameter:

ColorAlphaListList

List of core.ColorAlphaList Functions accepting this type or a list of this type as a parameter:

ColorList

List of core.Color

ConstantDesc

Fields

Type

Name

Default

Description

nameString
valueString
typeTypeDesc
descriptionString

ConstantDescList

List of core.ConstantDesc

Date

Fields

Type

Name

Default

Description

yearInt2015
monthInt1
dayInt1

DirectoryPath

Base class: core.String Derived class: OutputDirectoryPath
Functions accepting this type or a list of this type as a parameter:

Double

Derived classes:
Functions accepting this type or a list of this type as a parameter:

DoubleList

List of core.Double Functions accepting this type or a list of this type as a parameter:

DoubleListList

List of core.DoubleList

Entity

An entity is the Pixyz base object. All objects manipulated in Pixyz are derived from Entity. Base class: core.Ident Derived classes:
Functions accepting this type or a list of this type as a parameter:

EntityList

List of core.Entity Functions accepting this type or a list of this type as a parameter:

EntityListList

List of core.EntityList

EntityType

Base class: core.UInt
Functions accepting this type or a list of this type as a parameter:

EnumPropertyInfo

Fields

Type

Name

Default

Description

nameString
valuesIntList
labelsStringList

EnumTypeDesc

Fields

Type

Name

Default

Description

valuesIntList
labelsStringList
valueTypeString

EventDesc

Fields

Type

Name

Default

Description

moduleString
nameString
descriptionString
parametersParameterDescList

EventDescList

List of core.EventDesc

Field

Fields

Type

Name

Default

Description

nameString
typeString
moduleString
defaultValueString
descriptionString
disableValueString
predefinedValuesStringPairList

FieldList

List of core.Field

FilePath

Base class: core.String Derived classes:
Functions accepting this type or a list of this type as a parameter:

FilePathList

List of core.FilePath Functions accepting this type or a list of this type as a parameter:

Format

Fields

Type

Name

Default

Description

nameString
extensionsStringList

FormatList

List of core.Format

FunctionDesc

Fields

Type

Name

Default

Description

nameString
moduleString
parametersParameterDescList
returnsParameterDescList
descriptionString
stabilityStabilitySTABLE

FunctionDescList

List of core.FunctionDesc

GroupDesc

Fields

Type

Name

Default

Description

nameString
descriptionString
functionsFunctionDescList

GroupDescList

List of core.GroupDesc

Ident

Derived classes:
Functions accepting this type or a list of this type as a parameter:

IdentPair

Fields

Type

Name

Default

Description

keyIdent0
valueIdent0

IdentPairList

List of core.IdentPair

InheritableBool

Enum

Name

Value

False0
True1
Inherited2

InheritableBoolList

List of core.InheritableBool

Int

Derived classes:
Functions accepting this type or a list of this type as a parameter:

IntList

List of core.Int Functions accepting this type or a list of this type as a parameter:

IntListList

List of core.IntList

LicenseInfos

Fields

Type

Name

Default

Description

versionString
customerNameString
customerCompanyString
customerEmailString
isFloatingBooleanFalse
isRevocableBooleanFalse
startDateDate
endDateDate
invalidReasonsStringList

ListTypeDesc

Fields

Type

Name

Default

Description

listTypeString

Long


ModuleDesc

Fields

Type

Name

Default

Description

nameString
descriptionString
authorString
groupsGroupDescList
typesTypeDescList
constantsConstantDescList
dependenciesStringList
stabilityStabilitySTABLE

ModuleDescList

List of core.ModuleDesc

None


OutputDirectoryPath

Base class: core.DirectoryPath
Functions accepting this type or a list of this type as a parameter:

OutputFilePath

Base class: core.FilePath Derived class: ExportFilePath
Functions accepting this type or a list of this type as a parameter:

ParallelCallback

Functions accepting this type or a list of this type as a parameter:

ParallelSession

Base class: core.Ptr
Functions accepting this type or a list of this type as a parameter:

ParameterDesc

Fields

Type

Name

Default

Description

nameString
typeTypeDesc
descriptionString
optionalBoolFalse
defaultValueString
disableValueString
attributesStringPairList
predefinedValuesStringPairList

ParameterDescList

List of core.ParameterDesc

Password

Base class: core.String
Functions accepting this type or a list of this type as a parameter:

Percent

Base class: core.Double
Functions accepting this type or a list of this type as a parameter:

PropertyInfo

Fields

Type

Name

Default

Description

nameString
typePropertyTypeUNKNOWN
subTypeInt0The sub type in only filled when type is 'ENTITY' or 'ENUM'.
valueString
userBooleanFalse
defaultValueString
editableBooleanTrue
isSetBooleanFalse
delegatedBooleanFalse
delegatedOwnerEntityEntityFalse
groupString
descriptionString

PropertyInfoList

List of core.PropertyInfo

PropertyInfoListList

List of core.PropertyInfoList

PropertyType

Enumeration of all property types. Enum of core.Long

Name

Value

STRING0
STRINGLIST1
INTEGER2
BOUNDED_INTEGER3
UNSIGNED_INTEGER4
SHORT5
UNSIGNED_SHORT6
IDENTIFIER7
IDENTIFIERLIST8
BOOLEAN9
INHERITABLEBOOL10
REAL11
REALLIST12
COEFF13
PERCENT14
COLOR15
COLOR_ALPHA16
DATE17
ANGLE18
DISTANCE19
MACHINEID20
MACHINEIDLIST21
SOCKET_PROTOCOL22
POINT223
POINT324
AXIS325
VECTOR326
POINT3LIST27
POINT428
POINT4LIST29
MATRIX430
QUATERNION31
BOUNDS1D32
BOUNDS2D33
TEXTUREDEF34
COLORORTEXTURE35
COEFFORTEXTURE36
ENTITY37
FILEPATH38
AABB39
ENUM40
UNKNOWN41
Functions accepting this type or a list of this type as a parameter:

PropertyTypeList

List of core.PropertyType Functions accepting this type or a list of this type as a parameter:

Ptr

Derived classes:
Functions accepting this type or a list of this type as a parameter:

PtrList

List of core.Ptr Functions accepting this type or a list of this type as a parameter:

Real

Base class: core.Double
Functions accepting this type or a list of this type as a parameter:

Regex

Regular expression using the ECMAScript syntax. Base class: core.String
Functions accepting this type or a list of this type as a parameter:

SelType

Fields

Type

Name

Default

Description

nameString
typeString
defaultValueString
descriptionString

SelTypeList

List of core.SelType

SelectTypeDesc

Fields

Type

Name

Default

Description

typesSelTypeList

Short


Stability

Describes the level of maturity of a module/function. Enum of core.Long

Name

Value

DEVELOPMENT0
EXPERIMENTAL1
BETA2
STABLE3
DEPRECATED4
OBSOLETE5

String

Derived classes:
Functions accepting this type or a list of this type as a parameter:

StringList

List of core.String Functions accepting this type or a list of this type as a parameter:

StringPair

Fields

Type

Name

Default

Description

keyString
valueString

StringPairList

List of core.StringPair

StringPairListList

List of core.StringPairList

StructTypeDesc

Fields

Type

Name

Default

Description

fieldsFieldList

TypeDesc

Fields

Type

Name

Default

Description

nameString
moduleString
typeTypeDescTypeUNKNOWN
descriptionString
definitionTypeDescDef

TypeDescDef

Select between:

TypeDescList

List of core.TypeDesc

TypeDescType

Enum of core.Long

Name

Value

UNKNOWN0
BASE1
ALIAS2
ENUM3
LIST4
STRUCT5
ARRAY6
SELECT7
FUNCPTR8

UInt

Derived classes:
Functions accepting this type or a list of this type as a parameter:

ULong

Derived class: AnimationTime
Functions accepting this type or a list of this type as a parameter:

ULongList

List of core.ULong Functions accepting this type or a list of this type as a parameter:

UShort

Functions accepting this type or a list of this type as a parameter:

Verbose

The verbose level defines the amount of information shown in outputs. Enum of core.Long

Name

Value

ERR0
WARNING1
INFO2
SCRIPT5
Functions accepting this type or a list of this type as a parameter:

WebLicenseInfo

Fields

Type

Name

Default

Description

idIdent0
productString
validityDate
countInt0
inUseInt0
revokeInt-1
descriptionString
onMachineBoolFalse
currentBoolFalse

WebLicenseInfoList

List of core.WebLicenseInfo

Core • Asset Transformer SDK • Unity Docs