Special Parameter Types

Some API function parameters accept only certain values that are passed as arguments. These special parameter types are listed and described on this page.

Overview

Name	Value type	Description
Anchor	integer	Fix point for resizing
Axis2D	integer	2D space axes
Axis3D	integer	3D space axes
BackgroundMode	integer	Viewport background mode
Category	integer	File category
Color	integer	Color value
CubeRotation	integer	Voxel cube rotation
CoyrightStatus	integer	File copyright status
Direction2D	integer	Direction in 2D space
Direction3D	integer	Direction in 3D space
EasingFunction	integer	Keyframe easing function
EditMethod	integer	Method for editing voxel and pixel grids
FileID	string	File identifier
FileProperty	string	File property identifier
FileType	integer	File type
FoxelPixel	integer	Pixel value
FoxelVoxel	integer	Voxel value
HeightMode	integer	Pixel height mode
InterpolationMode	integer	Animation channel interpolation mode
ItemIndex	integer	Index of an item of a Color Palette, Material Set or Mini Set
Layer	integer	Node Layer ID
LOD	integer	Level of detail
NodeID	string	Node identifier
NodeProperty	string	Node property identifier
NodeType	integer	Node type
ProjectID	string	Project identifier
ProjectProperty	string	Project property identifier
RectAlign	integer	Align within a rectangular area
SkyMode	integer	Mode of the sky
TextureFilter	integer	GPU texture filtering
ToneMapping	integer	Tonemapping algorithm
VoxelShape	integer	Voxel shape

Anchor

Anchor is used to specify a fix point for resizing objects.

Value	Description
-1	Minimum
0	Center
1	Maximum

Axis2D

Axis2D is used to specify an axis in 2D space.

Value	Description
0	X-axis
1	Y-axis

Axis3D

Axis3D is used to specify an axis in 3D space.

Value	Description
0	X-axis
1	Y-axis
2	Z-axis

BackgroundMode

BackgroundMode is used to specify what is rendered as the viewport background.

Value	Description
0	Solid color
1	Environment map
2	Sky

Category

Category is used to specify the category of an Asset, Prefab, or Prefab Package file.

Value	Category
0	No category
16	Aircraft/Airplane
17	Aircraft/Helicopter
32	Animal/Bird
33	Animal/Fish
34	Animal/Insect
35	Animal/Mammal
36	Animal/Reptile
48	Car/Luxury
49	Car/Sport
50	Car/Standard
51	Car/SUV
64	Character/Boy
65	Character/Clothing
66	Character/Girl
67	Character/Human
68	Character/Man
69	Character/Sci-fi
70	Character/Woman
80	Electronics/Audio
81	Electronics/Communication
82	Electronics/Computer
83	Electronics/Video
96	Exterior/Cityscape
97	Exterior/Commercial
98	Exterior/House
99	Exterior/Industrial
100	Exterior/Landmark
101	Exterior/Landscape
102	Exterior/Skyscraper
103	Exterior/Street
112	Food/Beverage
113	Food/Fruit
114	Food/Vegetable
128	Furniture/Bed
129	Furniture/Chair
130	Furniture/Desk
131	Furniture/Sofa
132	Furniture/Storage
133	Furniture/Table
144	Industrial/Machine
145	Industrial/Tool
160	Interior/Bathroom
161	Interior/Bedroom
162	Interior/Hall
163	Interior/Lighting
164	Interior/Living Room
165	Interior/Kitchen
166	Interior/Office
176	Military/Armor
177	Military/Gun
178	Military/Melee
179	Military/Vehicle
192	Plant/Flower
193	Plant/Tree
208	Space/Planet
209	Space/Spacecraft
210	Space/Space Station
224	Vehicle/Bicycle
225	Vehicle/Bus
226	Vehicle/Motorcycle
227	Vehicle/Train
228	Vehicle/Truck
240	Watercraft/Boat
241	Watercraft/Ship

Color

Colors in Foxel are encoded as 32-bit integers. Alpha values are not stored within a color. Foxel uses materials to allow voxel transparency. Use FxColor to create and edit colors.

CoyrightStatus

CoyrightStatus is used to specify the copyright status of an Asset, Prefab, or Prefab Package file.

Value	Description
0	Unknown status
1	Copyrighted
2	Public Domain

CubeRotation

CubeRotation is used to specify one of 24 possible cube rotations. It is used in conjunction with VoxelShape to specify how a voxel is rendered in the viewport. Valid values range from [1..24]. Due to the way a FoxelVoxels is encoded, 0 is not a valid value.

