Documentation

Core

Python API functions

Read time 40 minutes

Last updated a day ago

cloneEntity

Clone an entity.


core.cloneEntity(entity) -> core.Entity

Parameters

Type	Name	Description
Entity	entity	The entity to clone.

Returns

Type	Name	Description
Entity	clonedEntity	The cloned entity.

configureFunctionLogger


core.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)

Parameters

Type	Name	Description
String	functionName
Boolean	enableFunction
Boolean	enableParameters
Boolean	enableExecutionTime

createEntity

Create an entity.


core.createEntity(type) -> core.Entity

Parameters

Type	Name	Description
EntityType	type	The type of entity to create.

Returns

Type	Name	Description
Entity	entity	The created entity id.

deleteEntities

Delete a set of entities.


core.deleteEntities(entities)

Parameters

Type	Name	Description
EntityList	entities	List of entity to delete.

getEntitiesByType

Get all entities of a given type.


core.getEntitiesByType(type, includeUnsubscribed) -> core.EntityList

Parameters

Type	Name	Description
EntityType	type	The type of entities to retrieve.
Boolean	includeUnsubscribed	Include unsubscribed entities.

Returns

Type	Name	Description
EntityList	entities	The returned entity list.

getRemainingSecondsBeforeLicenseTimeout

Get the seconds left before the app force-closes after the license server is disconnected.


core.getRemainingSecondsBeforeLicenseTimeout() -> core.Double

Returns

Type	Name	Description
Double	time

resetSession

Clear all the current session (all unsaved work will be lost).


core.resetSession()

unsavedUserChanges

Returns true if the user has made changes to the project.


core.unsavedUserChanges() -> core.Bool

Returns

Type	Name	Description
Bool	hasChanged	Boolean checking if the project has been modified.

DebugMessage

Desc

getEvent

Get EventDesc of an event.


core.getEvent(moduleName, eventName) -> core.EventDesc

Parameters

Type	Name	Description
String	moduleName	Target module name.
String	eventName

Returns

Type	Name	Description
EventDesc	event

See also:

getEvents

Get events of a group.


core.getEvents(moduleName, groupName) -> core.EventDescList

Parameters

Type	Name	Description
String	moduleName	Target module name.
String	groupName	Target group name.

Returns

Type	Name	Description
EventDescList	eventDescList

See also:

getFunction

Get FunctionDesc of a function.


core.getFunction(moduleName, functionName) -> core.FunctionDesc

Parameters

Type	Name	Description
String	moduleName	Target module name.
String	functionName	Target function name.

Returns

Type	Name	Description
FunctionDesc	functionDesc

See also:

getFunctions

Get functions of a group.


core.getFunctions(moduleName, groupName) -> core.FunctionDescList

Parameters

Type	Name	Description
String	moduleName	Target module name.
String	groupName	Target group name.

Returns

Type	Name	Description
FunctionDescList	functions

See also:

getGroup

Get a group desc from a specific module.


core.getGroup(moduleName, groupName) -> core.GroupDesc

Parameters

Type	Name	Description
String	moduleName	Target module name.
String	groupName	Target group name.

Returns

Type	Name	Description
GroupDesc	group

See also:

getGroups

Get all group desc of a module.


core.getGroups(moduleName) -> core.GroupDescList

Parameters

Type	Name	Description
String	moduleName	Target module name.

Returns

Type	Name	Description
GroupDescList	groups

See also:

getModuleTypes

Get TypeDescList from a module name.


core.getModuleTypes(moduleName) -> core.TypeDescList

Parameters

Type	Name	Description
String	moduleName	Target module name.

Returns

Type	Name	Description
TypeDescList	typeDescList

See also:

getModules

Get all modules desc.


core.getModules() -> core.ModuleDescList

Returns

Type	Name	Description
ModuleDescList	modules

See also:

getModulesName

Get all modules name.


core.getModulesName() -> core.StringList

Returns

Type	Name	Description
StringList	modulesName

See also:

getType

Get TypeDesc from a type name.


