What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Configuration Settings
Deprecation Schedule

Configuraton Settings

Incisor provides a variety of configuration settings designed to help users tailor their applications to meet specific needs. In this section, you'll find detailed explanations for each configuration property, enabling you to fine-tune your setup.

Application Settings

Application settings are configurable properties that affect the operation of the Incisor platform. Adjusting these settings allows you to tailor Incisor to your preferences.

autoLaunchBrowser
boolean

 

browserClient
string

 

browserClientAdditionalOpeningArgs
string

 

clearConsoleOnProjectRefresh
boolean

 

logs

 

entryCharLimit
number

 

verbosity
string

 

maxThreads
number

 

maxUndoStates
number

 

ports

 

serverPortRangeMax
number

 

serverPortRangeMin
number

 

socketPortRangeMax
number

 

socketPortRangeMin
number

 

refreshOnAssetChange
boolean

 

security

 

allowRemoteHosting
boolean

 

allowScriptedBashCommands
boolean

 

allowUniversalFileIO
boolean

 

 

Project Settings

Project settings define the parameters and behaviors specific to your project. These configurations let you customize aspects such as project structure, optimizations, and instructions, ensuring the project runs according to your needs.

assetConfigurationDataOrder
string[]

 

assetConfigurationDefinitions

Configuration definitions for how the assets are processed and packaged together.

assetPackageScale
string[]

Configuration definitions for how the assets are processed and packaged together.

language
string[]

Configuration definitions for languages.

soundQuality
string[]

Configuration definitions for how the sounds are processed.

autoClearMetaFiles
boolean

Whether or not the current project auto clears meta files. (Default: true)

canvasTransparency
boolean

Determines if the canvas is transparent. (Default: false)

configurations

 

autohostOnPublish
boolean

Whether or not Incisor® will host and launch the current version when using this configuration. (Default: true)

conditionalCodeTagsIncluded
string[]

 

limitPublishedBuildsKept
number

The maximum number of published builds to keep when using this configuration. -1 will keep all published builds. (Default: -1)

minification

 

automaticallyMinifyAllKeywords
boolean

Determines whether or not keywords will be automatically minified when using this configuration. (Default: true)

doNotMinifyPrefix
string

The prefix added to the beginning of any variable that you DO NOT want to be minified. For example: doNotMinifyPrefix = "doNotMinifyKeyword_" will NOT minify doNotMinifyKeyword_myVar.

doNotMinifySuffix
string

The suffix added to the end of any variable that you DO NOT want to be minified. For example: doNotMinifySuffix = "_doNotMinifySuffixKeyword" will NOT minify myVar_dNotMinifySuffixKeyword.

enableMinification
boolean

Determines whether or not minification will take place when using this configuration. (Default: false)

keywordAndStringPairTreatment
string

The substitute option for how variable names and strings are handled. For example, var myObj={}; myObj["myVar"]=true; var myVar=false; MinifyBoth will substitute both "myVar" and myVar to aaa. MinifyNeither will substitute everything except where a variable name and a string match exactly, leaving both "myVar" and myVar unmodified. MinifyKeyword will only minify variable names and leave strings unmodified, i.e. aaa and "myVar"

minifyAssetNames
boolean

 

minifyIncisorApiKeywords
boolean

Determines whether or not Incisor® API keywords will be minified when using this configuration. (Default: false)

minifyPrefix
string

The prefix added to the beginning of any variable that you want to be minified. For example: minifyPrefix = "minifyPrefixKeyword_" will minify minifyPrefixKeyword_myVar but not myVar.

minifySuffix
string

The suffix added to the end of any variable that you want to be minified. For example: minifySuffix = "_minifySuffixKeyword" will minify myVar_minifySuffixKeyword but not myVar.

substitutionAssignment
string

The method minification uses when it substitutes variable names/strings. DeterministicRandom will only change the random seed if any of files have changed from the previous build. Random will change the random seed every time the configuration is built. Ordered will reassign variable names/strings using an alphabetical approach.

optionalCodeModulesExcluded
string[]

 

publishIndexFile
boolean

Should Incisor® create an index file when using this configuration.

removeComments
boolean

Whether or not comments will be removed when using this configuration. (Default: false)

removeWhiteSpace
boolean

Whether or not white space will be removed when using this configuration. (Default: false)

spriteSheetDimensionLimit
number

The pixel dimensions of the sprite sheets generated when using this configuration. (Default: 4096)

supportedAssetConfigurations
Array

Drag this divider to resize the panel.

assetPackageScale
string[]

Which asset package scale to apply when this configuration is used. (Source: assetConfigurationDefinitions)