Direction2D

Direction2D is used to specify a direction in 2D space.

Value	Description
0	X- or Left
1	X+ or Right
2	Y- or Down
3	Y+ or Up

Direction3D

Direction2D is used to specify a direction in 3D space.

Value	Description
0	X- or Right
1	X+ or Left
2	Y- or Down
3	Y+ or Up
4	Z- or Back
5	Z+ or Front

EasingFunction

EasingFunction is used to specify an easing function used to animate a keyframe of an animation channel. Easing functions specify the rate of change of a parameter over time. For a visual reference of these functions, see https://easings.net/.

Value	Description
0	Linear
10	InSine
11	InQuad
12	InCubic
13	InQuart
14	InQuint
15	InExpo
16	InCirc
17	InBack
18	InBounce
19	InElastic
20	OutSine
21	OutQuad
22	OutCubic
23	OutQuart
24	OutQuint
25	OutExpo
26	OutCirc
27	OutBack
28	OutBounce
29	OutElastic
30	InOutSine
31	InOutQuad
32	InOutCubic
33	InOutQuart
34	InOutQuint
35	InOutExpo
36	InOutCirc
37	InOutBack
38	InOutBounce
39	InOutElastic
40	OutInSine
41	OutInQuad
42	OutInCubic
43	OutInQuart
44	OutInQuint
45	OutInExpo
46	OutInCirc
47	OutInBack
48	OutInBounce
49	OutInElastic

EditMethod

Value	Description
0	Erase / delete solid pixel/voxel
1	Draw / add pixel/voxel
2	Paint / set color of solid pixel/voxel
3	Coat / set material of solid pixel/voxel
11	Select / start new selection of solid pixel/voxel
12	Select + / add solid pixel/voxel to previous selection
13	Select - / remove of solid pixel/voxel from previous selection
21	Set shape of solid voxel
22	Auto bevel solid voxel
31	Lower height of solid pixel
32	Set height of solid pixel
33	Raise height of solid pixel

FileID

A FileID identifies one or more managed files of a given type.

A Single FileID is a string identifying a single managed file of a given FileType. All IDs are unique within a FileType, i.e. there can be a texture and a cubemap with ID file1, but there can't be two textures with the ID file1. FileIDs are not case-sensitive, i.e. file1 is the same as FILE1.

A FileID List is a single string containing multiple comma-separated FileIDs enclosed in a pair of angle brackets. For example <file1,file2,file3>. A FileID list must not contain a wildcard or a filter.

A FileID Filter is a string that starts with an asterisk and is followed by a search string. All files of a given type that have the search string as a substring are identified. For example for the files redbus, bluebus, redcar the filter *bus will identify redbus and bluebus.

A Wilcard is string that automatically identifies files based on the current context.

Wildcard	Description
*	All files of the given type.
/a	The active (or open) file of the given type.
/s	All selected files of the given type.

FileProperty

To get or set properties of files, a FileProperty string is required. Examples of properties are filename or selected. To find out which file type supports which properties, see the File Reference.

FileType

A FileType is required for most file-related functions. Use 111 to refer to an asset of any type.

Value	File type
111	Any Asset
112	Voxel Scene
113	Voxel Movie
114	Mesh Asset
115	Heightmap
222	Cubemap
223	Texture
224	LUT
332	Material Set
333	Color Palette
334	Mini Set
444	Prefab
445	Prefab Package
555	Script
556	Render Effects Profile
557	Environmental Settings Profile
558	Import Profile
559	Export Profile

FoxelPixel

A FoxelPixel is an encoded 32-bit integer value. It stores the Color ItemIndex and Material ItemIndex as well as the height value and the selection state. Use FxPixel to create FoxelPixels and to edit their properties.

FoxelVoxel

A FoxelVoxel is an encoded 32-bit integer value. It stores the Color ItemIndex and Material ItemIndex as well as the Shape and Rotation value and the selection state. Use FxVoxel to create FoxelVoxels and to edit their properties.

HeightMode

The HeightMode is a property of a PixelObject node that determines how the height values of its pixels are used in relation to the pixels of layers below the node.

Value	Mode
0	Overwrite
1	Keep
2	Add
3	Subtract

InterpolationMode

The Interpolation mode determines how values are interpolated between keyframes in an animation channel.

Value	Mode
0	Step
1	Linear
2	Spline
3	Ease

ItemIndex

An ItemIndex refers to an item of a file of the type Color Palette, Material Set, or Mini Set. 0 refers to the first item. Color Palettes and Mini Sets store 256 items, so the last valid index is 255. Material Sets only store 128 items, so the last valid index is 127.