core.getType(moduleName, typeNameStr) -> core.TypeDesc

Parameters

Type	Name	Description
String	moduleName	Target module name.
String	typeNameStr	Target type name.

Returns

Type	Name	Description
TypeDesc	typeDesc

See also:

getTypeAttributes

Get attributes TypeDesc from a type name.


core.getTypeAttributes(moduleName, typeNameStr) -> core.StringPairList

Parameters

Type	Name	Description
String	moduleName	Target module name.
String	typeNameStr	Target type name.

Returns

Type	Name	Description
StringPairList	attributes

See also:

UI

defineCaptchaCallback

Define a callback function to customize the captha which unlock automated functions in interactive products.


core.defineCaptchaCallback(callback)

Parameters

Type	Name	Description
CaptchaCallback	callback	The callback function.

database

entityExists

Returns true if the entity exists.


core.entityExists(entity) -> core.Boolean

Parameters

Type	Name	Description
Entity	entity	The wanted entity.

Returns

Type	Name	Description
Boolean	exists	True if it exists.

See also:

getAllEntities

Returns all the entities on the database.


core.getAllEntities() -> core.EntityList

Returns

Type	Name	Description
EntityList	entities	All entities.

See also:

getCurrentPiXYZFile

Get current (loaded) Pixyz file path.


core.getCurrentPiXYZFile() -> core.FilePath

Returns

Type	Name	Description
FilePath	fileName	The current Pixyz file.

See also:

getEntityType

Returns the type id of the entity.


core.getEntityType(entity) -> core.EntityType

Parameters

Type	Name	Description
Entity	entity	The wanted entity.

Returns

Type	Name	Description
EntityType	type	Type type of the entity.

See also:

getEntityTypeString

Returns the type name of the entity.


core.getEntityTypeString(entity) -> core.String

Parameters

Type	Name	Description
Entity	entity	The wanted entity.

Returns

Type	Name	Description
String	type	Name of the entity type.

See also:

getTypeStats

Get the database stats.


core.getTypeStats() -> core.IntListList

Returns

Type	Name	Description
IntListList	stats

See also:

isCurrentPiXYZFileModified

Return true, if the current (loaded) file has been modified since last load or save.


core.isCurrentPiXYZFileModified() -> core.Boolean

Returns

Type	Name	Description
Boolean	modified	True if the file is modified.

See also:

load

Load a new scene.


core.load(fileName)

Parameters

Type	Name	Description
FilePath	fileName	Path to load the file.

See also:

lockEntityRegistration

Lock Entity registration, use with Caution. All entities created after this call will not be saved on .pxz file and will not be listed as existing entities on the Database. Be careful to not references these entities with other registered entities.


core.lockEntityRegistration()

See also:

save

Save the scene.


core.save(fileName)

Parameters

Type	Name	Description
OutputFilePath	fileName	Path to save the file.

See also:

unlockEntityRegistration

Unlock Entity registration.


core.unlockEntityRegistration()

See also:

license

addWantedToken

Add a license token to the list of wanted tokens. The wanted tokens list is saved on disk in program data and is used at initialization. Prefer using 'core.needToken' instead.


core.addWantedToken(tokenName)

Parameters

Type	Name	Description
String	tokenName	Wanted token.

See also:

checkLicense

Verifies the validity of the current installed license to ensure compliance and access control.


core.checkLicense() -> core.Boolean

Returns

Type	Name	Description
Boolean	valid	A Boolean value indicating whether the current installed license is valid (true) or invalid (false).

See also:

checkWebLogin

Check if authentification on the Web license API is sucessfull.


core.checkWebLogin(login, password) -> core.Boolean

Parameters

Type	Name	Description
String	login	WEB account login.
Password	password	WEB account password.

Returns

Type	Name	Description
Boolean	valid

See also:

configureLicenseServer

Configure the license server to use to get floating licenses.


core.configureLicenseServer(address, port, flexLM=True)

Parameters

Type	Name	Description
String	address	Server address.
UShort	port	Server port.
Boolean	flexLM	Enable FlexLM license server.