language
string[]

Which language to apply when this configuration is used. (Source: assetConfigurationDefinitions)

soundQuality
string[]

Which asset package scale to apply when this configuration is used. (Source: assetConfigurationDefinitions)

conditionalCodeTagDefinitions
string[]

Definitions for conditional code tags. Code between the start tag and the end tag will be included or excluded depending on how it is used in the configuration.

coreCanvasResolutionX
number

Width of the core canvas resolution, (Default: 1920)

coreCanvasResolutionY
number

Height of the core canvas resolution, (Default: 1080)

defaultGraphicAssetEffectNodes
string[]

Adds this list of Graphic Asset Effect Nodes to all graphic assets upon instantiation.

devModeConfiguration
string

 

docFormatVersion
number

 

fontDefinitions
Array

Attributes for each font in the current project.

alwaysIncludeTheseCharacters
string[]

Characters to always include when this font is used.

characterWidth
number

Character width adjustment for the font.

fontName
string

The name of the font.

kerningAdjustment
number

Kerning adjustment for the font.

lineHeight
number

Line height adjustment for the font.

phrasesUsingThisFont
string[]

This list of parses will be referenced when font reduction takes place. All characters in these phrases will be included in the asset package.

fontReduction

 

includeStandardCharactersWhenPublished
boolean

 

includeStandardCharactersWhenUnPublished
boolean

 

includeTranscriptCharacters
boolean

 

limitTranscriptCharactersByLanguage
boolean

 

limitTranscriptCharactersByPhrase
boolean

 

standardFontCharacters
number[]

 

mainCameraType
string

Type of camera that the main scene uses. (Default: orthographic)

maskingMode
string

How masking is implemented. (Default: overlapping)

preserveDrawingBuffer
boolean

Option to preserve the drawing buffer or not. (Default: true)

projectCodeName
string

Code name used when referencing the current project.

publicProjectName
string

Public facing name of the current project.

screenShotDestination
string

Location where Incisor® screenshots will be saved.

usingTypescript
boolean

Whether or not the current project uses typescript.

panelLayout

 

divisionLocation
number

 

isColumns
boolean

 

panelType
string

 

stateInfo
string

 

subPanels
panelLayout[]

 

 

Asset Settings

Asset settings are configurations specific to each asset in your project. They enable you to adjust properties like size, geometry, pivot points, and other optimizations to fine-tune the asset's performance and behavior.

allowDuplicateRemoval
boolean

When two assets are found to have identical data, only one copy is downloaded. This setting forces this asset to be omiited from this check.

assetConfigurationFilters
xxx

 

docFormatVersion
number

 

fontFamily
string

 

imageConfigurations

 

allowAdditiveTrimBuffer
boolean

If a trimBuffer value is specified that would push the geometry edges past the bounds of the image, this setting allows new transparent pixels to be added to the image to fill this area.

alphaThreshold
number

Any pixel with an alpha value below this threshold is set to be completely transparent, which can reduce the download size of the resulting image and allow trimming to more effectively discard areas with low contribution.

applyAssetPackageScaling
boolean

Publishing configurations can apply asset package scaling to create smaller graphics targeting lower resolution devices. This setting allows a graphic asset to be omitted from this downscaling. This is typically useful if maintaining a consistent image resolution acress asset packages is required.

compression
string

The compression technique to apply to the image contents. Setting to 'none' leaves the original colors unaffected. Setting to 'paletted' reduces the number of colors in the image to fit within a palette of colors. This allows for more efficient compression but lowers image quality.

downscalingMode
string

The technique to apply when rendering a graphic at a scale smaller than 1:1 when mapped to the render target pixels. Setting to 'nearest' will set every pixel to the color of the closest pixel in the image, which can create a pixelated appearance. Setting to 'linear' will bilinearly interpolate between the closest 4 pixels, creating a smoothed appearance. Setting to 'discreteMipmapNearest' will choose the closest mipmap level appropriate for the scale, and apply the 'nearest' behavior within that mipmap level. Setting to 'discreteMipmapLinear' will choose the closest mipmap level appropriate for the scale, and apply the 'linear' behavior within that mipmap level. Setting to 'mipmapLinear' will choose the two closest mipmap levels appropriate for the scale, apply the 'linear' behavior within each mipmap level, then linearly interpolate between those two results.

imageScalingAffectsHugging
boolean

When using the 'hugged' trimMode, the resolution of the image directly affects the resulting geometry. If this setting is true, hugging is performed on the scaled result of both resolution scaling and asset package scaling. If false, the hugging is performed on the image before this scaling is applied, which can be useful if the resulting geometry needs to be the same regardless of these scaling factors.