Layer

Layer is the ID of the layer on which an object is located. Layers are used to easily select and show/hide objects. Valid values range from 0 to 15. Layer0 is the default layer on which all new objects are placed.

LOD

Voxel grids support four levels of detail, or LOD.

Value	Description
0	LOD0 or highest level of detail.
1	LOD1
2	LOD2
3	LOD3 or lowest level of detail.

NodeID

A NodeID identifies one or more nodes.

A single NodeID is a string that identifies a single node in the opened asset. All NodeIDs are unique within an asset, i.e. an asset can't have two nodes with the ID node1. NodeIDs are not case-sensitive, so node1 is the same as NODE1.

A NodeID list is a single string that contains multiple comma-separated NodeIDs enclosed by a pair of angle brackets. For example <node1,node2,node3>. NodeID lists may not contain wildcards or filters.

A NodeID filter is a string that starts with an asterisk and is followed by a search string. All nodes that have the search string as a substring in their ID are identified. For example for the nodes redbus, bluebus, redcar the filter *bus will identify redbus and bluebus.

A NodeID wildcard is a string that automatically identifies nodes based on the current context.

Wildcard	Description
*	All nodes.
/a	The active node.
/b	All siblings of the active node.
/B	All siblings of the active node plus the active node.
/c	All ancestors of the active node.
/C	All ancestors of the active node plus the active node.
/d	All descendants of the active node.
/D	All descendants of the active node plus the active node.
/s	All selected nodes.
/S	All selected nodes plus their descendants.
/L0 .. L15	All nodes on Layer0 .. Layer15

NodeProperty

To get or set properties of nodes a NodeProperty string is required. Examples of properties are scale or visible. To learn which nodes support which properties, serr the Node Reference.

NodeType

A NodeType is required to create new nodes or to identify nodes by their type.

Value	File type
11	VoxelLayer
12	VoxelSceneReference
13	VoxelHeightmapReference
14	VoxelMovieReference
15	VoxelFrame
21	PixelLayer
22	PixelReference
31	MeshLayer
32	MeshBox
33	MeshCone
34	MeshCylinder
35	MeshSphere
36	MeshTorus
41	DirLight
42	PointLight
43	SpotLight
51	FirstPersonCamera
52	OrbitCamera
61	ScanBox
62	Locator
98	Group2D
99	Group3D

RectAlign

RectAlign determines the alignment of an object within a rectangular area.

Value	Description
0	Center
1	Left
2	Right
3	Top
4	Bottom
5	TopLeft
6	TopRight
7	BottomLeft
8	BottomRight

ProjectID

A ProjectID is both a unique identifier for a Foxel Project and the name of its subfolder in the projects folder on the hard disk.

A ProjectID identifies one or more nodes.

A single ProjectID is a string that identifies a single project. All ProjectIDs are unique. ProjectIDs are not case-sensitive, so project1 is the same as PROJECT1.

A ProjectID list is a single string that contains multiple comma-separated ProjectIDs enclosed by a pair of angle brackets. For example <project1,project2,project3>. ProjectID lists may not contain wildcards or filters.

A ProjectID filter is a string that starts with an asterisk and is followed by a search string. All projects that have the search string as a substring in their ID are identified. For example for the projects bigcity, smallcity, bigtown the filter *city will identify smallcity and bigcity.

A ProjectID wildcard is a string that automatically identifies projects based on the current context.

Wildcard	Description
*	All projects.
/a	The active project.
/s	All selected projects.

ProjectProperty

To get or set properties of projects a ProjectProperty string is required. Examples of properties are unitScale or keywords.

SkyMode

SkyMode controls the lighting mode of the sky environmental setting.

Value	Description
0	Uniform lighting
1	Image based lighting
2	Atmospheric Scattering

TextureFilter

TextureFilter controls the texture filtering used by the GPU.

Value	Description
0	Nearest Neighbor
1	Linear

ToneMapping

Tone mapping is a technique used to map one set of colors to another, usually from LDR (limited definition range) to HDR (high definition range).

Value	Description
0	Linear
1	ACES
2	ACES approximation
3	Hable
4	Uchimura
5	Reinhard

VoxelShape

A VoxelShape together with CubeRotation defines how a voxel is rendered in the viewport. Currently 6 shapes are supported.

Value	Voxel shape
0	Cube
1	Edge
2	Corner 2-way outside
3	Corner 2-way inside
4	Corner 3-way outside
5	Corner 3-way inside
6	Unused
7	Unused