Update pages

Author: github-actions

ScriptReference/api/Managers/JCS_SceneManager.html

@@ -1 +1 @@
-<h1 id="jcs_scenemanager">JCS_SceneManager</h1><p>Better version of scene manager.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">onSwitchSceneInit<td style="text-align:left">Custom callback when initialize stage.<tr><td style="text-align:left">onSwitchSceneLoad<td style="text-align:left">Custom callback when on load scene stage.<tr><td style="text-align:left">onSwitchSceneIn<td style="text-align:left">Custom callback when completed the fade in transition.<tr><td style="text-align:left">onSwitchSceneOut<td style="text-align:left">Custom callback when completed the fade out transition.<tr><td style="text-align:left">mSwitchSceneType<td style="text-align:left">Type/Method to switch the scene.<tr><td style="text-align:left">mOverlaySceneNames<td style="text-align:left">A list of addictive scene to load.<tr><td style="text-align:left">mOverlayUseAsync<td style="text-align:left">Load additive overlay scenes asynchronously.<tr><td style="text-align:left">mAlign<td style="text-align:left">Which direction to fade slide.<tr><td style="text-align:left">mOverrideSetting<td style="text-align:left">Do this scene using the specific setting.<tr><td style="text-align:left">mSceneFadeInTime<td style="text-align:left">Fade in time. (For this scene)<tr><td style="text-align:left">mSceneFadeOutTime<td style="text-align:left">Fade out time. (For this scene)</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">RegisterOverlaySceneLoaded<td style="text-align:left">Register an event call after the targeted overlay scene is loaded.<tr><td style="text-align:left">LoadScene<td style="text-align:left">Load the target scene.<tr><td style="text-align:left">ReloadScene<td style="text-align:left">Reload the current scene.<tr><td style="text-align:left">LoadNextScene<td style="text-align:left">Load the next scene.<tr><td style="text-align:left">NextSceneName<td style="text-align:left">Return the next scene name.<tr><td style="text-align:left">GetSceneNameByOption<td style="text-align:left">Return the scene name by their options.<tr><td style="text-align:left">IsSwitchingScene<td style="text-align:left">Check is loading the scene or not.<tr><td style="text-align:left">GetAllScenes<td style="text-align:left">Return a list of all scenes.</table>
+<h1 id="jcs_scenemanager">JCS_SceneManager</h1><p>Better version of scene manager.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">onSwitchSceneInit<td style="text-align:left">Custom callback when initialize stage.<tr><td style="text-align:left">onSwitchSceneLoad<td style="text-align:left">Custom callback when on load scene stage.<tr><td style="text-align:left">onSwitchSceneIn<td style="text-align:left">Custom callback when completed the fade in transition.<tr><td style="text-align:left">onSwitchSceneOut<td style="text-align:left">Custom callback when completed the fade out transition.<tr><td style="text-align:left">mSwitchSceneType<td style="text-align:left">Type/Method to switch the scene.<tr><td style="text-align:left">mOverlaySceneNames<td style="text-align:left">A list of addictive scene to load.<tr><td style="text-align:left">mOverlayUseAsync<td style="text-align:left">Load additive overlay scenes asynchronously.<tr><td style="text-align:left">mAlign<td style="text-align:left">Which direction to fade slide.<tr><td style="text-align:left">mOverrideSetting<td style="text-align:left">Do this scene using the specific setting.<tr><td style="text-align:left">mTimeIn<td style="text-align:left">Fade in time. (For this scene)<tr><td style="text-align:left">mTimeOut<td style="text-align:left">Fade out time. (For this scene)<tr><td style="text-align:left">mClipIn<td style="text-align:left">The video clip to play for fade in.<tr><td style="text-align:left">mClipOut<td style="text-align:left">The video clip to play for fade out.</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">RegisterOverlaySceneLoaded<td style="text-align:left">Register an event call after the targeted overlay scene is loaded.<tr><td style="text-align:left">LoadScene<td style="text-align:left">Load the target scene.<tr><td style="text-align:left">ReloadScene<td style="text-align:left">Reload the current scene.<tr><td style="text-align:left">LoadNextScene<td style="text-align:left">Load the next scene.<tr><td style="text-align:left">NextSceneName<td style="text-align:left">Return the next scene name.<tr><td style="text-align:left">GetSceneNameByOption<td style="text-align:left">Return the scene name by their options.<tr><td style="text-align:left">IsSwitchingScene<td style="text-align:left">Check is loading the scene or not.<tr><td style="text-align:left">GetAllScenes<td style="text-align:left">Return a list of all scenes.</table>

