Difference between revisions of "Compiled Index of Lua Scripts for Visionaire Studio"
From The Official Visionaire Studio: Adventure Game Engine Wiki
(→Advanced) |
|||
(83 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | Here you can find a list of ''verified'' working Lua scripts made by various members of the Visionaire Studio team & forum community. | + | Here you can find a list of ''verified'' working Lua scripts made by various members of the Visionaire Studio team & forum community. Also included is a list of workflow functions, shader functions & standard Visionaire Studio functions. |
− | == Basic == | + | |
− | {| class=" | + | == Community Made Scripts == |
+ | === Basic === | ||
+ | {| class="ts sortable" | ||
|- | |- | ||
! style="text-align:left" | Script Name | ! style="text-align:left" | Script Name | ||
! style="text-align:left;width:10%" | By | ! style="text-align:left;width:10%" | By | ||
|- | |- | ||
− | | | + | | [[Chained_Volume_Control_(CMS)|Chained Volume Control (music vs speech)]] |
− | + | | style="width:10%" | AFRLme | |
− | |||
− | | | ||
− | |||
|- | |- | ||
− | | | + | | [[Mute/Restore_Volume_(CMS)|Mute/Restore Volume]] || AFRLme |
|} | |} | ||
− | == Intermediate == | + | === Intermediate === |
− | {| class=" | + | {| class="ts sortable" |
|- | |- | ||
! style="text-align:left" | Script Name | ! style="text-align:left" | Script Name | ||
! style="text-align:left;width:10%" | By | ! style="text-align:left;width:10%" | By | ||
|- | |- | ||
− | | [[ | + | | [[Cycle_Inventory_Items_(CMS)|Cycle Inventory Items]] |
− | | style="width:10%" | | + | | style="width:10%" | AFRLme |
+ | |- | ||
+ | | [[Dynamic_Action_Names_(CMS)|Dynamic Action Names]] || AFRLme | ||
|- | |- | ||
− | | [[ | + | | [[Global_Command_Checker_(CMS)|Global Command Checker]] || AFRLme |
+ | |- | ||
+ | | [[High_Score_Display_(CMS)|High Score Display (updated ''via'' function)]] || AFRLme | ||
+ | |- | ||
+ | | [[Insert_Item_(CMS)|Insert Item]] || AFRLme | ||
+ | |- | ||
+ | | [[Kill_Background_Text_(CMS)|Kill Background Text (multiple options)]] || AFRLme | ||
+ | |- | ||
+ | | [[How_to_Load_External_Scripts_Into_Visionaire_Studio_(CMS)|Load External Scripts]] || Divo | ||
|- | |- | ||
| [[Organize_Inventory_Items_Alphabetically_(CMS)|Organize Inventory Items Alphabetically]] || AFRLme | | [[Organize_Inventory_Items_Alphabetically_(CMS)|Organize Inventory Items Alphabetically]] || AFRLme | ||
|- | |- | ||
− | | | + | | [[Percentage_Display_(CMS)|Percentage Display (updated ''via'' function)]] || AFRLme |
+ | |- | ||
+ | | [[Replace_Item_(CMS)|Replace Item]] || AFRLme | ||
+ | |- | ||
+ | | [[Sliding_Interface_MKII_(CMS)|Sliding Interface MKII (VS4+)]] || AFRLme | ||
|} | |} | ||
− | == Advanced == | + | === Advanced === |
− | {| class=" | + | {| class="ts sortable" |
|- | |- | ||
! style="text-align:left" | Script Name | ! style="text-align:left" | Script Name | ||
! style="text-align:left;width:10%" | By | ! style="text-align:left;width:10%" | By | ||
+ | |- | ||
+ | | [[Read/Write_Config.ini_(CMS)|Config.ini (read/write)]] || AFRLme | ||
|- | |- | ||
| [[Dynamic_Action_Names_for_Dragged_Items_(CMS)|Dynamic Action Names for Dragged Items]] || AFRLme | | [[Dynamic_Action_Names_for_Dragged_Items_(CMS)|Dynamic Action Names for Dragged Items]] || AFRLme | ||
|- | |- | ||
− | | [[ | + | | [[Dynamic_Loop_Handler_(CMS)|Dynamic Loop Handler (control delay & loop amount)]] || AFRLme |
+ | |- | ||
+ | | [[Dynamic_Sound_(CMS)|Dynamic Sound (based on current character position)]] || AFRLme | ||
+ | |- | ||
+ | | [[Deponia_Based_Sliding_Interface_(CMS)|Sliding Interfaces (based on Deponia)]] || AFRLme | ||
+ | |- | ||
+ | | [[Sliding_Puzzle_(CMS)|Sliding Puzzle (3x3)]] || AFRLme | ||
+ | |- | ||
+ | | [[Volume_Control_Basic_Version_(CMS)|Volume Control (rail, button, percentage)]] || AFRLme | ||
+ | |} | ||
+ | |||
+ | |||
+ | == Math Functions == | ||
+ | {| class="ts sortable" style="width:100%" | ||
+ | |- | ||
+ | ! style="text-align:left" | Function Name | ||
+ | ! style="text-align:left;width:80%" class="unsortable" | Description | ||
+ | |- | ||
+ | | [[SecondsToTime_(CMS)|secondsToTime()]] || Convert seconds to dd:hh:mm:ss time format. | ||
+ | |- | ||
+ | | [[SecondsToDays_(CMS)|secondsToDays()]] || Convert seconds to dd time format. | ||
+ | |- | ||
+ | | [[SecondsToHours_(CMS)|secondsToHours()]] || Convert seconds to hh time format. | ||
+ | |- | ||
+ | | [[SecondsToMinutes_(CMS)|secondsToMinutes()]] || Convert seconds to mm time format. | ||
+ | |- | ||
+ | | [[SecondsToSeconds_(CMS)|secondsToSeconds()]] || Convert seconds to ss time format. | ||
+ | |} | ||
+ | |||
+ | |||
+ | == Shader Toolkit == | ||
+ | {| class="ts" | ||
+ | |- | ||
+ | ! style="text-align:left" | Script Name | ||
+ | ! style="text-align:left;width:10%" | By | ||
+ | |- | ||
+ | | [[Shader_(CMS)|Shader Toolkit]] || SimonS | ||
+ | |} | ||
+ | === Shader Toolkit Functions === | ||
+ | {| class="ts sortable" | ||
+ | |- | ||
+ | ! style="text-align:left" | Function Name | ||
+ | ! style="text-align:left;width:80%" class="unsortable" | Description | ||
+ | |- | ||
+ | | [[ShaderAddEffect_(CMS)|shaderAddEffect()]] || Add various dynamic pre-made warp effects to the screen. | ||
+ | |- | ||
+ | | [[ShaderBlur_(CMS)|shaderBlur()]] || Blur/Focus the screen over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderColorize_(CMS)|shaderColorize()]] || Tint all the graphics on the screen a specific color over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderContrast_(CMS)|shaderContrast()]] || Set the global contrast level of the screen over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderFollowCharacter_(CMS)|shaderFollowCharacter()]] || Softly follow the linked character around the screen. | ||
+ | |- | ||
+ | | [[ShaderGlow_(CMS)|shaderGlow()]] || Create a glow effect on light/saturated scene objects (automatically selected) over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderHue_(CMS)|shaderHue()]] || Adjust the hue level of the screen over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderLightness_(CMS)|shaderLightness()]] || Adjust the lightness of the screen over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderNoise_(CMS)|shaderNoise()]] || Apply noise effect to the screen over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderPan_(CMS)|shaderPan()]] || Pan the camera on the x or y axis over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderRotate_(CMS)|shaderRotate()]] || Rotate the screen over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderSaturation_(CMS)|shaderSaturation()]] || Adjust saturation value of the screen over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderViewport_(CMS)|shaderViewport()]] || Pan, zoom & rotate the camera over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ShaderZoom_(CMS)|shaderZoom()]] || Zoom the camera over x amount of milliseconds. | ||
|- | |- | ||
− | | | + | | [[ShaderZoomCharacter_(CMS)|shaderZoomCharacter()]] || Zoom camera into or out of linked characters position over x amount of milliseconds. |
+ | |- | ||
+ | | [[ShaderZoomObject_(CMS)|shaderZoomObject()]] || Zoom camera into or out of linked objects location over x amount of milliseconds. | ||
|} | |} | ||
+ | |||
== Visionaire Studio Functions == | == Visionaire Studio Functions == | ||
− | {| class=" | + | {| class="ts sortable" |
|- | |- | ||
! style="text-align:left" | Function Name | ! style="text-align:left" | Function Name | ||
− | ! style="text-align:left;width:80%" | Description | + | ! style="text-align:left;width:80%" class="unsortable" | Description |
|- | |- | ||
| [[CreateScreenshot_(CMS)|createScreenshot()]] || Create a screenshot & save as .png to a specified folder or use the screenshot for the save game thumbnail. | | [[CreateScreenshot_(CMS)|createScreenshot()]] || Create a screenshot & save as .png to a specified folder or use the screenshot for the save game thumbnail. | ||
|- | |- | ||
− | | [[GetCursorPos_(CMS)|getCursorPos()]] || Retrieves the current(''absolute'') position of the mouse cursor. | + | | [[GetBool_(CMS)|getBool()]] || Retrieve boolean value of the linked object. |
+ | |- | ||
+ | | [[GetCursorPos_(CMS)|getCursorPos()]] || Retrieves the current (''absolute'') position of the mouse cursor. | ||
+ | |- | ||
+ | | [[GetFloat_(CMS)|getFloat()]] || Retrieve the float value of the linked object. | ||
+ | |- | ||
+ | | [[GetFloats_(CMS)|getFloats()]] || Retrieve the float values of the linked objects data table. | ||
+ | |- | ||
+ | | [[GetId_(CMS)|getId()]] || Retrieve the table id or table id name of the linked object. | ||
+ | |- | ||
+ | | [[GetInt_(CMS)|getInt()]] || Retrieve the integer value of the linked object. | ||
+ | |- | ||
+ | | [[GetInts_(CMS)|getInts()]] || Retrieve the integer values of the linked objects data table. | ||
+ | |- | ||
+ | | [[GetLink_(CMS)|getLink()]] || Retrieves the data stored inside of a linked objects table. | ||
+ | |- | ||
+ | | [[GetLinks_(CMS)|getLinks()]] || Retrieves grouped data stored inside of a linked objects table. | ||
|- | |- | ||
| [[GetName_(CMS)|getName()]] || Returns the "string" name value of the linked objects table. | | [[GetName_(CMS)|getName()]] || Returns the "string" name value of the linked objects table. | ||
Line 59: | Line 163: | ||
| [[GetObject_(CMS)|getObject()]] || Retrieves the data stored inside of a linked objects table. | | [[GetObject_(CMS)|getObject()]] || Retrieves the data stored inside of a linked objects table. | ||
|- | |- | ||
− | | [[ | + | | [[GetParent_(CMS)|getParent()]] || Retrieves the parent object which contains the linked object. (only ''game objects'' contain no parent) |
|- | |- | ||
− | | [[ | + | | [[GetPath_(CMS)|getPath()]] || Retrieves path (directory in unix format) of linked object. (images, videos, sounds etc) |
|- | |- | ||
− | | [[ | + | | [[GetPaths_(CMS)|getPaths()]] || Retrieves multiple paths (directories in unix format) of linked object data table. (images, videos, sounds etc) |
|- | |- | ||
− | | [[ | + | | [[GetPoint_(CMS)|getPoint()]] || Retrieves the x,y coordinates associated with the linked object. |
|- | |- | ||
− | | [[ | + | | [[GetPoints_(CMS)|getPoints()]] || Retrieves multiple x,y coordinates associated with the linked objects data table. |
|- | |- | ||
− | | [[ | + | | [[GetProperty_(CMS)|getProperty()]] || Retrieve various operating system (os) properties; such as: platform, system language etc... |
|- | |- | ||
− | | [[ | + | | [[GetSoundId_(CMS)|getSoundId()]] || Retrieve id of linked sound. (only applicable for active sounds) |
|- | |- | ||
− | | [[ | + | | [[GetSoundProperty_(CMS)|getSoundProperty()]] || Retrieve various properties of linked sound, such as: current playtime, balance, volume, loop. (only applicable for active sounds) |
|- | |- | ||
− | | [[ | + | | [[GetSteamAchievement_(CMS)|getSteamAchievement]] || Retrieve boolean value of linked steam achievement. |
|- | |- | ||
− | | [[ | + | | [[GetSteamStat_(CMS)|getSteamStat]] || Retrieve integer value of linked steam stat. |
|- | |- | ||
− | | [[ | + | | [[GetTexts_(CMS)|getTexts()]] || Retrieve all texts associated with the linked object. |
|- | |- | ||
− | | [[ | + | | [[GetTextStr_(CMS)|getTextStr()]] || Retrieve a specific text string, based on the current game language or the included language id. |
|- | |- | ||
− | | [[ | + | | [[GetTime_(CMS)|getTime()]] || Developer command for checking time between 2 points; can be re-purposed into a crude delay or loop function. |
|- | |- | ||
− | | [[ | + | | [[GetVolume_(CMS)|getVolume()]] || Retrieve volume levels for: music, sound, speech, videos, & master. |
|- | |- | ||
− | | [[ | + | | [[GetWindowBrightness_(CMS)|getWindowBrightness()]] || Retrieve global window brightness value. |
|- | |- | ||
− | | [[ | + | | [[IsEmpty_(CMS)|isEmpty()]] || Returns true or false; depending on whether or not the linked object is empty. |
|- | |- | ||
− | | [[ | + | | [[RegisterEventHandler_(CMS)|registerEventHandler()]] || Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc... |
|- | |- | ||
− | | [[ | + | | [[RegisterHookFunction_(CMS)|registerHookFunction()]] || Set displayed & action text positions. |
|- | |- | ||
− | | [[ | + | | [[ResetSteamStats_(CMS)|resetSteamStats()]] || Reset the linked steam stat back to its default value. |
|- | |- | ||
− | | [[ | + | | [[SetCursorPos_(CMS)|setCursorPos()]] || Set the absolute position of the mouse cursor. |
|- | |- | ||
− | | [[ | + | | [[SetSoundProperty_(CMS)|setSoundProperty()]] || Set the properties of a linked sound, such as: current playtime position, balance, volume, loop (requires sound id) |
|- | |- | ||
− | | [[ | + | | [[SetSteamAchievement_(CMS)|setSteamAchievement()]] || Set the boolean value of the linked steam achievement. |
|- | |- | ||
− | | [[ | + | | [[SetSteamStat_(CMS)|setSteamStat()]] || Set the integer value of the linked steam stat. |
|- | |- | ||
− | | [[ | + | | [[SetValue_(CMS)|setValue()]] || Edit value of the linked object. (all data types) |
|- | |- | ||
− | | [[ | + | | [[SetVolume_(CMS)|setVolume()]] || Adjust the volume levels for: music, sound, speech, videos, & master. |
|- | |- | ||
− | | [[ | + | | [[SetWindowBrightness_(CMS)|setWindowBrightness()]] || Adjust the global window brightness value. |
|- | |- | ||
− | | [[ | + | | [[SetWindowTitle_(CMS)|setWindowTitle()]] || Set a custom title in the window application bar (only applicable for window mode) |
|- | |- | ||
− | | [[ | + | | [[StartAction_(CMS)|startAction()]] || Call & start the linked action. |
|- | |- | ||
− | | [[UnregisterEventHandler_(CMS)|unregisterEventHandler()]] || | + | | [[StartAnimation_(CMS)|startAnimation()]] || Play the linked animation. |
+ | |- | ||
+ | | [[StartDefaultBrowser_(CMS)|startDefaultBrowser]] || Launch default web browser & open the linked url in a new tab. (only launches browser if not already open) | ||
+ | |- | ||
+ | | [[StartSound_(CMS)|startSound()]] || Play the linked sound; additional properties can also be set such as: current playtime position, balance, volume, & loop. | ||
+ | |- | ||
+ | | [[StopAction_(CMS)|stopAction()]] || Stop the linked action. (only applicable for active actions) | ||
+ | |- | ||
+ | | [[StopAnimation_(CMS)|stopAnimation()]] || Stop & unload the linked action. (only applicable for active animations) | ||
+ | |- | ||
+ | | [[StopSound_(CMS)|stopSound()]] || Stop the linked sound; requires sound id. (only applicable for active sounds) | ||
+ | |- | ||
+ | | [[ToggleSoundPause_(CMS)|toggleSoundPause()]] || Toggle linked sound between playing & paused state; requires sound id. (only applicable for active sounds) | ||
+ | |- | ||
+ | | [[UnregisterEventHandler_(CMS)|unregisterEventHandler()]] || Unregister the linked event handler & function. | ||
|} | |} | ||
− | {{ | + | |
+ | |||
+ | == Workflow Functions == | ||
+ | {| class="ts sortable" | ||
+ | |- | ||
+ | ! style="text-align:left" | Function Name | ||
+ | ! style="text-align:left;width:80%" class="unsortable" | Description | ||
+ | |- | ||
+ | | [[AlignChar_(CMS)|alignChar()]] || Quickly align a character to another character. | ||
+ | |- | ||
+ | | [[AlignObj_(CMS)|alignObj()]] || Quickly align a character to a scene object. | ||
+ | |- | ||
+ | | [[ChangeOutfit_(CMS)|changeOutfit()]] || Quickly change the outfit of a character. | ||
+ | |- | ||
+ | | [[ChangeScene_(CMS)|changeScene()]] || Change to another scene with a specific transition effect, over a specified amount of time. | ||
+ | |- | ||
+ | | [[CheckCond_(CMS)|checkCond()]] || Quickly check the boolean value of a condition. | ||
+ | |- | ||
+ | | [[IsInRadius_(CMS)|isInRadius()]] || Quickly determine if mouse cursor is inside of a specified radius of an objects center or characters position. | ||
+ | |- | ||
+ | | [[MoveObj_(CMS)|moveObj()]] || Move an object from one position to another over x amount of milliseconds. | ||
+ | |- | ||
+ | | [[ObjName_(CMS)|objName()]] || Return the action text name of a specified object (returns active language name). | ||
+ | |- | ||
+ | | [[SetAnimFrames_(CMS)|setAnimFrames()]] || Quickly set the first & last frame of an active animation. | ||
+ | |- | ||
+ | | [[SetAnimSize_(CMS)|setAnimSize()]] || Quickly set the size of an active animation. | ||
+ | |- | ||
+ | | [[SetCondition_(CMS)|setCondition()]] || Quickly set the boolean value of a condition. | ||
+ | |- | ||
+ | | [[SetLang_(CMS)|setLang()]] || Quickly set the spoken language & subtitle language. | ||
+ | |- | ||
+ | | [[SetSceneBrightness_(CMS)|setSceneBrightness()]] || Quickly set the brightness/contrast level of a specific scene or the current scene. | ||
+ | |- | ||
+ | | [[setVal_(CMS)|setVal()]] || Quickly set the integer or string of a value. | ||
+ | |- | ||
+ | | [[ToggleCondition_(CMS)|toggleCondition()]] || Quickly toggle the boolean value of a condition. | ||
+ | |}{{toc}} |
Revision as of 14:13, 22 October 2017
Here you can find a list of verified working Lua scripts made by various members of the Visionaire Studio team & forum community. Also included is a list of workflow functions, shader functions & standard Visionaire Studio functions.
Community Made Scripts
Basic
Script Name | By |
---|---|
Chained Volume Control (music vs speech) | AFRLme |
Mute/Restore Volume | AFRLme |
Intermediate
Script Name | By |
---|---|
Cycle Inventory Items | AFRLme |
Dynamic Action Names | AFRLme |
Global Command Checker | AFRLme |
High Score Display (updated via function) | AFRLme |
Insert Item | AFRLme |
Kill Background Text (multiple options) | AFRLme |
Load External Scripts | Divo |
Organize Inventory Items Alphabetically | AFRLme |
Percentage Display (updated via function) | AFRLme |
Replace Item | AFRLme |
Sliding Interface MKII (VS4+) | AFRLme |
Advanced
Script Name | By |
---|---|
Config.ini (read/write) | AFRLme |
Dynamic Action Names for Dragged Items | AFRLme |
Dynamic Loop Handler (control delay & loop amount) | AFRLme |
Dynamic Sound (based on current character position) | AFRLme |
Sliding Interfaces (based on Deponia) | AFRLme |
Sliding Puzzle (3x3) | AFRLme |
Volume Control (rail, button, percentage) | AFRLme |
Math Functions
Function Name | Description |
---|---|
secondsToTime() | Convert seconds to dd:hh:mm:ss time format. |
secondsToDays() | Convert seconds to dd time format. |
secondsToHours() | Convert seconds to hh time format. |
secondsToMinutes() | Convert seconds to mm time format. |
secondsToSeconds() | Convert seconds to ss time format. |
Shader Toolkit
Script Name | By |
---|---|
Shader Toolkit | SimonS |
Shader Toolkit Functions
Function Name | Description |
---|---|
shaderAddEffect() | Add various dynamic pre-made warp effects to the screen. |
shaderBlur() | Blur/Focus the screen over x amount of milliseconds. |
shaderColorize() | Tint all the graphics on the screen a specific color over x amount of milliseconds. |
shaderContrast() | Set the global contrast level of the screen over x amount of milliseconds. |
shaderFollowCharacter() | Softly follow the linked character around the screen. |
shaderGlow() | Create a glow effect on light/saturated scene objects (automatically selected) over x amount of milliseconds. |
shaderHue() | Adjust the hue level of the screen over x amount of milliseconds. |
shaderLightness() | Adjust the lightness of the screen over x amount of milliseconds. |
shaderNoise() | Apply noise effect to the screen over x amount of milliseconds. |
shaderPan() | Pan the camera on the x or y axis over x amount of milliseconds. |
shaderRotate() | Rotate the screen over x amount of milliseconds. |
shaderSaturation() | Adjust saturation value of the screen over x amount of milliseconds. |
shaderViewport() | Pan, zoom & rotate the camera over x amount of milliseconds. |
shaderZoom() | Zoom the camera over x amount of milliseconds. |
shaderZoomCharacter() | Zoom camera into or out of linked characters position over x amount of milliseconds. |
shaderZoomObject() | Zoom camera into or out of linked objects location over x amount of milliseconds. |
Visionaire Studio Functions
Function Name | Description |
---|---|
createScreenshot() | Create a screenshot & save as .png to a specified folder or use the screenshot for the save game thumbnail. |
getBool() | Retrieve boolean value of the linked object. |
getCursorPos() | Retrieves the current (absolute) position of the mouse cursor. |
getFloat() | Retrieve the float value of the linked object. |
getFloats() | Retrieve the float values of the linked objects data table. |
getId() | Retrieve the table id or table id name of the linked object. |
getInt() | Retrieve the integer value of the linked object. |
getInts() | Retrieve the integer values of the linked objects data table. |
getLink() | Retrieves the data stored inside of a linked objects table. |
getLinks() | Retrieves grouped data stored inside of a linked objects table. |
getName() | Returns the "string" name value of the linked objects table. |
getObject() | Retrieves the data stored inside of a linked objects table. |
getParent() | Retrieves the parent object which contains the linked object. (only game objects contain no parent) |
getPath() | Retrieves path (directory in unix format) of linked object. (images, videos, sounds etc) |
getPaths() | Retrieves multiple paths (directories in unix format) of linked object data table. (images, videos, sounds etc) |
getPoint() | Retrieves the x,y coordinates associated with the linked object. |
getPoints() | Retrieves multiple x,y coordinates associated with the linked objects data table. |
getProperty() | Retrieve various operating system (os) properties; such as: platform, system language etc... |
getSoundId() | Retrieve id of linked sound. (only applicable for active sounds) |
getSoundProperty() | Retrieve various properties of linked sound, such as: current playtime, balance, volume, loop. (only applicable for active sounds) |
getSteamAchievement | Retrieve boolean value of linked steam achievement. |
getSteamStat | Retrieve integer value of linked steam stat. |
getTexts() | Retrieve all texts associated with the linked object. |
getTextStr() | Retrieve a specific text string, based on the current game language or the included language id. |
getTime() | Developer command for checking time between 2 points; can be re-purposed into a crude delay or loop function. |
getVolume() | Retrieve volume levels for: music, sound, speech, videos, & master. |
getWindowBrightness() | Retrieve global window brightness value. |
isEmpty() | Returns true or false; depending on whether or not the linked object is empty. |
registerEventHandler() | Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc... |
registerHookFunction() | Set displayed & action text positions. |
resetSteamStats() | Reset the linked steam stat back to its default value. |
setCursorPos() | Set the absolute position of the mouse cursor. |
setSoundProperty() | Set the properties of a linked sound, such as: current playtime position, balance, volume, loop (requires sound id) |
setSteamAchievement() | Set the boolean value of the linked steam achievement. |
setSteamStat() | Set the integer value of the linked steam stat. |
setValue() | Edit value of the linked object. (all data types) |
setVolume() | Adjust the volume levels for: music, sound, speech, videos, & master. |
setWindowBrightness() | Adjust the global window brightness value. |
setWindowTitle() | Set a custom title in the window application bar (only applicable for window mode) |
startAction() | Call & start the linked action. |
startAnimation() | Play the linked animation. |
startDefaultBrowser | Launch default web browser & open the linked url in a new tab. (only launches browser if not already open) |
startSound() | Play the linked sound; additional properties can also be set such as: current playtime position, balance, volume, & loop. |
stopAction() | Stop the linked action. (only applicable for active actions) |
stopAnimation() | Stop & unload the linked action. (only applicable for active animations) |
stopSound() | Stop the linked sound; requires sound id. (only applicable for active sounds) |
toggleSoundPause() | Toggle linked sound between playing & paused state; requires sound id. (only applicable for active sounds) |
unregisterEventHandler() | Unregister the linked event handler & function. |
Workflow Functions
Function Name | Description |
---|---|
alignChar() | Quickly align a character to another character. |
alignObj() | Quickly align a character to a scene object. |
changeOutfit() | Quickly change the outfit of a character. |
changeScene() | Change to another scene with a specific transition effect, over a specified amount of time. |
checkCond() | Quickly check the boolean value of a condition. |
isInRadius() | Quickly determine if mouse cursor is inside of a specified radius of an objects center or characters position. |
moveObj() | Move an object from one position to another over x amount of milliseconds. |
objName() | Return the action text name of a specified object (returns active language name). |
setAnimFrames() | Quickly set the first & last frame of an active animation. |
setAnimSize() | Quickly set the size of an active animation. |
setCondition() | Quickly set the boolean value of a condition. |
setLang() | Quickly set the spoken language & subtitle language. |
setSceneBrightness() | Quickly set the brightness/contrast level of a specific scene or the current scene. |
setVal() | Quickly set the integer or string of a value. |
toggleCondition() | Quickly toggle the boolean value of a condition. |