mirroring
string

 

pivotPointOffsetX
number

The pivot point of a graphic asset is the origin around which transformations occur. This setting offsets the X component of this pivot point for all instances of this graphic asset.

pivotPointOffsetY
number

The pivot point of a graphic asset is the origin around which transformations occur. This setting offsets the Y component of this pivot point for all instances of this graphic asset.

pivotPointOffsetZ
number

The pivot point of a graphic asset is the origin around which transformations occur. This setting offsets the Z component of this pivot point for all instances of this graphic asset.

premultiplyAlpha
number

Whether to multiply each pixel's red, green, and blue values by the alpha value of that pixel when it is loaded into GPU memory. This is useful for eliminating artifacts where transparent pixels can contribute small amounts of color to adjacent pixels due to interpolated sampling.

resolutionScaleX
number

Reduces the horizontal resolution of the downloaded image, while maintaining the original geometry dimensions.

resolutionScaleY
number

Reduces the vertical resolution of the downloaded image, while maintaining the original geometry dimensions.

shapify
boolean

Whether to convert this graphic to a signed distance field representation and apply the Shapify effect node to any instance of the graphic. This technique allows the edge of the shape to be reconstructed by the effect node while reducing the required resolution of the downloaded graphic.

shapifyEdgeRange
number

When the shapify technique converts the graphic to a signed distance field, it encodes the distance of each pixel to the shape's edge. This value determines the distance in pixels that is the largest representable distance. The Shapify effect node allows the edge value to be changed, which can make a font character more bold, for example. This value would then correspond to the maximum boldness that could be achieved.

shapifyOptimizationLevel
number

How much to reduce the resolution of the downloaded graphic when applying the shapify technique. 0 optimization will leave the resolution unaffected, while 1 will produce a single pixel. Higher values produce a smaller download size, but make the reconstructed edge less accurate.

spriteSheet
string

The name of the spritesheet to which this graphic will be added. Setting this to a new spritesheet name automatically creates that spritesheet.

spriteSheetDimensionLimit
number

The maximum alowable size of either dimension of the spritesheet. If all the graphics can not fit in a single spritesheet that satisfies this constraint, multiple spritesheets will be created

spriteSheetPlacementBuffer
number

The distance in pixels by which to separate the contents of the spritesheet. The buffer pixels will be completely transparent.

trimBuffer
number

When trimming fits new geometry to the image, this value will determine how close to the non-transparent pixels the geometry edge will be.

trimMode
string

Trimming removes transparent pixels from the graphic and creates appropritate geometry to fit to this new version of the image. This reduces both the download size and overdraw. Setting to 'rectangular' fits a rectangle to the remaining pixels. Setting to 'hugged' fits triangles to the remaining pixels so that transparent areas are not rendered, further reducing overdraw.

unitsPerPixelX
number

Applies a scale to the X component of the geometry.

unitsPerPixelY
number

Applies a scale to the Y component of the geometry.

unitsPerPixelZ
number

Applies a scale to the Z component of the geometry.

upscalingMode
string

The technique to apply when rendering a graphic at a scale larger than 1:1 when mapped to the render target pixels. Setting to 'nearest' will set every pixel to the color of the closest pixel in the image, which can create a pixelated appearance. Setting to 'linear' will bilinearly interpolate between the closest 4 pixels, creating a smoothed appearance.

wrapModeH
string

The technique to apply when the horizontal texture coordinates of the geometry extend beyong the bounds of the image. Setting to 'clamp' will repeat the closest pixel available within the image bounds. Setting to 'repeat' will apply a modulo to the texture coordinates, creating a tiling effect where the image repeats. Setting to 'mirroredRepeat' is similar to 'repeat', but every other tile will be flipped, which can be useful for eliminating seams between the tiles.

wrapModeV
string

The technique to apply when the vertical texture coordinates of the geometry extend beyong the bounds of the image. Setting to 'clamp' will repeat the closest pixel available within the image bounds. Setting to 'repeat' will apply a modulo to the texture coordinates, creating a tiling effect where the image repeats. Setting to 'mirroredRepeat' is similar to 'repeat', but every other tile will be flipped, which can be useful for eliminating seams between the tiles.

includeWhenBuilt
boolean

Whether to include this asset in the result of the publication process. This is commonly used for reference assets that are used during development, but which are not needed in the finished product.

loadingTier
number

The loading tier that this asset belongs to. Loading tiers separate assets into packages that can be separately downloaded. Setting this to a new tier number automatically creates that tier.

typeFontScale
number