ScriptReference/api/Managers/JCS_SoundManager.html

@@ -1 +1 @@
-<h1 id="jcs_soundmanager">JCS_SoundManager</h1><p>Manage of all the music, sound and SFX in the game.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">mOverrideSetting<td style="text-align:left">Do this scene using the specific setting?<tr><td style="text-align:left">mSoundFadeInTime<td style="text-align:left">Time to fade in the sound.<tr><td style="text-align:left">mSoundFadeOutTime<td style="text-align:left">Time to fade out the sound.<tr><td style="text-align:left">mDisableSoundWheWindowNotFocus<td style="text-align:left">Disable the sound when window isn't focus.</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">SwitchBGM<td style="text-align:left">Switch the background music, fading in and out.<tr><td style="text-align:left">PlayOneShotBGM<td style="text-align:left">Play one shot background music, after playing it.</table>
+<h1 id="jcs_soundmanager">JCS_SoundManager</h1><p>Manage of all the music, sound and SFX in the game.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">mOverrideSetting<td style="text-align:left">Do this scene using the specific setting?<tr><td style="text-align:left">mTimeIn<td style="text-align:left">Time to fade in the sound.<tr><td style="text-align:left">mTimeOut<td style="text-align:left">Time to fade out the sound.<tr><td style="text-align:left">mDisableSoundWheWindowNotFocus<td style="text-align:left">Disable the sound when window isn't focus.</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">SwitchBGM<td style="text-align:left">Switch the background music, fading in and out.<tr><td style="text-align:left">PlayOneShotBGM<td style="text-align:left">Play one shot background music, after playing it.</table>

ScriptReference/api/Settings/JCS_AppSettings.html

@@ -1 +1 @@
-<h1 id="jcs_appsettings">JCS_AppSettings</h1><p>Application related settings will be put here.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">onApplicationStarts<td style="text-align:left">Callback that will execute when the application starts.<tr><td style="text-align:left">SET_FRAME_RATE<td style="text-align:left">Enable to overwrite the default frame rate.<tr><td style="text-align:left">FRAME_RATE<td style="text-align:left">Targetframe rate.</table>
+<h1 id="jcs_appsettings">JCS_AppSettings</h1><p>Application related settings will be put here.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">onApplicationStarts<td style="text-align:left">Callback that will execute when the application starts.<tr><td style="text-align:left">setFrameRate<td style="text-align:left">Enable to overwrite the default frame rate.<tr><td style="text-align:left">frameRate<td style="text-align:left">Targetframe rate.</table>

ScriptReference/api/Settings/JCS_GameSettings.html