See also:

generateActivationCode

Create an activation code to generate an offline license.


core.generateActivationCode(filePath)

Parameters

Type	Name	Description
OutputFilePath	filePath	Path to write the activation code.

See also:

generateDeactivationCode

Create an deactivation code to release the license from this machine.


core.generateDeactivationCode(filePath)

Parameters

Type	Name	Description
OutputFilePath	filePath	Path to write the deactivation code.

See also:

getCurrentLicenseInfos

Get information on current installed license.


core.getCurrentLicenseInfos() -> core.LicenseInfos

Returns

Type	Name	Description
LicenseInfos	licenseInfos

See also:

getLicenseError

Get errors from license check.


core.getLicenseError() -> core.Boolean, core.String

Returns

Type	Name	Description
Boolean	valid
String	reasons

See also:

getLicenseServer

Get current license server.


core.getLicenseServer() -> core.String, core.UShort, core.Bool

Returns

Type	Name	Description
String	serverHost	Server host name or IP.
UShort	serverPort	Server port.
Bool	useFlexLM	Set to true if flexLM server.

See also:

installLicense

Add a new license. You can use either an activation .bin file from the website or a .lic file.


core.installLicense(licensePath, user=False)

Parameters

Type	Name	Description
FilePath	licensePath	License file path (.bin or .lic).
Boolean	user	Decide if the .lic license is installed only for this user or for all users. If false, Pixyz must be configured by running 'PiXYZFinishInstall' utility first (only once).

See also:

listOwnedTokens

Get the list of actually owned license tokens.


core.listOwnedTokens() -> core.StringList

Returns

Type	Name	Description
StringList	ownedTokens	Owned token list.

See also:

listTokens

Get the list of license tokens for this product.


core.listTokens(onlyMandatory=False) -> core.StringList

Parameters

Type	Name	Description
Bool	onlyMandatory	If True, optional tokens will not be returned.

Returns

Type	Name	Description
StringList	tokens	Token list.

See also:

listWantedTokens

Get the list of license token configured to be requested at initialization.


core.listWantedTokens() -> core.StringList

Returns

Type	Name	Description
StringList	tokens	Token list.

See also:

needToken

Requests a license token for the current session. This step should be done after configuring license server. Throws an exception if the token is not available.


core.needToken(tokenName)

Parameters

Type	Name	Description
String	tokenName	Token name.

See also:

ownToken

Returns True if we own a token, without requesting it.


core.ownToken(tokenName) -> core.Boolean

Parameters

Type	Name	Description
String	tokenName	Token name.

Returns

Type	Name	Description
Boolean	owned	True if the token is owned.

See also:

releaseToken

Release an optional license token.


core.releaseToken(tokenName)

Parameters

Type	Name	Description
String	tokenName	Token name.

See also:

releaseWebLicense

Release License owned by user WEB account.


core.releaseWebLicense(login, password, id)

Parameters

Type	Name	Description
String	login	WEB account login.
Password	password	WEB account password.
Ident	id	WEB license id.

See also:

removeWantedToken

Remove a license token from the list of wanted optional tokens.


core.removeWantedToken(tokenName)

Parameters

Type	Name	Description
String	tokenName	Unwanted token.

See also:

requestWebLicense

Request License owned by user WEB account.


core.requestWebLicense(login, password, id)

Parameters

Type	Name	Description
String	login	WEB account login.
Password	password	WEB account password.
Ident	id	WEB license id.

See also:

retrieveWebLicenses

Retrieves License owned by user WEB account.


core.retrieveWebLicenses(login, password) -> core.WebLicenseInfoList

Parameters

Type	Name	Description
String	login	WEB account login.
Password	password	WEB account password.

Returns

Type	Name	Description
WebLicenseInfoList	licenses

See also:

tokenValid

Returns True if a token is owned by the product, request will be done if missing.


core.tokenValid(tokenName) -> core.Bool

Parameters

Type	Name	Description
String	tokenName	Token name.

Returns

Type	Name	Description
Bool	valid

