Difference between revisions of "Compiled Index of Lua Scripts for Visionaire Studio"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(→‎Visionaire Studio Functions)
 
(103 intermediate revisions by 3 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 Lua scripts made by various members of the Visionaire Studio team & forum community.
  
−
== Basic ==
+
''If you would like to share your own script and see it added to that list, please tell us on our [https://discord.gg/g5zFejW Discord] or in the [http://visionaire-studio.net forum].''
−
{| class="wikitable sortable" style="width:100%"
+
 
−
|-
+
<span class="red">'''IMPORTANT:''' If you intend to use any of these scripts in your own game project, make sure to check for any usage restrictions. While the scripts on this page are basically free to use, some require attribution to the creator in your game credits.</span>
−
! style="text-align:left" | Script Name
+
 
 +
 
 +
== Interfaces & Items ==
 +
{| class="ts sortable"
 +
|-
 +
! style="text-align:left;width:25%" | Script Name
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 
! style="text-align:left;width:10%" | By
 
! style="text-align:left;width:10%" | By
 
|-
 
|-
−
| [[(un)mute_Volume_(CMS)|Globally Mute/Restore Volume]]  
+
| [[Custom Item-Dragging System]] || An alternative to Visionaire's default item-dragging, offering additional options || Intermediate || Christopher A. Summer
−
| style="width:10%" | AFRLme
 
−
|}
 
−
 
 
−
== Intermediate ==
 
−
{| class="wikitable sortable" style="width:100%"
 
 
|-
 
|-
−
! style="text-align:left" | Script Name
+
| [[Cycle_Inventory_Items_(CMS)|Cycle Inventory Items]]  || Endlessly scroll through the inventory items forwards or backwards || Intermediate || AFRLme
−
! style="text-align:left;width:10%" | By
 
 
|-
 
|-
−
| [[Cycle_Inventory_Items_(CMS)|Cycle Inventory Items]]  
+
| [[Dynamic_Action_Names_for_Dragged_Items_(CMS)|Dynamic Action Names for Dragged Items]] || || Advanced || AFRLme
−
| style="width:10%" | AFRLme
 
 
|-
 
|-
−
| [[Dynamic_Action_Names_(CMS)|Dynamic Action Names]] || AFRLme
+
| [[Insert_Item_(CMS)|Insert Item]] || Insert an item into the inventory before or after a specific item (needs updating) || Intermediate || AFRLme
 
|-
 
|-
−
| [[Global_Command_Checker_(CMS)|Global Command Checker]] || AFRLme
+
| [[Organize_Inventory_Items_Alphabetically_(CMS)|Organize Inventory Items Alphabetically]] || Sort inventory items alphabetically (needs updating) || Intermediate || AFRLme
 
|-
 
|-
−
| [[How_to_Load_External_Scripts_Into_Visionaire_Studio_(CMS)|Load External Scripts]] || Divo
+
| [[Replace_Item_(CMS)|Replace Item]] || Replace an item in the inventory with another item (used for item combination) || Intermediate || AFRLme
 
|-
 
|-
−
| [[Organize_Inventory_Items_Alphabetically_(CMS)|Organize Inventory Items Alphabetically]] || AFRLme
+
| [[Sliding_Interface_MKIII_(CMS)|Sliding Interface MKIII]] || Slide interfaces in & out with duration & easing options || Basic || AFRLme
 
|-
 
|-
−
| [[Percentage_Display_(CMS)|Percentage Display (real time)]] || AFRLme
+
| [[Deponia_Based_Sliding_Interface_(CMS)|Sliding Interfaces]] || based on Deponia || Advanced || AFRLme
 
|}
 
|}
  
−
== Advanced ==
+
 
−
{| class="wikitable sortable" style="width:100%"
+
== Sound ==
 +
{| class="ts sortable"
 
|-  
 
|-  
−
! style="text-align:left" | Script Name  
+
! style="text-align:left;width:25%" | Script Name  
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 
! style="text-align:left;width:10%" | By
 
! style="text-align:left;width:10%" | By
 
|-
 
|-
−
| [[Read/Write_Config.ini_(CMS)|Config.ini (read/write)]] || AFRLme
+
| [[Chained_Volume_Control_(CMS)|Chained Volume Control]] || Automatically dips music volume when a character talks & restores it when they have finished talking || Basic || AFRLme
 
|-
 
|-
−
| [[Dynamic_Action_Names_for_Dragged_Items_(CMS)|Dynamic Action Names for Dragged Items]] || AFRLme
+
| [[Mute/Restore_Volume_(CMS)|Toggle Mute Volume]] || Toggle mute & restore volume via keybind or an interface button || Basic || AFRLme
−
|-
 
−
| [[Deponia_Based_Sliding_Interface_(CMS)|Sliding Interfaces (based on Deponia)]] || AFRLme
 
−
|-
 
−
| [[Volume_Control_Basic_Version_(CMS)|Volume Control (rail, button, percentage)]] || AFRLme
 
 
|}
 
|}
  
−
== Visionaire Studio Functions ==
+
 
−
{| class="wikitable sortable" style="width:100%"
+
== Text ==
 +
{| class="ts sortable"
 +
|-
 +
! style="text-align:left;width:25%" | Script Name
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 +
! style="text-align:left;width:10%" | By
 
|-
 
|-
−
! style="text-align:left" | Function Name
+
| [[Argo Bubbles]] || Dynamic Stylized Speech Bubbles (optional styling) || Advanced || The Argonauts
−
! 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.
+
| [[Change Text Position]] || Set character and/or narration text to a fixed position on screen || Intermediate || Various
 
|-
 
|-
−
| [[GetCursorPos_(CMS)|getCursorPos()]] || Retrieves the current (''absolute'') position of the mouse cursor.
+
| <s>[[Dynamic_Action_Names_(CMS)|Dynamic Action Names]]</s> || Update action text on mouse over (deprecated) || Intermediate || AFRLme
 
|-
 
|-
−
| [[GetLink_(CMS)|getLink()]] || Retrieves the data stored inside of a linked objects table.
+
| [[Kill_Background_Text_(CMS)|Kill Background Text]] || Allows you to skip background texts || Intermediate || AFRLme
 
|-
 
|-
−
| [[GetLinks_(CMS)|getLinks()]] || Retrieves grouped data stored inside of a linked objects table.
+
| [[Text Skipping Protection]] || Keeps the user from skipping character and narration texts accidentally || Basic || AFRLme (&&nbsp;others)
 
|-
 
|-
−
| [[GetName_(CMS)|getName()]] || Returns the "string" name value of the linked objects table.
+
| [[UpdateCharName_(CMS)|updateCharName()]] || Dynamically update the name of characters on mouse over  || Intermediate || AFRLme
 
|-
 
|-
−
| [[GetObject_(CMS)|getObject()]] || Retrieves the data stored inside of a linked objects table.
+
| [[UpdateName_(CMS)|updateName()]] || Dynamically update the name of the current object below the mouse cursor (multi-language support)  || Intermediate || AFRLme
 +
|}
 +
 
 +
 
 +
== Puzzles ==
 +
{| class="ts sortable"
 +
|-
 +
! style="text-align:left;width:25%" | Script Name
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 +
! style="text-align:left;width:10%" | By
 
|-
 
|-
−
| [[GetProperty_(CMS)|getProperty()]] || Retrieve various operating system (os) properties; such as: platform, system language etc...
+
| [[Sliding_Puzzle_(CMS)|Sliding Puzzle (3x3)]] || || Advanced || AFRLme
 +
|}
 +
 
 +
 
 +
== Miscellaneous ==
 +
{| class="ts sortable"
 +
|-
 +
! style="text-align:left;width:25%" | Script Name
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 +
! style="text-align:left;width:10%" | By
 +
|-
 +
| [[Check For Scene Scrolling]] || Provides a function to check if the scene is currently scrolling || Intermediate || Einzelkämpfer
 +
|-
 +
| [[Read/Write_Config.ini_(CMS)|Config.ini (read/write)]] || Used to store & retrieve the players option choices || Advanced || AFRLme
 
|-
 
|-
−
| [[GetSoundId_(CMS)|getSoundId()]] || Retrieve id of linked sound. (only applicable for active sounds)
+
| <s>[[Global_Command_Checker_(CMS)|Global Command Checker]]</s> || Dynamically determine which commands are accessible on mouse over objects (needs updating) || Intermediate || AFRLme
 
|-
 
|-
−
| [[GetSoundProperty_(CMS)|getSoundProperty()]] || Retrieve various properties of linked sound, such as: current playtime, balance, volume, loop. (only applicable for active sounds)
+
| [[Little Achievements]] || Implement a basic local achievement system || Advanced || Einzelkämpfer
 
|-
 
|-
−
| [[GetSteamAchievement_(CMS)|getSteamAchievement]] || Retrieve boolean value of linked steam achievement.
+
| [[Loop_Me_Not_(CMS)|Loop Me Not]] || Create a self-looping function that loops a specific amount of times || Intermediate || AFRLme
 
|-
 
|-
−
| [[GetSteamStat_(CMS)|getSteamStat]] || Retrieve integer value of linked steam stat.
+
| [[Self_Looping_Function_with_Delay_(CMS)|Self Looping Function with Delay]] || 2 versions || Advanced || AFRLme
 +
|}
 +
 
 +
 
 +
== Math Functions ==
 +
{| class="ts sortable" style="width:100%"
 +
|-
 +
! style="text-align:left;width:25%" | Script Name
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 +
! style="text-align:left;width:10%" | By
 
|-
 
|-
−
| [[GetTexts_(CMS)|getTexts()]] || Retrieve all texts associated with the linked object.
+
| [[SecondsToDays_(CMS)|secondsToDays()]] || Convert seconds to dd time format. || Basic || AFRLme
 
|-
 
|-
−
| [[GetTextStr_(CMS)|getTextStr()]] || Retrieve a specific text string, based on the current game language or the included language id.  
+
| [[SecondsToHours_(CMS)|secondsToHours()]] || Convert seconds to hh time format. || Basic || AFRLme
 
|-
 
|-
−
| [[GetTime_(CMS)|getTime()]] || Developer command for checking time between 2 points; can be re-purposed into a crude delay or loop function.
+
| [[SecondsToMinutes_(CMS)|secondsToMinutes()]] || Convert seconds to mm time format. || Basic || AFRLme
 
|-
 
|-
−
| [[GetVolume_(CMS)|getVolume()]] || Retrieve volume levels for: music, sound, speech, videos, & master.  
+
| [[SecondsToSeconds_(CMS)|secondsToSeconds()]] || Convert seconds to ss time format. || Basic || AFRLme
 
|-
 
|-
−
| [[GetWindowBrightness_(CMS)|getWindowBrightness()]] || Retrieve global window brightness value.
+
| [[SecondsToTime_(CMS)|secondsToTime()]] || Convert seconds to dd:hh:mm:ss time format. || Basic || AFRLme
 +
|}
 +
 
 +
 
 +
== Workflow Functions ==
 +
{| class="ts sortable"
 +
|-
 +
! style="text-align:left;width:25%" | Script Name
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 +
! style="text-align:left;width:10%" | By
 
|-
 
|-
−
| [[IsEmpty_(CMS)|isEmpty()]] || Returns true or false; depending on whether or not the linked object is empty.
+
| [[AlignChar_(CMS)|alignChar()]] || Quickly align a character to another character. || Basic || AFRLme
 
|-
 
|-
−
| [[RegisterEventHandler_(CMS)|registerEventHandler()]] || Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc...
+
| [[AlignObj_(CMS)|alignObj()]] || Quickly align a character to a scene object. || Basic || AFRLme
 
|-
 
|-
−
| [[RegisterHookFunction_(CMS)|registerHookFunction()]] || Set displayed & action text positions.
+
| [[ChangeOutfit_(CMS)|changeOutfit()]] || Quickly change the outfit of a character. || Basic || AFRLme
 
|-
 
|-
−
| [[ResetSteamStats_(CMS)|resetSteamStats()]] || Reset the linked steam stat back to its default value.
+
| [[ChangeScene_(CMS)|changeScene()]] || Change to another scene with a specific transition effect over a specified amount of time. || Basic || AFRLme
 
|-
 
|-
−
| [[SetCursorPos_(CMS)|setCursorPos()]] || Set the absolute position of the mouse cursor.
+
| [[CheckCond_(CMS)|checkCond()]] || Quickly check the boolean value of a condition. || Basic || AFRLme
 
|-
 
|-
−
| [[SetSoundProperty_(CMS)|setSoundProperty()]] || Set the properties of a linked sound, such as: current playtime position, balance, volume, loop (requires sound id)
+
| [[IsInRadius_(CMS)|isInRadius()]] || Quickly determine if mouse cursor is inside of a specified radius of an objects center or characters position. || Basic || AFRLme
 
|-
 
|-
−
| [[SetSteamAchievement_(CMS)|setSteamAchievement()]] || Set the boolean value of the linked steam achievement.
+
| [[LangVisibility_(CMS)|langVisibility()]] || Quickly fade in all scene objects containing the active language name, & fade out all scene objects containing other language names. || Basic || AFRLme
 
|-
 
|-
−
| [[SetSteamStat_(CMS)|setSteamStat()]] || Set the integer value of the linked steam stat.
+
| [[MoveObj_(CMS)|moveObj()]] || Move an object from one position to another over x amount of milliseconds. || Basic || AFRLme
 
|-
 
|-
−
| [[SetVolume_(CMS)|setVolume()]] || Adjust the volume levels for: music, sound, speech, videos, & master.
+
| [[ObjName_(CMS)|objName()]] || Return the action text name of a specified object (returns active language name). || Basic || Sebastian
 
|-
 
|-
−
| [[SetWindowBrightness_(CMS)|setWindowBrightness()]] || Adjust the global window brightness value.
+
| [[ObjVisibility_(CMS)|objVisibility()]] || Quickly update the opacity of multiple scene objects, duration & easing are optional. || Basic || AFRLme
 
|-
 
|-
−
| [[SetWindowTitle_(CMS)|setWindowTitle()]] || Set a custom title in the window application bar (only applicable for window mode)
+
| [[ResetAnimFrames_(CMS)|resetAnimFrames()]] || Quickly reset the specified animations current frame range back to the default animation frame range. || Basic || AFRLme
 
|-
 
|-
−
| [[StartAction_(CMS)|startAction()]] || Call & start the linked action.
+
| [[SetAnimFrames_(CMS)|setAnimFrames()]] || Quickly set the first & last frame of an active animation. || Basic || AFRLme
 
|-
 
|-
−
| [[StartAnimation_(CMS)|startAnimation()]] || Play the linked animation.
+
| [[SetAnimSize_(CMS)|setAnimSize()]] || Quickly set the size of an active animation. || Basic || AFRLme
 
|-
 
|-
−
| [[StartDefaultBrowser_(CMS)|startDefaultBrowser]] || Launch default web browser & open the linked url in a new tab. (only launches browser if not already open)
+
| [[SetCondition_(CMS)|setCondition()]] || Quickly set or toggle the boolean value of a condition. || Basic || AFRLme
 
|-
 
|-
−
| [[StartSound_(CMS)|startSound()]] || Play the linked sound; additional properties can also be set such as: current playtime position, balance, volume, & loop.
+
| [[SetConditions_(CMS)|setConditions()]] || Quickly set or toggle the boolean value of multiple conditions. || Basic || AFRLme
 
|-
 
|-
−
| [[StopAction_(CMS)|stopAction()]] || Stop the linked action. (only applicable for active actions)
+
| [[SetLang_(CMS)|setLang()]] || Quickly set the spoken language & subtitle language. || Basic || AFRLme
 
|-
 
|-
−
| [[StopAnimation_(CMS)|stopAnimation()]] || Stop & unload the linked action. (only applicable for active animations)
+
| [[SetSceneBrightness_(CMS)|setSceneBrightness()]] || Quickly set the brightness/contrast level of a specific scene or the current scene. || Basic || AFRLme
 
|-
 
|-
−
| [[StopSound_(CMS)|stopSound()]] || Stop the linked sound; requires sound id. (only applicable for active sounds)
+
| [[setVal_(CMS)|setVal()]] || Quickly set the integer or string of a value. || Basic || AFRLme
 
|-
 
|-
−
| [[ToggleSoundPause_(CMS)|toggleSoundPause()]] || Toggle linked sound between playing & paused state; requires sound id. (only applicable for active sounds)
+
| [[UpdateData_(CMS)|updateData()]] || Quickly update multiple data types via a table & the function. || Basic || AFRLme
 +
|}
 +
 
 +
 
 +
== General Developing ==
 +
{| class="ts sortable"
 +
|-
 +
! style="text-align:left;width:25%" | Script Name
 +
! style="text-align:left" class="unsortable" | Description
 +
! style="text-align:left;width:10%" | Level
 +
! style="text-align:left;width:10%" | By
 
|-
 
|-
−
| [[UnregisterEventHandler_(CMS)|unregisterEventHandler()]] || Unregister the linked event handler & function.
+
| [[How_to_Load_External_Scripts_Into_Visionaire_Studio_(CMS)|Load External Scripts]] || Allows you to load external scripts into Visionaire || Intermediate || Divo
 
|}
 
|}
 +
{{toc}}

Latest revision as of 19:18, 22 January 2024

Here you can find a list of Lua scripts made by various members of the Visionaire Studio team & forum community.

If you would like to share your own script and see it added to that list, please tell us on our Discord or in the forum.

IMPORTANT: If you intend to use any of these scripts in your own game project, make sure to check for any usage restrictions. While the scripts on this page are basically free to use, some require attribution to the creator in your game credits.


Interfaces & Items

Script Name Description Level By
Custom Item-Dragging System An alternative to Visionaire's default item-dragging, offering additional options Intermediate Christopher A. Summer
Cycle Inventory Items Endlessly scroll through the inventory items forwards or backwards Intermediate AFRLme
Dynamic Action Names for Dragged Items Advanced AFRLme
Insert Item Insert an item into the inventory before or after a specific item (needs updating) Intermediate AFRLme
Organize Inventory Items Alphabetically Sort inventory items alphabetically (needs updating) Intermediate AFRLme
Replace Item Replace an item in the inventory with another item (used for item combination) Intermediate AFRLme
Sliding Interface MKIII Slide interfaces in & out with duration & easing options Basic AFRLme
Sliding Interfaces based on Deponia Advanced AFRLme


Sound

Script Name Description Level By
Chained Volume Control Automatically dips music volume when a character talks & restores it when they have finished talking Basic AFRLme
Toggle Mute Volume Toggle mute & restore volume via keybind or an interface button Basic AFRLme


Text

Script Name Description Level By
Argo Bubbles Dynamic Stylized Speech Bubbles (optional styling) Advanced The Argonauts
Change Text Position Set character and/or narration text to a fixed position on screen Intermediate Various
Dynamic Action Names Update action text on mouse over (deprecated) Intermediate AFRLme
Kill Background Text Allows you to skip background texts Intermediate AFRLme
Text Skipping Protection Keeps the user from skipping character and narration texts accidentally Basic AFRLme (& others)
updateCharName() Dynamically update the name of characters on mouse over Intermediate AFRLme
updateName() Dynamically update the name of the current object below the mouse cursor (multi-language support) Intermediate AFRLme


Puzzles

Script Name Description Level By
Sliding Puzzle (3x3) Advanced AFRLme


Miscellaneous

Script Name Description Level By
Check For Scene Scrolling Provides a function to check if the scene is currently scrolling Intermediate Einzelkämpfer
Config.ini (read/write) Used to store & retrieve the players option choices Advanced AFRLme
Global Command Checker Dynamically determine which commands are accessible on mouse over objects (needs updating) Intermediate AFRLme
Little Achievements Implement a basic local achievement system Advanced Einzelkämpfer
Loop Me Not Create a self-looping function that loops a specific amount of times Intermediate AFRLme
Self Looping Function with Delay 2 versions Advanced AFRLme


Math Functions

Script Name Description Level By
secondsToDays() Convert seconds to dd time format. Basic AFRLme
secondsToHours() Convert seconds to hh time format. Basic AFRLme
secondsToMinutes() Convert seconds to mm time format. Basic AFRLme
secondsToSeconds() Convert seconds to ss time format. Basic AFRLme
secondsToTime() Convert seconds to dd:hh:mm:ss time format. Basic AFRLme


Workflow Functions

Script Name Description Level By
alignChar() Quickly align a character to another character. Basic AFRLme
alignObj() Quickly align a character to a scene object. Basic AFRLme
changeOutfit() Quickly change the outfit of a character. Basic AFRLme
changeScene() Change to another scene with a specific transition effect over a specified amount of time. Basic AFRLme
checkCond() Quickly check the boolean value of a condition. Basic AFRLme
isInRadius() Quickly determine if mouse cursor is inside of a specified radius of an objects center or characters position. Basic AFRLme
langVisibility() Quickly fade in all scene objects containing the active language name, & fade out all scene objects containing other language names. Basic AFRLme
moveObj() Move an object from one position to another over x amount of milliseconds. Basic AFRLme
objName() Return the action text name of a specified object (returns active language name). Basic Sebastian
objVisibility() Quickly update the opacity of multiple scene objects, duration & easing are optional. Basic AFRLme
resetAnimFrames() Quickly reset the specified animations current frame range back to the default animation frame range. Basic AFRLme
setAnimFrames() Quickly set the first & last frame of an active animation. Basic AFRLme
setAnimSize() Quickly set the size of an active animation. Basic AFRLme
setCondition() Quickly set or toggle the boolean value of a condition. Basic AFRLme
setConditions() Quickly set or toggle the boolean value of multiple conditions. Basic AFRLme
setLang() Quickly set the spoken language & subtitle language. Basic AFRLme
setSceneBrightness() Quickly set the brightness/contrast level of a specific scene or the current scene. Basic AFRLme
setVal() Quickly set the integer or string of a value. Basic AFRLme
updateData() Quickly update multiple data types via a table & the function. Basic AFRLme


General Developing

Script Name Description Level By
Load External Scripts Allows you to load external scripts into Visionaire Intermediate Divo


Retrieved from "https://wiki.visionaire-tracker.net/index.php?title=Compiled_Index_of_Lua_Scripts_for_Visionaire_Studio&oldid=12329"
  • Powered by MediaWiki