@@ -1 +1 @@
-<h1 id="jcs_gamesettings">JCS_GameSettings</h1><p>Hold the general game settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">DEBUG_MODE<td style="text-align:left">Debug mode scripting flag.<tr><td style="text-align:left">THIS_IS_GAME_SCENE<td style="text-align:left">Game scene flag.<tr><td style="text-align:left">LEVEL_DESIGN_MODE<td style="text-align:left">Level design mode flag.<tr><td style="text-align:left">GAME_TYPE<td style="text-align:left">Type of the game flag.<tr><td style="text-align:left">GRAVITY_PRODUCT<td style="text-align:left">Gravity production. (For game that have gravity in it)<tr><td style="text-align:left">CAMERA_TYPE<td style="text-align:left">Type of the camera use in the game.<tr><td style="text-align:left">ACTIVE_ONE_PLAYER<td style="text-align:left">Is the game only allows control one player flag.<tr><td style="text-align:left">PLAYER_IGNORE_EACH_OTHER<td style="text-align:left">Do collusion happen with eacth other. (Player)<tr><td style="text-align:left">TRIBE_DAMAGE_EACH_OTHER<td style="text-align:left">Can the player or enemy hurt them own tribe?<tr><td style="text-align:left">STREAMING_BASE_URL<td style="text-align:left">Base URL for streaming assets, please point to a directory.<tr><td style="text-align:left">STREAMING_CACHE_PATH<td style="text-align:left">Cache streaming assets' data path.<tr><td style="text-align:left">DATA_PATH<td style="text-align:left">Data folder path.<tr><td style="text-align:left">DATA_EXTENSION<td style="text-align:left">Data file extension.<tr><td style="text-align:left">SAVE_ON_SWITCH_SCENE<td style="text-align:left">Save when switching the scene.<tr><td style="text-align:left">SAVE_ON_EXIT_APP<td style="text-align:left">Save when app exit.<tr><td style="text-align:left">SCREENSHOT_PATH<td style="text-align:left">Screenshot image save path.<tr><td style="text-align:left">SCREENSHOT_FILENAME<td style="text-align:left">Screenshot base filename.<tr><td style="text-align:left">SCREENSHOT_EXTENSION<td style="text-align:left">Screenshot image extension.<tr><td style="text-align:left">WEBCAM_PATH<td style="text-align:left">Webcam image save path.<tr><td style="text-align:left">WEBCAM_FILENAME<td style="text-align:left">Webcam base filename.<tr><td style="text-align:left">WEBCAM_EXTENSION<td style="text-align:left">Webcam image extension.<tr><td style="text-align:left">MIN_DAMAGE<td style="text-align:left">Mininum damage can be in the game.<tr><td style="text-align:left">MAX_DAMAGE<td style="text-align:left">Maxinum damage can be in the game.</table>
+<h1 id="jcs_gamesettings">JCS_GameSettings</h1><p>Hold the general game settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">debugMode<td style="text-align:left">Debug mode scripting flag.<tr><td style="text-align:left">thisIsGameScene<td style="text-align:left">Game scene flag.<tr><td style="text-align:left">levelDesignMode<td style="text-align:left">Level design mode flag.<tr><td style="text-align:left">gameType<td style="text-align:left">Type of the game flag.<tr><td style="text-align:left">gravityProduct<td style="text-align:left">Gravity production. (For game that have gravity in it)<tr><td style="text-align:left">cameraType<td style="text-align:left">Type of the camera use in the game.<tr><td style="text-align:left">activeOnePlayer<td style="text-align:left">Is the game only allows control one player flag.<tr><td style="text-align:left">playerIgnoreEachOther<td style="text-align:left">Do collusion happen with eacth other. (Player)<tr><td style="text-align:left">tribeDamageEachOther<td style="text-align:left">Can the player or enemy hurt them own tribe?<tr><td style="text-align:left">streamingBaseUrl<td style="text-align:left">Base URL for streaming assets, please point to a directory.<tr><td style="text-align:left">streamingCachePath<td style="text-align:left">Cache streaming assets' data path.<tr><td style="text-align:left">dataPath<td style="text-align:left">Data folder path.<tr><td style="text-align:left">dataExt<td style="text-align:left">Data file extension.<tr><td style="text-align:left">saveOnSwitchScene<td style="text-align:left">Save when switching the scene.<tr><td style="text-align:left">saveOnExitApp<td style="text-align:left">Save when app exit.<tr><td style="text-align:left">screenshotPath<td style="text-align:left">Screenshot image save path.<tr><td style="text-align:left">screenshotFilename<td style="text-align:left">Screenshot base filename.<tr><td style="text-align:left">screenshotExt<td style="text-align:left">Screenshot image extension.<tr><td style="text-align:left">webcamPath<td style="text-align:left">Webcam image save path.<tr><td style="text-align:left">webcamFilename<td style="text-align:left">Webcam base filename.<tr><td style="text-align:left">webcamExt<td style="text-align:left">Webcam image extension.<tr><td style="text-align:left">minDamage<td style="text-align:left">Mininum damage can be in the game.<tr><td style="text-align:left">maxDamage<td style="text-align:left">Maxinum damage can be in the game.</table>

ScriptReference/api/Settings/JCS_NetworkSettings.html