See also:

parallel

parallelAddJob

Add a job to a parallel session.


core.parallelAddJob(session, jobCallback, dataPtr)

Parameters

Type	Name	Description
ParallelSession	session
ParallelCallback	jobCallback
Ptr	dataPtr

See also:

parallelFinish

Ends a parallel session after waiting for all jobs to finish.


core.parallelFinish(session)

Parameters

Type	Name	Description
ParallelSession	session

See also:

parallelStart

Starts a new parallel session.


core.parallelStart(progression=False, name="Parallel session", jobCount=-1) -> core.ParallelSession

Parameters

Type	Name	Description
Boolean	progression	Enable progression for the parallel session.
String	name	Name of the parallel session.
Int	jobCount	Count of parallel jobs if known (for progression).

Returns

Type	Name	Description
ParallelSession	session

See also:

plugins

getModuleDescFromXML

Generate a ModuleDesc from an .xml description.


core.getModuleDescFromXML(xmlPath, addToModules=True) -> core.ModuleDesc

Parameters

Type	Name	Description
FilePath	xmlPath	.xml file path.
Boolean	addToModules

Returns

Type	Name	Description
ModuleDesc	description

See also:

core.removeModule

removeModule

Remove a module added via getModuleDescFromXML.


core.removeModule(module)

Parameters

Type	Name	Description
String	module	Module name.

See also:

core.getModuleDescFromXML

progress

popProgression

Leave current progression level.


core.popProgression()

See also:

pushProgression

Create a new progression level.


core.pushProgression(stepCount, progressName="")

Parameters

Type	Name	Description
Int	stepCount	Step count.
String	progressName	Name of the progression step.

See also:

stepProgression

Add a step to current progression level.


core.stepProgression(stepCount=1)

Parameters

Type	Name	Description
Int	stepCount	Step count.

See also:

properties

addCustomProperties

Add multiple custom property to entities that support custom properties.


core.addCustomProperties(entities, names, values=None, types=None)

Parameters

Type	Name	Description
EntityList	entities	Entities that support custom properties.
StringList	names	Name of the custom property for each entity.
StringList	values	Value of the custom property for each entity.
PropertyTypeList	types	Type of the custom property for each entity.

See also:

addCustomProperty

Add a custom property to an entity that support custom properties.


core.addCustomProperty(entity, name, value="", type=0)

Parameters

Type	Name	Description
Entity	entity	An entity that support custom properties.
String	name	Name of the custom property.
String	value	Value of the custom property.
PropertyType	type	Type of the custom property.

See also:

getModuleProperty

Returns the value of a module property.


core.getModuleProperty(module, propertyName) -> core.String

Parameters

Type	Name	Description
String	module	Name of the module.
String	propertyName	The property name.

Returns

Type	Name	Description
String	propertyValue	The property value.

See also:

getModulePropertyInfo

Returns the value of a module property.


core.getModulePropertyInfo(module, propertyName) -> core.PropertyInfo

Parameters

Type	Name	Description
String	module	Name of the module.
String	propertyName	The property name.

Returns

Type	Name	Description
PropertyInfo	propertyInfo	The property info.

See also:

getProperties

Get the property value on entities (if the property is not set on an entity, defaultValue is returned).


core.getProperties(entities, propertyName, defaultValue="") -> core.StringList

Parameters

Type	Name	Description
EntityList	entities	List of entities.
String	propertyName	The property name.
String	defaultValue	Default value to return if the property does not exist on an entity.

Returns

Type	Name	Description
StringList	values	Property value on each entity.

See also:

getProperty

Get a property value as String on an entity (error if the property does not exist on the entity).


core.getProperty(entity, propertyName) -> core.String

Parameters

Type	Name	Description
Entity	entity	The entity.
String	propertyName	The property name.

Returns

Type	Name	Description
String	value	The property value as String.

See also:

getPropertyInfo

Get a property info on an entity (error if the property does not exist on the entity).


core.getPropertyInfo(entity, propertyName) -> core.PropertyInfo

Parameters

