### Kirikiri script scrambled file signatures Source: https://github.com/arcusmaximus/kirikiritools/blob/master/README.md Recognizes scrambled or compressed Kirikiri script files (.ks/.tjs) by their starting bytes. KirikiriDescrambler converts such files into regular text files that can be placed back in the game without rescrambling. ```text FE FE 00 FF FE FE FE 01 FF FE FE FE 02 FF FE ``` -------------------------------- ### Xp3Pack command-line usage Source: https://github.com/arcusmaximus/kirikiritools/blob/master/README.md Creates an unencrypted patch.xp3 from a 'patch' subfolder in the game folder. If the game already has patch.xp3, use 'patch2' (and so on) as the folder name and argument. ```text Xp3Pack patch ``` -------------------------------- ### TVPGetAppPath Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns the application path. ```APIDOC ## TVPGetAppPath ### Description Returns the application path. ### Function Signature `ttstr ::TVPGetAppPath()` ### Parameters - None ### Return Value - **ttstr** - Application path. ``` -------------------------------- ### TVPSetCurrentDirectory Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Sets the current directory. ```APIDOC ## TVPSetCurrentDirectory ### Description Sets the current directory. ### Function Signature `void ::TVPSetCurrentDirectory(const ttstr &)` ### Parameters - **dir** (const ttstr&) - Required - Directory path. ### Return Value - None ``` -------------------------------- ### TVPAddAutoPath Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Adds an automatic search path. ```APIDOC ## TVPAddAutoPath ### Description Adds an automatic search path. ### Function Signature `void ::TVPAddAutoPath(const ttstr &)` ### Parameters - **path** (const ttstr&) - Required - Path to add. ### Return Value - None ``` -------------------------------- ### TVPRegisterStorageMedia Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Registers a storage media handler. ```APIDOC ## TVPRegisterStorageMedia ### Description Registers a storage media handler. ### Function Signature `void ::TVPRegisterStorageMedia(iTVPStorageMedia *)` ### Parameters - **media** (iTVPStorageMedia*) - Required - Storage media handler. ### Return Value - None ``` -------------------------------- ### TVPCreateTextStreamForRead Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a text stream for reading from a storage. ```APIDOC ## TVPCreateTextStreamForRead ### Description Creates a text stream for reading from a storage. ### Function Signature `iTJSTextReadStream * ::TVPCreateTextStreamForRead(const ttstr &, const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. - **encoding** (const ttstr&) - Required - Text encoding. ### Return Value - **iTJSTextReadStream\*** - Read stream. ``` -------------------------------- ### TVPCreateTextStreamForWrite Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a text stream for writing to a storage. ```APIDOC ## TVPCreateTextStreamForWrite ### Description Creates a text stream for writing to a storage. ### Function Signature `iTJSTextWriteStream * ::TVPCreateTextStreamForWrite(const ttstr &, const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. - **encoding** (const ttstr&) - Required - Text encoding. ### Return Value - **iTJSTextWriteStream\*** - Write stream. ``` -------------------------------- ### TVPPostEvent Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Posts an event to the event queue. ```APIDOC ## TVPPostEvent ### Description Posts an event to the event queue. ### Function Signature `void ::TVPPostEvent(iTJSDispatch2 *, iTJSDispatch2 *, ttstr &, tjs_uint32, tjs_uint32, tjs_uint, tTJSVariant *)` ### Parameters - **dest** (iTJSDispatch2*) - Required - Destination object. - **sender** (iTJSDispatch2*) - Required - Sender object. - **event** (ttstr&) - Required - Event name. - **tag** (tjs_uint32) - Required - Event tag. - **flags** (tjs_uint32) - Required - Flags. - **delay** (tjs_uint) - Required - Delay in milliseconds. - **params** (tTJSVariant*) - Required - Array of parameters. ### Return Value - None ``` -------------------------------- ### TVPExtractStorageExt Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Extracts the extension from a storage name. ```APIDOC ## TVPExtractStorageExt ### Description Extracts the extension from a storage name. ### Function Signature `ttstr ::TVPExtractStorageExt(const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. ### Return Value - **ttstr** - Extension. ``` -------------------------------- ### TVPGetTemporaryName Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns a temporary name string. ```APIDOC ## TVPGetTemporaryName ### Description Returns a temporary name string. ### Function Signature `ttstr ::TVPGetTemporaryName()` ### Parameters - None ### Return Value - **ttstr** - Temporary name. ``` -------------------------------- ### TVPChopStorageExt Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Removes the extension from a storage name. ```APIDOC ## TVPChopStorageExt ### Description Removes the extension from a storage name. ### Function Signature `ttstr ::TVPChopStorageExt(const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. ### Return Value - **ttstr** - Name without extension. ``` -------------------------------- ### TVPIsExistentStorage Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Checks if a storage exists. ```APIDOC ## TVPIsExistentStorage ### Description Checks if a storage exists. ### Function Signature `bool ::TVPIsExistentStorage(const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. ### Return Value - **bool** - True if exists. ``` -------------------------------- ### TVPExtractStoragePath Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Extracts the directory path from a storage path. ```APIDOC ## TVPExtractStoragePath ### Description Extracts the directory path from a storage path. ### Function Signature `ttstr ::TVPExtractStoragePath(const ttstr &)` ### Parameters - **path** (const ttstr&) - Required - Storage path. ### Return Value - **ttstr** - Directory path. ``` -------------------------------- ### TVPClearStorageCaches Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Clears storage caches. ```APIDOC ## TVPClearStorageCaches ### Description Clears storage caches. ### Function Signature `void ::TVPClearStorageCaches()` ### Parameters - None ### Return Value - None ``` -------------------------------- ### TJSCreateCustomObject Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a custom object. ```APIDOC ## TJSCreateCustomObject ### Description Creates a custom object. ### Function Signature `iTJSDispatch2 * ::TJSCreateCustomObject()` ### Parameters - None ### Return Value - **iTJSDispatch2\*** - New custom object. ``` -------------------------------- ### TVPGetPlacedPath Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns the placed path for a storage name. ```APIDOC ## TVPGetPlacedPath ### Description Returns the placed path for a storage name. ### Function Signature `ttstr ::TVPGetPlacedPath(const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. ### Return Value - **ttstr** - Placed path. ``` -------------------------------- ### TJSCreateNativeClassMethod Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a native class method object with the given callback. ```APIDOC ## TJSCreateNativeClassMethod ### Description Creates a native class method object with the given callback. ### Function Signature `tTJSNativeClassMethod * ::TJSCreateNativeClassMethod(tTJSNativeClassMethodCallback)` ### Parameters - **callback** (tTJSNativeClassMethodCallback) - Required - Callback function. ### Return Value - **tTJSNativeClassMethod\*** - New method object. ``` -------------------------------- ### TJSCreateNativeClassForPlugin Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a native class for a plugin with the given name and instance creator. ```APIDOC ## TJSCreateNativeClassForPlugin ### Description Creates a native class for a plugin with the given name and instance creator. ### Function Signature `tTJSNativeClassForPlugin * ::TJSCreateNativeClassForPlugin(const ttstr &, tTJSCreateNativeInstance)` ### Parameters - **name** (const ttstr&) - Required - Class name. - **create_instance** (tTJSCreateNativeInstance) - Required - Instance creation callback. ### Return Value - **tTJSNativeClassForPlugin\*** - New native class object. ``` -------------------------------- ### TVPExtractStorageName Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Extracts the file name from a storage path. ```APIDOC ## TVPExtractStorageName ### Description Extracts the file name from a storage path. ### Function Signature `ttstr ::TVPExtractStorageName(const ttstr &)` ### Parameters - **path** (const ttstr&) - Required - Storage path. ### Return Value - **ttstr** - File name. ``` -------------------------------- ### TJSCreateNativeClassConstructor Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a native class constructor object with the given callback. ```APIDOC ## TJSCreateNativeClassConstructor ### Description Creates a native class constructor object with the given callback. ### Function Signature `tTJSNativeClassMethod * ::TJSCreateNativeClassConstructor(tTJSNativeClassMethodCallback)` ### Parameters - **callback** (tTJSNativeClassMethodCallback) - Required - Callback function. ### Return Value - **tTJSNativeClassMethod\*** - New constructor object. ``` -------------------------------- ### TVPSetXP3ArchiveExtractionFilter Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Sets a filter for XP3 archive extraction. ```APIDOC ## TVPSetXP3ArchiveExtractionFilter ### Description Sets a filter for XP3 archive extraction. ### Function Signature `void ::TVPSetXP3ArchiveExtractionFilter(tTVPXP3ArchiveExtractionFilter)` ### Parameters - **filter** (tTVPXP3ArchiveExtractionFilter) - Required - Filter function. ### Return Value - None ``` -------------------------------- ### TJSThrowNullAccess Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Throws a null access exception. ```APIDOC ## TJSThrowNullAccess ### Description Throws a null access exception. ### Function Signature `void ::TJSThrowNullAccess()` ### Parameters - None ### Return Value - None (throws exception) ``` -------------------------------- ### TVPIsExistentStorageNoSearch Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Checks if a storage exists without searching. ```APIDOC ## TVPIsExistentStorageNoSearch ### Description Checks if a storage exists without searching. ### Function Signature `bool ::TVPIsExistentStorageNoSearch(const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. ### Return Value - **bool** - True if exists. ``` -------------------------------- ### TJSThrowDivideByZero Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Throws a divide-by-zero exception. ```APIDOC ## TJSThrowDivideByZero ### Description Throws a divide-by-zero exception. ### Function Signature `void ::TJSThrowDivideByZero()` ### Parameters - None ### Return Value - None (throws exception) ``` -------------------------------- ### TVPGetLocalName Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Retrieves the local name of a storage. ```APIDOC ## TVPGetLocalName ### Description Retrieves the local name of a storage. ### Function Signature `void ::TVPGetLocalName(ttstr &)` ### Parameters - **name** (ttstr&) - Required - Output local name. ### Return Value - None ``` -------------------------------- ### TJSCreateNativeClassProperty Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a native class property object with getter and setter callbacks. ```APIDOC ## TJSCreateNativeClassProperty ### Description Creates a native class property object with getter and setter callbacks. ### Function Signature `tTJSNativeClassProperty * ::TJSCreateNativeClassProperty(tTJSNativeClassPropertyGetCallback, tTJSNativeClassPropertySetCallback)` ### Parameters - **get_callback** (tTJSNativeClassPropertyGetCallback) - Required - Getter callback. - **set_callback** (tTJSNativeClassPropertySetCallback) - Required - Setter callback. ### Return Value - **tTJSNativeClassProperty\*** - New property object. ``` -------------------------------- ### TVPUnregisterStorageMedia Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Unregisters a storage media handler. ```APIDOC ## TVPUnregisterStorageMedia ### Description Unregisters a storage media handler. ### Function Signature `void ::TVPUnregisterStorageMedia(iTVPStorageMedia *)` ### Parameters - **media** (iTVPStorageMedia*) - Required - Storage media handler. ### Return Value - None ``` -------------------------------- ### TVPWideCharToUtf8String Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a wide character string to UTF-8. ```APIDOC ## TVPWideCharToUtf8String ### Description Converts a wide character string to UTF-8. ### Function Signature `tjs_int ::TVPWideCharToUtf8String(const tjs_char *, char *)` ### Parameters - **src** (const tjs_char*) - Required - Source wide string. - **dest** (char*) - Required - Destination buffer. ### Return Value - **tjs_int** - Number of bytes written. ``` -------------------------------- ### TJSAlignedAlloc / TJSAlignedDealloc Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Allocates and deallocates memory with alignment. ```APIDOC ## TJSAlignedAlloc ### Description Allocates memory with the specified alignment. ### Function Signature `void * ::TJSAlignedAlloc(tjs_uint, tjs_uint)` ### Parameters - **size** (tjs_uint) - Required - Size in bytes. - **alignment** (tjs_uint) - Required - Alignment requirement. ### Return Value - **void\*** - Pointer to aligned memory. ## TJSAlignedDealloc ### Description Frees memory allocated with TJSAlignedAlloc. ### Function Signature `void ::TJSAlignedDealloc(void *)` ### Parameters - **ptr** (void*) - Required - Pointer to memory to free. ### Return Value - None ``` -------------------------------- ### TVPIsExistentStorageNoSearchNoNormalize Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Checks if a storage exists without searching or normalizing the name. ```APIDOC ## TVPIsExistentStorageNoSearchNoNormalize ### Description Checks if a storage exists without searching or normalizing the name. ### Function Signature `bool ::TVPIsExistentStorageNoSearchNoNormalize(const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. ### Return Value - **bool** - True if exists. ``` -------------------------------- ### TJSFormatString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Formats a string using printf-style formatting with variant arguments. ```APIDOC ## TJSFormatString ### Description Formats a string using printf-style formatting with variant arguments. ### Function Signature `tTJSVariantString * ::TJSFormatString(const tjs_char *, tjs_uint, tTJSVariant * *)` ### Parameters - **format** (const tjs_char*) - Required - Format string. - **count** (tjs_uint) - Required - Number of arguments. - **args** (tTJSVariant**) - Required - Array of variant arguments. ### Return Value - **tTJSVariantString\*** - Formatted string. ``` -------------------------------- ### TVPNormalizeStorageName Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Normalizes a storage name. ```APIDOC ## TVPNormalizeStorageName ### Description Normalizes a storage name. ### Function Signature `ttstr ::TVPNormalizeStorageName(const ttstr &)` ### Parameters - **name** (const ttstr&) - Required - Storage name. ### Return Value - **ttstr** - Normalized name. ``` -------------------------------- ### TVPUtf8ToWideCharString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a UTF-8 string to wide characters. ```APIDOC ## TVPUtf8ToWideCharString ### Description Converts a UTF-8 string to wide characters. ### Function Signature `tjs_int ::TVPUtf8ToWideCharString(const char *, tjs_char *)` ### Parameters - **src** (const char*) - Required - Source UTF-8 string. - **dest** (tjs_char*) - Required - Destination buffer. ### Return Value - **tjs_int** - Number of characters written. ``` -------------------------------- ### TVPRemoveAutoPath Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Removes an automatic search path. ```APIDOC ## TVPRemoveAutoPath ### Description Removes an automatic search path. ### Function Signature `void ::TVPRemoveAutoPath(const ttstr &)` ### Parameters - **path** (const ttstr&) - Required - Path to remove. ### Return Value - None ``` -------------------------------- ### TJSCreateDictionaryObject Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a new dictionary object. ```APIDOC ## TJSCreateDictionaryObject ### Description Creates a new dictionary object. ### Function Signature `iTJSDispatch2 * ::TJSCreateDictionaryObject(iTJSDispatch2 * *)` ### Parameters - **out** (iTJSDispatch2**) - Required - Output pointer to the new dictionary object. ### Return Value - **iTJSDispatch2\*** - The new dictionary object. ``` -------------------------------- ### TJSAllocVariantOctet (multiple overloads) Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Allocates a variant octet from various input types. ```APIDOC ## TJSAllocVariantOctet ### Description Allocates a variant octet from various input types. ### Function Signatures - `tTJSVariantOctet * ::TJSAllocVariantOctet(const tjs_uint8 *, tjs_uint)` - `tTJSVariantOctet * ::TJSAllocVariantOctet(const tjs_uint8 *, tjs_uint, const tjs_uint8 *, tjs_uint)` - `tTJSVariantOctet * ::TJSAllocVariantOctet(const tTJSVariantOctet *, const tTJSVariantOctet *)` - `tTJSVariantOctet * ::TJSAllocVariantOctet(const tjs_uint8 * *)` ### Parameters - **data** (const tjs_uint8*) - Required - Byte data. - **len** (tjs_uint) - Required - Length. - **data2** (const tjs_uint8*) - Optional - Additional data. - **len2** (tjs_uint) - Optional - Additional length. - **octet1** (const tTJSVariantOctet*) - Required - First octet. - **octet2** (const tTJSVariantOctet*) - Required - Second octet. ### Return Value - **tTJSVariantOctet\*** - New octet. ``` -------------------------------- ### TJSDoRehash Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Performs a rehash of internal hash tables. ```APIDOC ## TJSDoRehash ### Description Performs a rehash of internal hash tables. ### Function Signature `void ::TJSDoRehash()` ### Parameters - None ### Return Value - None ``` -------------------------------- ### TJSMapGlobalStringMap Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Maps a string using the global string map. ```APIDOC ## TJSMapGlobalStringMap ### Description Maps a string using the global string map. ### Function Signature `ttstr ::TJSMapGlobalStringMap(const ttstr &)` ### Parameters - **str** (const ttstr&) - Required - String to map. ### Return Value - **ttstr** - Mapped string. ``` -------------------------------- ### TVPAreEventsInQueue Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Checks if there are events in the queue matching the criteria. ```APIDOC ## TVPAreEventsInQueue ### Description Checks if there are events in the queue matching the criteria. ### Function Signature `bool ::TVPAreEventsInQueue(iTJSDispatch2 *, iTJSDispatch2 *, const ttstr &, tjs_uint32)` ### Parameters - **dest** (iTJSDispatch2*) - Required - Destination object. - **sender** (iTJSDispatch2*) - Required - Sender object. - **event** (const ttstr&) - Required - Event name. - **tag** (tjs_uint32) - Required - Event tag. ### Return Value - **bool** - True if events exist. ``` -------------------------------- ### operator+ (tjs_char*, tTJSString&) Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Concatenates a C-style string with a tTJSString. ```APIDOC ## operator+ (tjs_char*, tTJSString&) ### Description Concatenates a C-style string with a tTJSString. ### Function Signature `tTJSString ::operator +(const tjs_char *, const tTJSString &)` ### Parameters - **lhs** (const tjs_char*) - Required - Left-hand side string. - **rhs** (const tTJSString&) - Required - Right-hand side string. ### Return Value - **tTJSString** - Concatenated string. ``` -------------------------------- ### TVPBreathe Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Performs a breathing operation (yields to system). ```APIDOC ## TVPBreathe ### Description Performs a breathing operation (yields to system). ### Function Signature `void ::TVPBreathe()` ### Parameters - None ### Return Value - None ``` -------------------------------- ### TVPCountEventsInQueue Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Counts events in the queue matching the criteria. ```APIDOC ## TVPCountEventsInQueue ### Description Counts events in the queue matching the criteria. ### Function Signature `tjs_int ::TVPCountEventsInQueue(iTJSDispatch2 *, iTJSDispatch2 *, const ttstr &, tjs_uint32)` ### Parameters - **dest** (iTJSDispatch2*) - Required - Destination object. - **sender** (iTJSDispatch2*) - Required - Sender object. - **event** (const ttstr&) - Required - Event name. - **tag** (tjs_uint32) - Required - Event tag. ### Return Value - **tjs_int** - Number of events. ``` -------------------------------- ### TJSNativeClassRegisterNCM Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Registers a native class method or property with the given class. ```APIDOC ## TJSNativeClassRegisterNCM ### Description Registers a native class method or property with the given class. ### Function Signature `void ::TJSNativeClassRegisterNCM(tTJSNativeClass *, const tjs_char *, iTJSDispatch2 *, const tjs_char *, tTJSNativeInstanceType, tjs_uint32)` ### Parameters - **cls** (tTJSNativeClass*) - Required - The native class. - **name** (const tjs_char*) - Required - Member name. - **member** (iTJSDispatch2*) - Required - Member object. - **instance_type** (const tjs_char*) - Required - Instance type name. - **type** (tTJSNativeInstanceType) - Required - Instance type. - **flags** (tjs_uint32) - Required - Flags. ### Return Value - None ``` -------------------------------- ### TJSRealToString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a real number to a string. ```APIDOC ## TJSRealToString ### Description Converts a real number to a string. ### Function Signature `tTJSVariantString * ::TJSRealToString(tjs_real)` ### Parameters - **value** (tjs_real) - Required - Real number. ### Return Value - **tTJSVariantString\*** - String representation. ``` -------------------------------- ### TJSCreateArrayObject Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Creates a new array object. ```APIDOC ## TJSCreateArrayObject ### Description Creates a new array object. ### Function Signature `iTJSDispatch2 * ::TJSCreateArrayObject(iTJSDispatch2 * *)` ### Parameters - **out** (iTJSDispatch2**) - Required - Output pointer to the new array object. ### Return Value - **iTJSDispatch2\*** - The new array object. ``` -------------------------------- ### TJSOctetToListString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts an octet to a list string representation. ```APIDOC ## TJSOctetToListString ### Description Converts an octet to a list string representation. ### Function Signature `tTJSVariantString * ::TJSOctetToListString(const tTJSVariantOctet *)` ### Parameters - **octet** (const tTJSVariantOctet*) - Required - Octet to convert. ### Return Value - **tTJSVariantString\*** - List string. ``` -------------------------------- ### TJSGetFPClass Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns the floating-point class of a real number. ```APIDOC ## TJSGetFPClass ### Description Returns the floating-point class of a real number. ### Function Signature `tjs_uint32 ::TJSGetFPClass(tjs_real)` ### Parameters - **value** (tjs_real) - Required - The real number. ### Return Value - **tjs_uint32** - FP class flags. ``` -------------------------------- ### TJSRegisterNativeClass Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Registers a native class by name and returns its class ID. ```APIDOC ## TJSRegisterNativeClass ### Description Registers a native class by name and returns its class ID. ### Function Signature `tjs_int32 ::TJSRegisterNativeClass(const tjs_char *)` ### Parameters - **name** (const tjs_char*) - Required - Class name. ### Return Value - **tjs_int32** - Class ID. ``` -------------------------------- ### TJSStringToReal Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a string to a real number. ```APIDOC ## TJSStringToReal ### Description Converts a string to a real number. ### Function Signature `tTVReal ::TJSStringToReal(const tjs_char *)` ### Parameters - **str** (const tjs_char*) - Required - String to convert. ### Return Value - **tTVReal** - Real value. ``` -------------------------------- ### TVPSetSystemEventDisabledState Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Sets whether system events are disabled. ```APIDOC ## TVPSetSystemEventDisabledState ### Description Sets whether system events are disabled. ### Function Signature `void ::TVPSetSystemEventDisabledState(bool)` ### Parameters - **disabled** (bool) - Required - True to disable. ### Return Value - None ``` -------------------------------- ### TJSInt32ToHex Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts an integer to a hexadecimal string. ```APIDOC ## TJSInt32ToHex ### Description Converts an integer to a hexadecimal string. ### Function Signature `tTJSString ::TJSInt32ToHex(tjs_uint32, int)` ### Parameters - **value** (tjs_uint32) - Required - Integer value. - **digits** (int) - Required - Minimum number of digits. ### Return Value - **tTJSString** - Hexadecimal string. ``` -------------------------------- ### TVPCancelEventsByTag Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Cancels events with the given tag. ```APIDOC ## TVPCancelEventsByTag ### Description Cancels events with the given tag. ### Function Signature `void ::TVPCancelEventsByTag(iTJSDispatch2 *, iTJSDispatch2 *, tjs_uint32)` ### Parameters - **dest** (iTJSDispatch2*) - Required - Destination object. - **sender** (iTJSDispatch2*) - Required - Sender object. - **tag** (tjs_uint32) - Required - Event tag. ### Return Value - None ``` -------------------------------- ### TVPCancelSourceEvents Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Cancels all events from a given source. ```APIDOC ## TVPCancelSourceEvents ### Description Cancels all events from a given source. ### Function Signature `void ::TVPCancelSourceEvents(iTJSDispatch2 *)` ### Parameters - **sender** (iTJSDispatch2*) - Required - Sender object. ### Return Value - None ``` -------------------------------- ### TJSIntegerToString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts an integer to a string. ```APIDOC ## TJSIntegerToString ### Description Converts an integer to a string. ### Function Signature `tTJSVariantString * ::TJSIntegerToString(tjs_int64)` ### Parameters - **value** (tjs_int64) - Required - Integer value. ### Return Value - **tTJSVariantString\*** - String representation. ``` -------------------------------- ### TVPCancelEvents Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Cancels events matching the given criteria. ```APIDOC ## TVPCancelEvents ### Description Cancels events matching the given criteria. ### Function Signature `tjs_int ::TVPCancelEvents(iTJSDispatch2 *, iTJSDispatch2 *, const ttstr &, tjs_uint32)` ### Parameters - **dest** (iTJSDispatch2*) - Required - Destination object. - **sender** (iTJSDispatch2*) - Required - Sender object. - **event** (const ttstr&) - Required - Event name. - **tag** (tjs_uint32) - Required - Event tag. ### Return Value - **tjs_int** - Number of events cancelled. ``` -------------------------------- ### TJSGetMessageMapMessage Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Retrieves a message from the message map. ```APIDOC ## TJSGetMessageMapMessage ### Description Retrieves a message from the message map. ### Function Signature `ttstr ::TJSGetMessageMapMessage(const tjs_char *)` ### Parameters - **key** (const tjs_char*) - Required - Message key. ### Return Value - **ttstr** - Message string. ``` -------------------------------- ### TJSAllocVariantString (multiple overloads) Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Allocates a tTJSVariantString from various input types, including wide strings, narrow strings, and byte arrays. ```APIDOC ## TJSAllocVariantString ### Description Allocates a tTJSVariantString from various input types, including wide strings, narrow strings, and byte arrays. ### Function Signatures - `tTJSVariantString * ::TJSAllocVariantString(const tjs_char *, const tjs_char *)` - `tTJSVariantString * ::TJSAllocVariantString(const tjs_char *, tjs_int)` - `tTJSVariantString * ::TJSAllocVariantString(const tjs_char *)` - `tTJSVariantString * ::TJSAllocVariantString(const tjs_nchar *)` - `tTJSVariantString * ::TJSAllocVariantString(const tjs_uint8 * *)` ### Parameters - **str** (const tjs_char*) - Required - Wide character string. - **len** (tjs_int) - Optional - Length of the string. - **str** (const tjs_nchar*) - Required - Narrow character string. - **data** (const tjs_uint8**) - Required - Pointer to byte array. ### Return Value - **tTJSVariantString\*** - Newly allocated variant string. ``` -------------------------------- ### TJSFindNativeClassName Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns the name of a native class given its class ID. ```APIDOC ## TJSFindNativeClassName ### Description Returns the name of a native class given its class ID. ### Function Signature `const tjs_char * ::TJSFindNativeClassName(tjs_int32)` ### Parameters - **id** (tjs_int32) - Required - Class ID. ### Return Value - **const tjs_char\*** - Class name. ``` -------------------------------- ### TJSRealToHexString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a real number to a hexadecimal string. ```APIDOC ## TJSRealToHexString ### Description Converts a real number to a hexadecimal string. ### Function Signature `tTJSVariantString * ::TJSRealToHexString(tjs_real)` ### Parameters - **value** (tjs_real) - Required - Real number. ### Return Value - **tTJSVariantString\*** - Hexadecimal string. ``` -------------------------------- ### TJSCopyArrayElementTo Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Copies an element from an array to a variant. ```APIDOC ## TJSCopyArrayElementTo ### Description Copies an element from an array to a variant. ### Function Signature `tjs_int ::TJSCopyArrayElementTo(iTJSDispatch2 *, tTJSVariant *, tjs_uint, tjs_int)` ### Parameters - **array** (iTJSDispatch2*) - Required - Array object. - **dest** (tTJSVariant*) - Required - Destination variant. - **index** (tjs_uint) - Required - Element index. - **flags** (tjs_int) - Required - Flags. ### Return Value - **tjs_int** - Result code. ``` -------------------------------- ### TJSObjectToString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts an object closure to a string representation. ```APIDOC ## TJSObjectToString ### Description Converts an object closure to a string representation. ### Function Signature `tTJSVariantString * ::TJSObjectToString(const tTJSVariantClosure &)` ### Parameters - **obj** (const tTJSVariantClosure&) - Required - Object closure. ### Return Value - **tTJSVariantString\*** - String representation. ``` -------------------------------- ### TJSDoVariantOperation Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Performs a variant operation (e.g., arithmetic) on variants. ```APIDOC ## TJSDoVariantOperation ### Description Performs a variant operation (e.g., arithmetic) on variants. ### Function Signature `void ::TJSDoVariantOperation(tjs_int, tTJSVariant &, const tTJSVariant *)` ### Parameters - **op** (tjs_int) - Required - Operation code. - **result** (tTJSVariant&) - Required - Result variant. - **operands** (const tTJSVariant*) - Required - Array of operands. ### Return Value - None ``` -------------------------------- ### TJSVS_free Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Frees a buffer previously allocated with TJSVS_malloc or TJSVS_realloc. ```APIDOC ## TJSVS_free ### Description Frees a buffer previously allocated with TJSVS_malloc or TJSVS_realloc. ### Function Signature `void ::TJSVS_free(tjs_char *)` ### Parameters - **ptr** (tjs_char*) - Required - Pointer to the buffer to free. ### Return Value - None ``` -------------------------------- ### TJSGetArrayElementCount Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns the number of elements in an array object. ```APIDOC ## TJSGetArrayElementCount ### Description Returns the number of elements in an array object. ### Function Signature `tjs_int ::TJSGetArrayElementCount(iTJSDispatch2 *)` ### Parameters - **array** (iTJSDispatch2*) - Required - Array object. ### Return Value - **tjs_int** - Element count. ``` -------------------------------- ### TJSAllocVariantStringBuffer Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Allocates a variant string buffer of the specified size. ```APIDOC ## TJSAllocVariantStringBuffer ### Description Allocates a variant string buffer of the specified size. ### Function Signature `tTJSVariantString * ::TJSAllocVariantStringBuffer(tjs_uint)` ### Parameters - **len** (tjs_uint) - Required - Buffer size in characters. ### Return Value - **tTJSVariantString\*** - Pointer to the allocated buffer. ``` -------------------------------- ### TVPGetSystemEventDisabledState Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns whether system events are disabled. ```APIDOC ## TVPGetSystemEventDisabledState ### Description Returns whether system events are disabled. ### Function Signature `bool ::TVPGetSystemEventDisabledState()` ### Parameters - None ### Return Value - **bool** - True if disabled. ``` -------------------------------- ### TVPGetBreathing Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Returns whether breathing is enabled. ```APIDOC ## TVPGetBreathing ### Description Returns whether breathing is enabled. ### Function Signature `bool ::TVPGetBreathing()` ### Parameters - None ### Return Value - **bool** - True if breathing is enabled. ``` -------------------------------- ### TJSVariantToExpressionString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a variant to a string that represents a TJS expression. ```APIDOC ## TJSVariantToExpressionString ### Description Converts a variant to a string that represents a TJS expression. ### Function Signature `tTJSString ::TJSVariantToExpressionString(const tTJSVariant &)` ### Parameters - **v** (const tTJSVariant&) - Required - The variant to convert. ### Return Value - **tTJSString** - Expression string. ``` -------------------------------- ### TJSFindNativeClassID Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Finds the class ID for a registered native class by name. ```APIDOC ## TJSFindNativeClassID ### Description Finds the class ID for a registered native class by name. ### Function Signature `tjs_int32 ::TJSFindNativeClassID(const tjs_char *)` ### Parameters - **name** (const tjs_char*) - Required - Class name. ### Return Value - **tjs_int32** - Class ID, or -1 if not found. ``` -------------------------------- ### TJSDeallocVariantOctet Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Deallocates a variant octet. ```APIDOC ## TJSDeallocVariantOctet ### Description Deallocates a variant octet. ### Function Signature `void ::TJSDeallocVariantOctet(tTJSVariantOctet *)` ### Parameters - **octet** (tTJSVariantOctet*) - Required - Octet to deallocate. ### Return Value - None ``` -------------------------------- ### TJSStringToInteger Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a string to an integer. ```APIDOC ## TJSStringToInteger ### Description Converts a string to an integer. ### Function Signature `tTVInteger ::TJSStringToInteger(const tjs_char *)` ### Parameters - **str** (const tjs_char*) - Required - String to convert. ### Return Value - **tTVInteger** - Integer value. ``` -------------------------------- ### TJSVS_malloc Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Allocates a buffer of tjs_char elements. Returns a pointer to the allocated memory. ```APIDOC ## TJSVS_malloc ### Description Allocates a buffer of tjs_char elements. Returns a pointer to the allocated memory. ### Function Signature `tjs_char * ::TJSVS_malloc(tjs_uint)` ### Parameters - **count** (tjs_uint) - Required - Number of tjs_char elements to allocate. ### Return Value - **tjs_char\*** - Pointer to the allocated buffer. ``` -------------------------------- ### TJSVariantToReadableString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a variant to a human-readable string representation. ```APIDOC ## TJSVariantToReadableString ### Description Converts a variant to a human-readable string representation. ### Function Signature `tTJSString ::TJSVariantToReadableString(const tTJSVariant &, tjs_int)` ### Parameters - **v** (const tTJSVariant&) - Required - The variant to convert. - **indent** (tjs_int) - Required - Indentation level. ### Return Value - **tTJSString** - Readable string. ``` -------------------------------- ### TJSAppendVariantString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Appends a string to an existing variant string and returns the new string. ```APIDOC ## TJSAppendVariantString ### Description Appends a string to an existing variant string and returns the new string. ### Function Signatures - `tTJSVariantString * ::TJSAppendVariantString(tTJSVariantString *, const tjs_char *)` - `tTJSVariantString * ::TJSAppendVariantString(tTJSVariantString *, const tTJSVariantString *)` ### Parameters - **base** (tTJSVariantString*) - Required - The base string to append to. - **append** (const tjs_char* or const tTJSVariantString*) - Required - The string to append. ### Return Value - **tTJSVariantString\*** - New string with appended content. ``` -------------------------------- ### TJSVS_realloc Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Reallocates a buffer of tjs_char elements to a new size. Returns a pointer to the resized memory. ```APIDOC ## TJSVS_realloc ### Description Reallocates a buffer of tjs_char elements to a new size. Returns a pointer to the resized memory. ### Function Signature `tjs_char * ::TJSVS_realloc(tjs_char *, tjs_uint)` ### Parameters - **ptr** (tjs_char*) - Required - Pointer to the existing buffer. - **count** (tjs_uint) - Required - New size in tjs_char elements. ### Return Value - **tjs_char\*** - Pointer to the reallocated buffer. ``` -------------------------------- ### TJSNativeClassSetClassID Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Sets the class ID for a native class. ```APIDOC ## TJSNativeClassSetClassID ### Description Sets the class ID for a native class. ### Function Signature `void ::TJSNativeClassSetClassID(tTJSNativeClass *, tjs_int32)` ### Parameters - **cls** (tTJSNativeClass*) - Required - The native class. - **id** (tjs_int32) - Required - Class ID. ### Return Value - None ``` -------------------------------- ### TJSVariantTypeToTypeString Source: https://github.com/arcusmaximus/kirikiritools/blob/master/TJS functions.txt Converts a variant type enum to its string representation. ```APIDOC ## TJSVariantTypeToTypeString ### Description Converts a variant type enum to its string representation. ### Function Signature `const tjs_char * ::TJSVariantTypeToTypeString(tTJSVariantType)` ### Parameters - **type** (tTJSVariantType) - Required - The variant type. ### Return Value - **const tjs_char\*** - String representation of the type. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.