@@ -1 +1 @@
-<p>JCS_NetworkSettings<p>Store all the network settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">CLIENT_MODE<td style="text-align:left">Current mode this client in, should be update by the server!<tr><td style="text-align:left">ON_SWITCH_SERVER<td style="text-align:left">On switching the server?<tr><td style="text-align:left">FORCE_SWITCH_SERVER<td style="text-align:left">Flag to check if is force switching the server.<tr><td style="text-align:left">ONLINE_MODE<td style="text-align:left">Is the current game with online mode active?<tr><td style="text-align:left">PROTOCAL_TYPE<td style="text-align:left">Type of the client protocal.<tr><td style="text-align:left">HOST_NAME<td style="text-align:left">Client hostname.<tr><td style="text-align:left">PORT<td style="text-align:left">Client port.<tr><td style="text-align:left">CHANNEL_COUNT<td style="text-align:left">Channel count in this game.</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">CreateNetwork<td style="text-align:left">Create socket and connect to the target hostname and target port<tr><td style="text-align:left">CloseSocket<td style="text-align:left">Close the current socket the safe way.<tr><td style="text-align:left">GetGameSocket<td style="text-align:left">Returns the game client socket.<tr><td style="text-align:left">SwitchServer<td style="text-align:left">Switch the server.</table>
+<p>JCS_NetworkSettings<p>Store all the network settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">clientMode<td style="text-align:left">Current mode this client in, should be update by the server!<tr><td style="text-align:left">switchingServer<td style="text-align:left">On switching the server?<tr><td style="text-align:left">forceSwitchServer<td style="text-align:left">Flag to check if is force switching the server.<tr><td style="text-align:left">onlineMode<td style="text-align:left">Is the current game with online mode active?<tr><td style="text-align:left">protocolType<td style="text-align:left">Type of the client protocal.<tr><td style="text-align:left">host<td style="text-align:left">Client hostname.<tr><td style="text-align:left">port<td style="text-align:left">Client port.<tr><td style="text-align:left">channelCount<td style="text-align:left">Channel count in this game.</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">CreateNetwork<td style="text-align:left">Create socket and connect to the target hostname and target port<tr><td style="text-align:left">CloseSocket<td style="text-align:left">Close the current socket the safe way.<tr><td style="text-align:left">GetGameSocket<td style="text-align:left">Returns the game client socket.<tr><td style="text-align:left">SwitchServer<td style="text-align:left">Switch the server.</table>

ScriptReference/api/Settings/JCS_PackageDataSettings.html

@@ -1 +1 @@
-<h1 id="jcs_packagedatasettings">JCS_PackageDataSettings</h1><p>Package data settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">CopyrightString<td style="text-align:left">Package Data copyright information.<tr><td style="text-align:left">VersionString<td style="text-align:left">Package Data version information.</table>
+<h1 id="jcs_packagedatasettings">JCS_PackageDataSettings</h1><p>Package data settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">copyright<td style="text-align:left">Package Data copyright information.<tr><td style="text-align:left">version<td style="text-align:left">Package Data version information.</table>

ScriptReference/api/Settings/JCS_PauseSettings.html

@@ -1 +1 @@
-<h1 id="jcs_pausesettings">JCS_PauseSettings</h1><p>Handle the pause settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">ASYMPTOTIC<td style="text-align:left">Pause and unpause with asymptotic transition.<tr><td style="text-align:left">FRICTION<td style="text-align:left">How fast the asymptotic transition?</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">AsymptoticBaseOnSetting<td style="text-align:left">Return weather to asymptotic on pause/unpause.<tr><td style="text-align:left">FrictionBaseOnSetting<td style="text-align:left">Return the friction to asymptotic on pause/unpause.</table>
+<h1 id="jcs_pausesettings">JCS_PauseSettings</h1><p>Handle the pause settings.<h2 id="variables">Variables</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">asymptotic<td style="text-align:left">Pause and unpause with asymptotic transition.<tr><td style="text-align:left">friction<td style="text-align:left">How fast the asymptotic transition?</table><h2 id="functions">Functions</h2><table><thead><tr><th id="name" style="text-align:left">Name<th id="description" style="text-align:left">Description<tbody><tr><td style="text-align:left">Asymptotic<td style="text-align:left">Return weather to asymptotic on pause/unpause.<tr><td style="text-align:left">Friction<td style="text-align:left">Return the friction to asymptotic on pause/unpause.</table>