Type	Name	Description
Entity	entity	The entity.
String	propertyName	The property name.

Returns

Type	Name	Description
PropertyInfo	propertyInfo	The property info.

See also:

hasCustomProperty

Return true if the custom property was found on the occurrence.


core.hasCustomProperty(entityId, customPropertyName) -> core.Boolean

Parameters

Type	Name	Description
Entity	entityId	An entity that support properties.
String	customPropertyName	Name of the custom property.

Returns

Type	Name	Description
Boolean	propertyFound	True if the enity has the custom propery, else False.

See also:

hasProperty

Return true if the property was found on the occurrence, will not throw any exception except if the entity does not exist.


core.hasProperty(entity, propertyName) -> core.Boolean

Parameters

Type	Name	Description
Entity	entity	An entity that support properties.
String	propertyName	Name of the property.

Returns

Type	Name	Description
Boolean	propertyFound	True if the entity has the property asked, else False.

See also:

listEnumLabels

Returns the informations of a module property.


core.listEnumLabels(enumType) -> core.EnumPropertyInfo

Parameters

Type	Name	Description
Int	enumType	The real enum type number (ie. The one return in subtype of PropertyInfo).

Returns

Type	Name	Description
EnumPropertyInfo	enumPropertyInfo	The enum property info.

See also:

listModuleProperties

Returns all the properties in the given module.


core.listModuleProperties(module) -> core.PropertyInfoList

Parameters

Type	Name	Description
String	module	Name of the module.

Returns

Type	Name	Description
PropertyInfoList	properties	List of module properties info.

See also:

listProperties

Returns the names and values of the properties available on an entity.


core.listProperties(entity) -> core.PropertyInfoList

Parameters

Type	Name	Description
Entity	entity	Entity to list.

Returns

Type	Name	Description
PropertyInfoList	properties	List of available properties info.

See also:

listPropertiesBatch

Returns the names and values of the properties available on multiple entities.


core.listPropertiesBatch(entities) -> core.PropertyInfoListList

Parameters

Type	Name	Description
EntityList	entities	Entities to list.

Returns

Type	Name	Description
PropertyInfoListList	properties	List of available properties info.

See also:

removeCustomProperty

Remove a custom property from an entity that support custom properties.


core.removeCustomProperty(entity, name)

Parameters

Type	Name	Description
Entity	entity	An entity that support custom properties.
String	name	Name of the custom property.

See also:

restoreModulePropertyDefaultValue

Restore the default value of a module property.


core.restoreModulePropertyDefaultValue(module, propertyName) -> core.String

Parameters

Type	Name	Description
String	module	Name of the module.
String	propertyName	The property name.

Returns

Type	Name	Description
String	value	The property value as String.

See also:

setModuleProperty

Set the value of a module property.


core.setModuleProperty(module, propertyName, propertyValue) -> core.String

Parameters

Type	Name	Description
String	module	Name of the module.
String	propertyName	The property name.
String	propertyValue	The property value.

Returns

Type	Name	Description
String	value	The property value as String.

See also:

setProperties

Set multiple properties values on entities.


core.setProperties(entities, propertyNames, propertyValues)

Parameters

Type	Name	Description
EntityList	entities	List of entities.
StringList	propertyNames	The property name for each entity.
StringList	propertyValues	The property value for each entity.

See also:

setProperty

Set a property value on an entity.


core.setProperty(entity, propertyName, propertyValue) -> core.String

Parameters

Type	Name	Description
Entity	entity	The entity.
String	propertyName	The property name.
String	propertyValue	The property value.

Returns

Type	Name	Description
String	value	The property value as String.

See also:

supportCustomProperties

Return true if an entity support custom properties.


core.supportCustomProperties(entity) -> core.Boolean

Parameters

Type	Name	Description
Entity	entity	An entity.

Returns

Type	Name	Description
Boolean	support	True if the entity support custom properties, else False.

See also:

unsetProperty

Unset an entity's property.


core.unsetProperty(entity, propertyName)

Parameters

Type	Name	Description
Entity	entity	The entity.
String	propertyName	The property name.

See also:

system

availableMemory

Returns available memory.


core.availableMemory() -> core.Long, core.Long, core.Long, core.Long

Returns

Type	Name	Description
Long	availVirt	Available virtual memory in bytes.
Long	totalVirt	Total virtual memory in bytes.
Long	availPhys	Available physical memory in bytes.
Long	totalPhys	Total physical memory in bytes.

See also:

checkForUpdates

Check for software update.


core.checkForUpdates() -> core.Bool, core.String, core.String, core.String

Returns

Type	Name	Description
Bool	newVersionAvailable	True if there is a new version available of this product.
String	newVersion	New version value.
String	newVersionLink	Link to download the new version.
String	htmlInfo	Html info associated with the new version.

See also:

clearOtherTemporaryDirectories

Remove all other session temporary directories (warning: make sure that no other instance of pixyz is running.


core.clearOtherTemporaryDirectories()

See also:

getCustomVersionTag

Get the Pixyz custom version tag.


core.getCustomVersionTag() -> core.String

Returns

Type	Name	Description
String	customVersionTag

See also:

getMemoryUsagePeak

Returns the memory usage peak of the current process in MB ( only available on windows yet ).


core.getMemoryUsagePeak() -> core.Long

Returns

Type	Name	Description
Long	peakWorkingSet	Maximum physical memory used by the process until now (in MB).

See also:

getPixyzWebsiteURL

Get the Pixyz website URL.


core.getPixyzWebsiteURL() -> core.String

Returns

Type	Name	Description
String	url

See also:

getProductName

Get the Pixyz product name.


core.getProductName() -> core.String

Returns

Type	Name	Description
String	productName

See also:

getTempDirectory

Get the Pixyz temp directory (server side directory in case of remote access).


core.getTempDirectory() -> core.String

Returns

Type	Name	Description
String	tmpDir

See also:

getVersion

Get the Pixyz product version.


core.getVersion() -> core.String

Returns

Type	Name	Description
String	version

See also:

setCurrentThreadAsProcessThread

Set the process thread. Use this function when you want to get progress changed callbacks from another thread as the one you initialized Pixyz on.


core.setCurrentThreadAsProcessThread()

See also:

undo/redo

clearUndoRedo

Clear undo/redo history.


core.clearUndoRedo()

See also:

endUndoRedoStep

End current undo/redo step.


core.endUndoRedoStep(deleteIfEmpty=True)

Parameters

Type	Name	Description
Boolean	deleteIfEmpty	If True, empty step with no modification will be deleted from the stack at the end.

See also:

getRedoStack

Get the history of actions stack.


core.getRedoStack() -> core.StringList

Returns

Type	Name	Description
StringList	redoStack

See also:

getRedoStepUserData

Get user data for undo step #index.


core.getRedoStepUserData(index) -> core.String

Parameters

Type	Name	Description
UInt	index

Returns

Type	Name	Description
String	userData

See also:

getUndoStack

Get the history of actions stack.


core.getUndoStack() -> core.StringList

Returns

Type	Name	Description
StringList	undoStack

See also:

getUndoStepUserData

Get user data for undo step #index.


core.getUndoStepUserData(index) -> core.String

Parameters

Type	Name	Description
UInt	index

Returns

Type	Name	Description
String	userData

See also:

hasRecordingStep

Has recording step.


core.hasRecordingStep() -> core.Boolean

Returns

Type	Name	Description
Boolean	hasRecordingStep	True if there is recoding step, else False.

See also:

redo

Redo some steps.


core.redo(count=1)

Parameters

Type	Name	Description
UInt	count

See also:

startUndoRedoStep

Start a new undo/redo step.


core.startUndoRedoStep(stepName, userData="")

Parameters

Type	Name	Description
String	stepName
String	userData

See also:

stopProcess

Stop process (works if there is recording step).


core.stopProcess()

See also:

toggleUndoRedo

Toggle undo/redo.


core.toggleUndoRedo()

See also:

undo

Undo some steps.


core.undo(count=1)

Parameters

Type	Name	Description
UInt	count

See also:

verbose

addConsoleVerbose

Add a console verbose level.


core.addConsoleVerbose(level)

Parameters

Type	Name	Description
Verbose	level	Verbose level.

See also:

addLogFileVerbose

Add a log file verbose level.


core.addLogFileVerbose(level)

Parameters

Type	Name	Description
Verbose	level	Verbose level.

See also:

addSessionLogFileVerbose

Add a session log file (lastSession{Id}.log) verbose level.


core.addSessionLogFileVerbose(level)

Parameters

Type	Name	Description
Verbose	level	Verbose level.

See also:

configureInterfaceLogger

Set new configuration for the Interface Logger.


core.configureInterfaceLogger(enableFunction=True, enableParameters=True, enableExecutionTime=True)

Parameters

Type	Name	Description
Boolean	enableFunction	If true, the called function names will be print.
Boolean	enableParameters	If true, the called function parameters will be print (only if enableFunction=true too).
Boolean	enableExecutionTime	If true, the called functions execution times will be print.

See also:

getInterfaceLoggerConfiguration

Get the current Interface Logger configuration.


core.getInterfaceLoggerConfiguration() -> core.Boolean, core.Boolean, core.Boolean

Returns

Type	Name	Description
Boolean	functionEnabled	True if the called function names are printed.
Boolean	parametersEnabled	True if the called function parameters are printed.
Boolean	executionTimeEnabled	True if the called functions execution times are printed.

See also:

getLogFile

Get the path of the log file.


core.getLogFile() -> core.OutputFilePath

Returns

Type	Name	Description
OutputFilePath	path	Path of the log file.

See also:

hasConsoleVerbose

Returns whether a console verbose level is present.


core.hasConsoleVerbose(level) -> core.Bool

Parameters

Type	Name	Description
Verbose	level	Verbose level.

Returns

Type	Name	Description
Bool	enabled	Whether the console verbose level is present.

See also:

log

Log a message to Pixyz output.


core.log(message, level)

Parameters

Type	Name	Description
String	message	Message to log.
Verbose	level	Verbose level.

See also:

removeConsoleVerbose

Remove a console verbose level.


core.removeConsoleVerbose(level)

Parameters

Type	Name	Description
Verbose	level	Verbose level.

See also:

removeLogFileVerbose

Remove a log file verbose level.


core.removeLogFileVerbose(level)

Parameters

Type	Name	Description
Verbose	level	Verbose level.

See also:

removeSessionLogFileVerbose

Remove a session log file (lastSession{Id}.log) verbose level.


core.removeSessionLogFileVerbose(level)

Parameters

Type	Name	Description
Verbose	level	Verbose level.

See also:

setCoreDumpFile

Important

This function is tagged as experimental.

Set the path of the core dump file that will be written when a crash occurs (default=none).


core.setCoreDumpFile(path)

Parameters

Type	Name	Description
OutputFilePath	path	Path of the core dump file.

See also:

setLogFile

Set the path of the log file.


core.setLogFile(path, keepHistory=False)

Parameters

Type	Name	Description
OutputFilePath	path	Path of the log file.
Boolean	keepHistory	Keep session log history in new log file.

See also:

Core

cloneEntity

Type

Name

Description

Type

Name

Description

configureFunctionLogger

Type

Name

Description

createEntity

Type

Name

Description

Type

Name

Description

deleteEntities

Type

Name

Description

getEntitiesByType

Type

Name

Description

Type

Name

Description

getRemainingSecondsBeforeLicenseTimeout

Type

Name

Description

resetSession

unsavedUserChanges

Type

Name

Description

DebugMessage

Desc

getEvent

Type

Name

Description

Type

Name

Description

getEvents

Type

Name

Description

Type

Name

Description

getFunction

Type

Name

Description

Type

Name

Description

getFunctions

Type

Name

Description

Type

Name

Description

getGroup

Type

Name

Description

Type

Name

Description

getGroups

Type

Name

Description